@exodus/eslint-config
用于Exodus 项目的 Eslint 配置
发展
关于现行规则的任何增加或修改,请参考拉动请求中的指示 模板.
释放
任何与主机合并的PR都会被自动版本并使用语义发布来发布. 所以这很重要 写承诺信息时要遵守约定的规格.
使用量
配置根据您的使用大小写提供了几种不同的口味 :
Javascript
香草联合项目配置
使用 yarn add --dev @exodus/eslint-config eslint 以安装所需的依赖和下面的片段来初始化您的 .eslintrc.js
// .eslintrc.js
module.exports = {
extends: ['@exodus/eslint-config/javascript'],
// ... customization
}
带有 Babel 的 Javascript
使用 Babel 配置 JS 项目 .
使用 yarn add --dev @exodus/eslint-config eslint @babel/eslint-parser 以安装所需的依赖和下面的片段来初始化您的 .eslintrc.js
// .eslintrc.js
module.exports = {
extends: ['@exodus/eslint-config/javascript-babel'],
// ... customization
}
有反应的 Javascript
使用React和Babel配置JS项目.
使用
yarn add --dev @exodus/eslint-config eslint \
@babel/eslint-parser \
@babel/preset-react \
eslint-plugin-react \
eslint-plugin-react-hooks
以安装所需的依赖和下面的片段来初始化您的 .eslintrc.js
// .eslintrc.js
module.exports = {
extends: ['@exodus/eslint-config/javascript-react-babel'],
// ... customization
}
字体
使用
yarn add --dev @exodus/eslint-config eslint \
@typescript-eslint/parser \
@typescript-eslint/eslint-plugin \
eslint-import-resolver-typescript
和下面的片段来初始化您的 .eslintrc.js
// .eslintrc.js
module.exports = {
extends: ['@exodus/eslint-config/typescript'],
// ... customization
}
有反应的打字符
使用
yarn add --dev @exodus/eslint-config eslint \
@typescript-eslint/parser \
@typescript-eslint/eslint-plugin \
eslint-plugin-react \
eslint-import-resolver-typescript \
@exodus/eslint-plugin-react-hooks
以安装所需的依赖和下面的片段来初始化您的 .eslintrc.js
// .eslintrc.js
module.exports = {
extends: ['@exodus/eslint-config/typescript-react'],
// ... customization
}
键入和 Javascript
使用
yarn add --dev @exodus/eslint-config eslint \
@typescript-eslint/parser \
@typescript-eslint/eslint-plugin \
eslint-import-resolver-typescript
和下面的片段来初始化您的 .eslintrc.js
// .eslintrc.js
module.exports = {
overrides: [
{
files: ['*.{ts,tsx}'],
extends: ['@exodus/eslint-config/typescript'],
},
{
files: ['*.{js,jsx}'],
extends: ['@exodus/eslint-config/javascript'],
},
],
}
制止目前的侵权行为
在增加一条新规则时,您可以首先将当前违规情况白列一等,从而抓住技术债务 // eslint-disable-next-line <ruleName>为了对整个项目产生这些评论意见,请使用我们的叉子 静脉注射器数字 :
# assuming you installed the tool globally
suppress-eslint-errors ./src/ --extensions=js,jsx --rules="no-restricted-imports"
这将生成对表格的评论:
// eslint-disable-next-line no-restricted-imports -- TODO: Fix this the next time the file is edited.
对于规则的非技术-债务例外,可以去除TODO行.