规范化-ESLint

规范化是践行前端工程化中重要的一部分
为什么要有规范化标准:
软件开发需要多人协同,不同开发人员有着不同的编码习惯,不同的习惯增加项目维护成本,每个项目或团队需要明确统一的标准。
哪里需要规范化标准:
代码,文档,甚至提交的日志,开发过程中人为编写的成果物,代码最为重要。
如何实施规范化标准:
通过工具实现Lint,(刚有C语言的时候,有一些常见的代码问题是不能被编译器捕获到的,有人就开发了一个叫Lint的工具,用于在编译之前检查问题,后续这种工具,就都被称为Lint)


ESLint

目前最为主流的JavaScript Lint工具,检测代码质量,容易统一开发者的编码风格(缩进,分号等)
初次使用

npm install eslint --save-dev
npx eslint --init

npx是npm自带的一个工具,能执行npm包,简化了之前执行包的cli命令时的步骤,之前还要进入node_modules/.bin中

init过程就选择自己想要的就行了,之后会得到.eslintrc.js的初始文件

// .eslintrc.js
module.exports = {
    "env": {
        "browser": true, // 运行环境是浏览器,所以包含window,document等全局变量,还有node等其他选项
        "es2015": true // ES2015中的全局变量例如promise,将可用
    },
    "extends": [
        "standard" // 初始化时的选项,表示继承standard风格
    ],
    "parserOptions": { // 设置语法解析器的相关配置
        "ecmaVersion": 6, // 支持到es6,例如es7的语法async将不支持
        "sourceType": "module"
    },
    "rules": { // 添加规则,更多规则可去官网查看
        "no-alert": "error" // 使用alert会抛出警告,有off,warning,error三种可选
    }
    "globals": { // 添加全局成员
        "qqqq": "readonly" // 以后可在全局直接使用qqqq变量
    }
};
npx eslint ./index.js  //校验文件
npx eslint ./index.js --fix  //修复文件

配置注释
如果不可避免的某一处代码就是要违反一下规则,我们不能因为这一个点,就去推翻校验规则的配置

const str1 = "${name} is a coder" // eslint-disable-line no-template-curly-in-string 
console.log(str1)

// eslint-disable-line [no-template-curly-in-string]就可忽略此行代码中的此规则
结合webpack
首先你拥有一个webpack的项目

  • 安装eslint模块
  • 安装eslint-loader模块
  • 初始化.eslintrc.js配置文件
eslint检查肯定要在babel-loader编译之前进行,所以
// webpack.config.js
module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: 'babel-loader'
      },
      {
        test: /\.js$/,
        enforce: 'pre',  // 设置执行顺序,pre优先处理,post 最后处理
        exclude: /node_modules/,
        use: 'eslint-loader'
      },
     {
        test: /\.css$/,
        exclude: /node_modules/,
        use: 'css-loader'
      }
    ]
  },

如果你的是react项目,因为它有一些jsx语法,所以需要安装一个eslint-plugin-react插件,并配置.eslintrc.js

// .eslintrc.js
module.exports = {
  extends: [
    'standard',
    'plugin:react/recommended'
  ],
}

GitHooks配合ESLint

GitHook也称之为git钩子,每个钩子都对应一个任务,比如commit,push
通过shell脚本可以编写钩子任务触发时,要具体执行的操作。


image.png

我有一个test项目,从中可以看到.git=>hooks,hooks里面全都是各种时机的勾子。我们复制一份pre-commit.sample,删掉.sample

// pre-commit
#!/bin/sh
echo "YES YES"

然后执行git commit -m ""后你会发现输出了YES YES,这就简单的实现了git gook。接下来结合eslint,在提交前自动做检查。

我们前端人员大部分并不擅长写shell脚本,所以我们使用Husky来实现githooks的使用需求。

npm install husky -D
// package.json 中添加
{
  "scripts": {
    "lint": "eslint ."
  },
    "husky": {
        "hooks": {
           "pre-commit": "npm run lint"
        }
     }
}

再试一下commit,发现可以了。
后续还可以配合lint-staged,完成eslint后再自动格式化等操作。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,402评论 6 499
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,377评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,483评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,165评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,176评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,146评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,032评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,896评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,311评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,536评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,696评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,413评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,008评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,815评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,698评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,592评论 2 353

推荐阅读更多精彩内容