Prettier-TSLint 项目教程

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

prettier-tslint/
├── bin/
│   └── prettier-tslint-check
├── fixtures/
│   └── ...
├── src/
│   └── ...
├── tools/
│   └── ...
├── .editorconfig
├── .gitignore
├── .travis.yml
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── package.json
├── tsconfig.checker.json
├── tsconfig.json
├── tslint.json
└── yarn.lock

目录结构介绍

• bin/: 包含项目的可执行文件，如 prettier-tslint-check。
• fixtures/: 包含项目的测试用例和示例文件。
• src/: 包含项目的主要源代码。
• tools/: 包含项目使用的工具和脚本。
• .editorconfig: 配置编辑器的格式化规则。
• .gitignore: 指定 Git 忽略的文件和目录。
• .travis.yml: Travis CI 的配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• package.json: 项目的依赖和脚本配置。
• tsconfig.checker.json: TypeScript 配置文件，用于检查器。
• tsconfig.json: TypeScript 配置文件。
• tslint.json: TSLint 配置文件。
• yarn.lock: Yarn 的锁定文件，确保依赖版本一致。

2. 项目的启动文件介绍

项目的启动文件主要是 bin/prettier-tslint-check。这个文件是一个 CLI 工具，用于检查 TSLint 配置是否与 Prettier 冲突。

使用方法

在 package.json 中添加以下脚本：

{
  "scripts": {
    "tslint-check": "tslint-config-prettier-check ./tslint.json"
  }
}

然后运行：

yarn tslint-check
# 或者
npm run tslint-check

或者直接运行：

npx tslint-config-prettier-check ./tslint.json

3. 项目的配置文件介绍

tslint.json

tslint.json 是 TSLint 的配置文件，用于配置代码检查规则。为了确保 TSLint 和 Prettier 不冲突，可以按如下方式配置：

{
  "extends": [
    "tslint:latest",
    "tslint-config-prettier"
  ]
}

tsconfig.json

tsconfig.json 是 TypeScript 的配置文件，用于配置 TypeScript 编译器选项。

package.json

package.json 是 Node.js 项目的配置文件，包含项目的依赖、脚本和其他元数据。

其他配置文件

• .editorconfig: 配置编辑器的格式化规则。
• .gitignore: 指定 Git 忽略的文件和目录。
• .travis.yml: Travis CI 的配置文件。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• yarn.lock: Yarn 的锁定文件，确保依赖版本一致。