@ifanrx/eslint-config-standard-ts
v1.3.0
Published
An ESLint shared standard configuration for TypeScript.
Downloads
35
Readme
说明
@ifanrx/eslint-config-standard-ts
仅针对 TypeScript 项目。
如果是 JavaScript 项目,请使用 @ifanrx/eslint-config-standard
。
注意事项
.eslintrc.js
配置文件的 extends
中,@ifanrx/standard-ts
总是放在最后一个。
使用方法
路径别名和 parserOptions.project
自动配置
@typescript-lint/parser
要求配置.eslintrc.js
的parserOptions.project
- 路径别名依赖
eslint-import-resolver-typescript
,要求配置tsconfig.json
的compilerOptions.paths
两者都已封装到 @ifanrx/eslint-config-standard-ts/init
和 @ifanrx/eslint-config-standard/init
提供的 init()
函数中。
使用时应将 .eslintrc.js
的配置传入 init()
函数中。
// .eslintrc.js
const {init} = require('@ifanrx/eslint-config-standard/init')
module.exports = init({
root: true,
extends: ['@ifanrx/standard'],
})
如果需要配置路径别名,应配置 tsconfig.json
的 compilerOptions.paths
。
// tsconfig.json
{
"compilerOptions": {
"paths": {
"@/*": "./src/*"
}
}
}
单独使用
pnpm install @ifanrx/eslint-config-standard-ts -D
// .eslintrc.js
module.exports = {
root: true,
extends: ['@ifanrx/standard-ts'],
}
React 项目中使用
pnpm install @ifanrx/eslint-config-standard-ts @ifanrx/eslint-config-standard-react -D
// .eslintrc.js
module.exports = {
root: true,
extends: ['@ifanrx/standard-react', '@ifanrx/standard-ts'],
}
Vue 项目中使用
pnpm install @ifanrx/eslint-config-standard-ts @ifanrx/eslint-config-standard-vue -D
module.exports = {
root: true,
extends: ['@ifanrx/standard-vue', '@ifanrx/standard-ts'],
}
小程序项目中使用
pnpm install @ifanrx/eslint-config-standard-ts @ifanrx/eslint-config-standard-wxml -D
module.exports = {
root: true,
extends: ['@ifanrx/standard-wxml', '@ifanrx/standard-ts'],
}