项目规则

字数 277阅读 81

.gitignore 规则

忽略上传到 git 的文件

  • # 代表注释
  • 匹配模式前 / 代表项目根目录
  • 匹配模式最后加 / 代表是目录,如果文件和文件夹名字相同时候有用
  • 匹配模式前加 ! 代表取反
  • * 代表任意个字符
  • 匹配任意一个字符
  • ** 匹配多级目录

.npmignore

忽略上传到 npm 的文件

规则和 .gitignore 类似。

如果项目里面没有 .npmignore 文件,则会读取 .gitignore

.editorconfig

editorconfig 文档

代码风格的配置,为了让项目在不同的编辑器、IDE 中代码风格一样。

eslint

eslint 中文网

规范 JavaScript 书写规范,让代码风格统一。

    //全局安装 eslint
npm intall -g eslint

    //初始化一个 eslintrc
eslint --init

eslintrc 的配置例子

module.exports = {
    "env": {
        "node": true,
        "commonjs": true,
        "es6": true
    },
    "extends": "eslint:recommended",
    "rules": {
        "indent": [
            "error",
            4
        ],
        "linebreak-style": [
            "error",
            "unix"
        ],
        "quotes": [
            "error",
            "single"
        ],
        "semi": [
            "error",
            "always"
        ]
    }
};

自动化检查 eslint

package.json 中添加自定义 script 指令

"scripts": {
        "test": "echo \"Error: no test specified\" && exit 1",
        "fix": "eslint --fix .",
        "lint": "eslint ."
    },

使用 pre-commit 工具,在 git commit 之前检测 eslint ,检测不通过则 commit 失败

安装 pre-commit

npm install pre-commit --save-dev

package.json 中添加配置项

"scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "fix": "eslint --fix .",
    "lint": "eslint ."
},
"pre-commit": [
    "fix",
    "lint"
],

这样,如果 eslint 检测不能通过,就会 commit 失败

.eslintignore

忽略进行 eslint 检查的文件,规则和 .gitignore 类似。

推荐阅读更多精彩内容