tslint-to-eslint–config
将您的TSLINT配置转换为最接近合理的ESLINT等效物。
您知道TSLINT已弃用吗?哇!使用tslint-to-eslint-config加快将您的项目迁移到ESLINT上。
考虑窥视相关文档:
- eslint本身
- Typescript-Eslint,允许通过ESLINT凸起打字稿文件
用法
来自Angular?使用Angular-Eslint代替该工具和其他工具进行协调。
npx tslint-to-eslint-config
⚡(哇,这么简单!)⚡
tslint-to-eslint-config命令均在任何现有的linter,typecript和package配置文件中读取,然后根据它们创建.eslintrc.js结果。
对于具有相应的ESLINT等效物的任何TSLINT规则,这些等效物将在新配置中使用。没有Eslint等效物的TSLINT规则将用Eslint-Plugin-TSlint包裹。
需要节点14+(LTS)和TSLINT 5.18+
常见问题解答
在计划从TSLINT到ESLINT的转换之前,我们强烈建议阅读文档/FAQS.MD。
CLI标志
这些标志中的每一个都是可选的:
-
comments:打字稿配置或文件圈路径,将TSLINT规则标志转换为内部的ESLINT。 -
config:将生成的Eslint配置文件打印到的路径。 -
editor:通往编辑器配置文件的路径,以转换内部的Linter设置。 -
eslint:通往ESLINT配置文件的路径,可以从中读取设置。 -
package:通往软件包的路径。 -
prettier:将eslint-config-prettier添加到插件列表中。 -
tslint:通往tslint配置文件的路径,要读取设置。 -
typescript:打字稿配置文件的路径,可以从中读取打字稿编译器选项。
comments
npx tslint-to-eslint-config --comments
默认值:无
指示从TSLINT规则标志转换为ESLINT内联注释。诸如// tslint:disable: tslint-rule-name类的注释将转换为等效物,例如// eslint-disable eslint-rule-name 。
如果没有参数,请尊重exclude , files ,并将include在您的打字稿配置中。
如果传递了以.json结尾的单个文件路径,则将其视为用要转换的文件描述的打字稿配置文件。
npx tslint-to-eslint-config --comments tsconfig.json
如果通过了任何其他参数,则将这些参数视为用于转换的文件路径的环球路径:
npx tslint-to-eslint-config --comments \' src/**/*.ts \'
config
npx tslint-to-eslint-config --config .eslintrc.json
默认值: .eslintrc.js
将生成的Eslint配置文件打印到。
此路径的文件扩展名将用于确定创建文件的格式:
-
.js文件路径将被编写module.exports = ...JavaScript - 其他文件路径将默认为JSON
editor
npx tslint-to-eslint-config --editor ./path/to/.vscode/settings.json
默认值: .vscode/settings.json
通往编辑器配置文件的路径,以转换内部设置设置。 TSLINT的任何VS代码样式编辑器设置都将转换为其ESLINT等效物。
eslint
npx tslint-to-eslint-config --eslint ./path/to/eslintrc.js
默认值: --config的值
通往ESLINT配置文件的路径,可以从中读取设置。生成的ESLINT配置文件将包括此文件import的任何设置。
package
npx tslint-to-eslint-config --package ./path/to/package.json
默认值: package.json
通往package.json文件的路径以读取依赖关系。这将有助于告知生成的ESLINT配置文件的ENV设置。
prettier
npx tslint-to-eslint-config --prettier
默认值: false
将eslint-config-prettier添加到Eslint插件列表中。我们强烈建议您使用更漂亮的代码格式。
当未启用--prettier启用时:
- 如果输出配置尚未启用任何格式规则,则它将从
eslint-config-prettier扩展。 - 否则,CLI消息将暗示与
--prettier一起运行。
tslint
npx tslint-to-eslint-config --tslint ./path/to/tslint.json
默认值: tslint.json
通往tslint配置文件的路径,要从中读取设置。该文件被管道输送到tslint的--print-config中,以生成在生成的ESLINT配置文件中启用的规则列表。
typescript
npx tslint-to-eslint-config --typescript ./path/to/tsconfig.json
默认值: tsconfig.json
通往打字稿配置文件的路径,可以从中读取打字稿编译器选项。这将有助于告知生成的ESLINT配置文件的ENV设置。
节点API
您可以通过导出的功能通过其导出的功能以编程方式使用tslint-to-eslint-config 。有关详细信息,请参见文档/API。
import { convertLintConfig } from \"tslint-to-eslint-config\" ; const result = await convertLintConfig ( ) ;
发展
请参阅《行为守则和一般发展文档》。 ?
