Vue-tsc 项目使用教程

Vue-tsc 项目使用教程

vue-tscvue-tsc --noEmit && vite build项目地址:https://gitcode.com/gh_mirrors/vu/vue-tsc

1. 项目的目录结构及介绍

vue-tsc/
├── bin/
│   └── vue-tsc
├── dist/
│   ├── vue-tsc.d.ts
│   ├── vue-tsc.js
│   └── vue-tsc.js.map
├── src/
│   ├── cli.ts
│   ├── index.ts
│   ├── logger.ts
│   ├── options.ts
│   ├── project.ts
│   ├── services/
│   │   ├── checker.ts
│   │   ├── compiler.ts
│   │   ├── config.ts
│   │   ├── index.ts
│   │   ├── languageService.ts
│   │   ├── projectService.ts
│   │   ├── scriptBlock.ts
│   │   ├── sourceFile.ts
│   │   ├── templateService.ts
│   │   ├── vueCompiler.ts
│   │   └── vueDocument.ts
│   ├── utils/
│   │   ├── index.ts
│   │   ├── logger.ts
│   │   └── path.ts
│   └── vue.ts
├── package.json
├── README.md
└── tsconfig.json

目录结构介绍

• bin/: 包含可执行文件 vue-tsc。
• dist/: 编译后的文件，包括类型定义文件、JavaScript 文件和源映射文件。
• src/: 源代码目录，包含主要的 TypeScript 文件和子目录。
  • cli.ts: 命令行接口文件。
  • index.ts: 主入口文件。
  • logger.ts: 日志记录工具。
  • options.ts: 命令行选项处理。
  • project.ts: 项目相关处理。
  • services/: 包含各种服务模块，如类型检查、编译、配置等。
  • utils/: 工具函数集合。
  • vue.ts: Vue 相关处理。
• package.json: 项目配置文件，包含依赖、脚本等信息。
• README.md: 项目说明文档。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 bin/vue-tsc，这是一个可执行文件，用于启动 vue-tsc 命令行工具。它主要调用 src/cli.ts 文件中的逻辑来处理命令行参数并执行相应的操作。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的元数据和依赖信息，以及一些脚本命令。以下是一些关键部分：

{
  "name": "vue-tsc",
  "version": "0.4.1",
  "description": "Type-check and dts build command line tool for vue",
  "bin": {
    "vue-tsc": "bin/vue-tsc"
  },
  "scripts": {
    "build": "tsc -p tsconfig.json",
    "watch": "tsc -w -p tsconfig.json"
  },
  "dependencies": {
    "typescript": "^4.1.3",
    "vue-language-service": "^0.4.1"
  },
  "devDependencies": {
    "@types/node": "^14.14.22",
    "typescript": "^4.1.3"
  }
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，定义了编译选项和项目结构。以下是一些关键部分：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": [
    "src/**/*"
  ]
}

这些配置项定义了编译目标、模块系统、输出目录、源代码目录以及其他编译选项。

vue-tscvue-tsc --noEmit && vite build项目地址:https://gitcode.com/gh_mirrors/vu/vue-tsc