TSLint Language Service 项目教程

TSLint Language Service 项目教程

tslint-language-serviceTypeScript 2.2.1 plugin for tslint项目地址:https://gitcode.com/gh_mirrors/ts/tslint-language-service

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

tslint-language-service/
├── out/
│   └── src/
│       └── index.js
├── src/
│   └── index.ts
├── dev/
│   └── node_modules/
│       └── tslint-language-service/
├── test/
│   └── **/*spec.js
├── .gitignore
├── .npmignore
├── .travis.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package.json
├── tsconfig.json
├── tslint.json
└── yarn.lock

• out/: 编译后的输出目录，包含 src/index.js。
• src/: 源代码目录，包含项目的入口文件 index.ts。
• dev/: 开发环境目录，包含 node_modules/ 用于开发测试。
• test/: 测试文件目录，包含所有测试文件。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript 编译配置。
• tslint.json: TSLint 配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

项目的启动文件位于 out/src/index.js，这是编译后的入口文件。源代码对应的文件是 src/index.ts，它包含了项目的核心逻辑和初始化代码。

3. 项目的配置文件介绍

package.json

{
  "name": "tslint-language-service",
  "version": "1.0.0",
  "description": "tslint - language services",
  "main": "out/src/index.js",
  "author": "Angelo ZERR",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "https://github.com/angelozerr/tslint-language-service.git"
  },
  "scripts": {
    "prepublish": "node node_modules/typescript/lib/tsc",
    "compile": "node node_modules/typescript/lib/tsc",
    "devtest": "tsc && copyfiles out/src/index.js dev/node_modules/tslint-language-service",
    "publish": "node /scripts/git-tag.js",
    "test": "tsc && tape out/test/**/*spec.js",
    "lint": "tslint src/index.ts"
  },
  "dependencies": {
    "mock-require": "^2.0.2"
  },
  "devDependencies": {
    "@types/node": "^7.0.8",
    "@types/tape": "^4.2.29",
    "@types/mock-require": "^2.0"
  }
}

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目入口文件。
• author: 项目作者。
• license: 项目许可证。
• repository: 项目仓库地址。
• scripts: 项目脚本命令。
• dependencies: 项目依赖。
• devDependencies: 开发环境依赖。

tsconfig.json

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "es5",
    "outDir": "out",
    "sourceMap": true
  },
  "include": [
    "src/**/*"
  ]
}

• compilerOptions: TypeScript 编译选项。
• module: 模块系统。
• target: 编译目标。
• outDir: 输出目录。
• sourceMap: 是否生成 source map 文件。
• include: 包含的文件或目录。

tslint.json

tslint-language-serviceTypeScript 2.2.1 plugin for tslint项目地址:https://gitcode.com/gh_mirrors/ts/tslint-language-service