[内部] Cypress 开发者 ESLint 插件
Cypress包共用的ESLint规则.
此软件包用于 内部发展 (原始内容存档于2012-10-12). of Cypress. 这是 官方 Cypress ESLint 插件 意为Cypress的用户.
安装
npm install --save-dev @cypress/eslint-plugin-dev
使用量
⚠️ 目前 没有 支持ESLint版本9
Eslint 8, 使用6. x.x版本
对于 Eslint 7 及以下,使用 5.x.x 版本
- 安装以下
devDependencies数字 :
@cypress/eslint-plugin-dev
eslint-plugin-json-format
@typescript-eslint/parser
@typescript-eslint/eslint-plugin
eslint-plugin-mocha
eslint-plugin-import
# if you have react/jsx files
eslint-plugin-react
@babel/eslint-parser
- 将以下添加到根位
.eslintrc.json数字 :
{
"plugins": [
"@cypress/dev"
],
"extends": [
"plugin:@cypress/dev/general"
]
}
注:另加
"plugin:@cypress/dev/react",如果您正在使用React
注:如果您有
test/目录,您应当创建.eslintrc.json,并添加:
{
"extends": [
"plugin:@cypress/dev/tests"
]
}
- 在您的
.eslintignore数字 :
# don't ignore hidden files, useful for formatting json config files
!.*
package.json数字 :
"husky": {
"hooks": {
"pre-commit": "lint-pre-commit"
}
},
说明:
lint-pre-commit钩子会自动插入您的已显示的文件, 而且只有--fix财务报告和审定财务报表git add如果该文件中没有未预设的更改(这可以保护部分已预设的文件不被添加到钩子中).
要自动修复所有已阶段的文件, 运行./node_modules/.bin/lint-changed --fix
预设
常规
通常应在包的根部使用.
- 以多相为通.
- 自动修正
json文档和排序package.json通过eslint-plugin-json-format
需要您安装以下 devDependencies数字 :
eslint-plugin-import
eslint-plugin-json-format
@typescript-eslint/parser
@typescript-eslint/eslint-plugin
测试
测试的具体配置和规则。 应在 test/ 目录.
需要您安装以下 devDependencies数字 :
eslint-plugin-mocha
反应
反应和JSX的特定配置和规则.
需要您安装以下 devDependencies数字 :
@babel/eslint-parser
eslint-plugin-react
配置示例
更改一些折叠规则 :
// .eslintrc.json
{
"extends": [
"plugin:@cypress/dev/general"
],
"rules": {
"comma-dangle": "off",
"no-debugger": "warn"
}
}
停下来 package.json 从格式化 :
{
"settings": {
"json/sort-package-json": false
}
}
自定义规则 :
| 名称 | 说明 | 选项 | 实例 |
|---|---|---|---|
@cypress/dev/arrow-body-multiline-braces | 仅在多行函数定义中执行箭头函数中的括号 | [`永远 | 永远不要] 总是把这个设定为"永远" |
@cypress/dev/skip-comment | 执行评论( E)// NOTE:解释a .skip 添加到 it, (中文(简体) ), describe,或 context 测试块 | {注释键 : [array] tokens that indicate .skip explanation (default: ['NOTE:', 'TODO:', 'FIXME:']说吧 | '@cypress/dev/skip-comment': ['error', { commentTokens: ['TODO:'] }] |
@cypress/dev/no-return-before | 否定 return 在某些可配置符号前的语句 | {令牌: [array] tokens that cannot be preceded by 'return' (default: ['it', 'describe', 'context', 'expect']说吧 | '@cypress/dev/no-return-before': ['error', { tokens: ['myfn'] }] |
编辑器
虚拟系统
使用插件 Dirk Baeumer的ESLint 互联网档案馆的存檔,存档日期2013-12-02 使用 ESLint 修改 JS 文件.
安装后, 在您的用户或工作空间中添加以下内容( E).vscode/settings.json设置 :
{
"eslint.validate": [
{
"language": "javascript",
"autoFix": true
},
{
"language": "javascriptreact",
"autoFix": true
},
{
"language": "typescript",
"autoFix": true
},
{
"language": "typescriptreact",
"autoFix": true
},
{
"language": "json",
"autoFix": true
}
],
}
原子
安装软件包 内嵌 (及其从属关系)使出能起伏. 进入此软件包的设置 并启用“ Fix on save” 选项,可自动修正白色空间问题和其他问题.
下图文字
安装 ESLint 格式文件, (中文(简体) ), 然后设置下列设置:
{
"format_on_save": true,
"debug": true
}
许可证
本项目的许可条件如下: 麻省理工学院许可证。 。 。 .