RxJS TSLint 项目教程

RxJS TSLint 项目教程

rxjs-tslintTSLint rules targeting RxJS项目地址:https://gitcode.com/gh_mirrors/rx/rxjs-tslint

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

RxJS TSLint 项目的目录结构如下：

rxjs-tslint/
├── bin/
│   ├── rxjs-5-to-6-migrate.js
│   └── rxjs-tslint.js
├── src/
│   ├── rules/
│   │   ├── index.ts
│   │   └── ...
│   ├── rxjs-5-to-6-migrate.ts
│   └── rxjs-tslint.ts
├── package.json
├── README.md
└── tslint.json

目录介绍

• bin/：包含可执行脚本文件，用于迁移 RxJS v5 代码到 v6。
• src/：包含项目的源代码。
  • rules/：包含 TSLint 规则的定义。
  • rxjs-5-to-6-migrate.ts：迁移脚本的源代码。
  • rxjs-tslint.ts：TSLint 配置的源代码。
• package.json：项目的依赖和脚本配置文件。
• README.md：项目的介绍文档。
• tslint.json：TSLint 的配置文件。

2. 项目的启动文件介绍

项目的启动文件主要位于 bin/ 目录下：

• rxjs-5-to-6-migrate.js：用于迁移 RxJS v5 代码到 v6 的脚本。
• rxjs-tslint.js：用于配置和运行 TSLint 的脚本。

启动文件介绍

• rxjs-5-to-6-migrate.js：

  • 该脚本会自动处理 RxJS v5 代码，将其迁移到 v6 版本。
  • 使用方法：在项目根目录下运行 node ./bin/rxjs-5-to-6-migrate.js。

• rxjs-tslint.js：

  • 该脚本用于配置和运行 TSLint，检查代码风格和潜在问题。
  • 使用方法：在项目根目录下运行 node ./bin/rxjs-tslint.js。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 tslint.json。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "rxjs-tslint",
  "version": "1.0.0",
  "description": "TSLint rules for RxJS",
  "main": "index.js",
  "bin": {
    "rxjs-5-to-6-migrate": "./bin/rxjs-5-to-6-migrate.js",
    "rxjs-tslint": "./bin/rxjs-tslint.js"
  },
  "scripts": {
    "migrate": "node ./bin/rxjs-5-to-6-migrate.js",
    "lint": "node ./bin/rxjs-tslint.js"
  },
  "dependencies": {
    "rxjs": "^6.0.0",
    "tslint": "^5.11.0",
    "typescript": "^3.0.0"
  },
  "devDependencies": {
    "@types/node": "^10.0.0"
  }
}

tslint.json

tslint.json 文件包含了 TSLint 的配置规则。

{
  "extends": [
    "rxjs-tslint",
    "rxjs-tslint-rules"
  ],
  "rules": {
    "rxjs-collapse-imports": true,
    "rxjs-pipeable-operators-only": true,
    "rxjs-no-static-observable-methods": true,
    "rxjs-proper-imports": true
  }
}

配置文件介绍

• package.json：
  • name：项目名称。
  • version：项目版本。
  • description：项目描述。
  • main：项目的主入口文件。
  • bin：可执行脚

rxjs-tslintTSLint rules targeting RxJS项目地址:https://gitcode.com/gh_mirrors/rx/rxjs-tslint