Eslint-config-zcs NPM

javaScript 和 React 规范

如何使用

安装

npm install eslint-config-zcs

创建 eslint 配置文件

全局安装npm install -g eslint-config-zcs
在需要创建的目录下，执行eslint-zcs
根据提示信息进行选择，最终在脚本执行路径下生成.eslintrc.js文件

更新规则

执行npm run checkRule,会把当前规则和 eslint 官网以及使用插件官网上的规则进行比较，按照提示更新 rule 文件夹

添加或修改规范后，必须严格按照下面样式更新 jsDoc 的注释，并重新生成文档

更新规范文档

执行npm run createDoc 根据 rule 文件夹下的 jsDoc 注释生成文档

关于规范中的注释

注释风格是 jsdoc 形式,请严格按照如下格式修改

/**
 * @meaning
 * 强制要求<hX>的内容不为空
 * @why
 * 标题对正常和残障人士一样重要：精心编写和正确排序的<hX>标签可以
 * 帮助用户更好了解文章内容，节省用户时间。
 * 对于阅读器用户来说，看不到样式，只能通过<hX>标签来确定标题，因此<hX>标签很重要
 * @wrong
 * <h1 />
 * <h1><TextWrapper aria-hidden />
 * @right
 * <h1>Heading Content!</h1>
 * <h1><TextWrapper /><h1>
 * <h1 dangerouslySetInnerHTML={{ __html: 'foo' }} />
 */

meaning

规则含义

why

解释为什么定这个规则

wrong

错误例子

right

正确例子

关于文件后缀

import中的settings的import/resolver的extension表示如果文件a省略后缀，将按照a.js a.jsx a.json
的顺序尝试解析
'import/resolver': {
  node: {
    extensions: ['.js', '.jsx', '.json'],
  },
}


import中的规则的extension表示，这些后缀是默认的，不允许出现