eslint-config-leankit

这个包提供 LeanKit 的 .eslintrc 作为可扩展的共享配置。

用法

我们支持四种 ESLint 配置供您使用。

eslint-config-leankit

我们的默认导出包含 ESLint 遗留规则的基础（ECMAScript 5）。它目前只需要eslint.

1. npm install eslint eslint-config-leankit --save-dev
2. 添加"extends": "leankit"到您的.eslintrc

eslint-config-leankit/es​​6

这会导出 ECMAScript 6+ 的功能和规则。这也只需要eslint. 您可能希望将其与基本leankit规则一起扩展。

1. npm install eslint eslint-config-leankit --save-dev
2. 添加"extends": [ "leankit/es6" ]到您的.eslintrc或您可以选择合并基本规则和 es6 规则"extends": [ "leankit", "leankit/es6" ]

eslint-config-leankit/react

这些规则特定于 React 开发。它需要eslint和eslint-plugin-react。

1. npm install eslint eslint-plugin-react eslint-config-leankit --save-dev
2. 添加"extends": "leankit/react"到您的.eslintrc或您可以选择合并基础和反应规则"extends": [ "leankit", "leankit/react" ]

eslint-config-leankit/a11y

如果您正在使用 React 并且想要一些可访问性规则，那么a11y适合您。它需要eslint和eslint-plugin-jsx-a11y。

1. npm install eslint eslint-plugin-jsx-a11y eslint-config-leankit --save-dev
2. 添加"extends": "leankit/a11y"到您的.eslintrc或您可以选择合并基础和反应规则"extends": [ "leankit", "leankit/a11y" ]

eslint-config-leankit/测试

这是使用mocha.

1. npm install eslint eslint-config-leankit --save-dev
2. 添加"extends": "leankit/test"到您的.eslintrc

示例设置

使用所有规则的简单项目

.
└── .eslintrc // extends: [ "leankit", "leankit/es6" ]

具有某些规则的复杂项目

.
├── client
│   ├── js
│   │   └── .eslintrc // extends: "react"
│   └── spec
│   │   └── .eslintrc // extends: "test"
│   └── .eslintrc     // extends: "es6"
├── server
│   └── spec
│       └── .eslintrc // extends: "test"
└── .eslintrc         // extends: "leankit"

测试

您可以使用npm test.

您可以使用npm run lint.

开发技巧

在本地使用npm link ../eslint-config-leankit或npm install ../eslint-config-leankit测试更改不适用于此存储库。相反，使用npm packwhich 将创建一个tgz文件（例如：）eslint-config-leankit-4.5.0.tgz。从那里您可以将打包文件安装到另一个项目中（例如：）npm i ../eslint-config-leankit/eslint-config-leankit-4.5.0.tgz --no-save。一旦安装，你可以运行掉毛，但建议先删除ESLint的缓存（例如：rm .eslintcache && npm run lint）

eslint-config-leankit > npm pack
eslint-config-leankit > cd ../other-project
other-project > npm i ../eslint-config-leankit/eslint-config-leankit-4.5.0.tgz --no-save
other-project > rm .eslintcache && npm run lint 

参考

另请参阅LeanKit 的样式指南和ESLint 配置文档
以获取更多信息。