规范化标准

Posted 2021-09-13 zhuanglog

1、

为什么要有规范化标准

软件开发需要多人协同

不同开发有不同习惯和喜好

不同喜好增加项目维护成本

所以需要统一标准

哪里需要

代码、文档、日志

人为编写的都需要

代码标准化规范

实施规范化的方法

编码前人为的标准约定

通过工具实现Lint

2、ESLint介绍

最为主流的js lint检测工具

很容易统一开发者的编码风格

可以帮助提升编码能力

3、EsLint安装

npm install eslint --save-dev

4、快速上手

检查步骤

编写问题代码

使用eslint执行

之前完成eslint配置

npm eslint init

npm eslint 对应地址

module.exports = {
  env: {
    browser: true,
    es2020: true
  },
  extends: [
    \'standard\'
  ],
  parserOptions: {
    ecmaVersion: 11
  },
  rules: {
  }
}

eslint配置文件

module.exports = {

 env: {
   browser: false,
   es6: false
 },
 extends: [
  \'standard\'
 ],
 parserOptions: { 
   ecmaVersion: 2015 //检测语法，但是不检测变量是否可用，配置需要env来配置
 },
 rules: {
   \'no-alert\': "error"
 },
 globals: {
   "jQuery": "readonly"
 }
}

eslint配置注释

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

结合自动化工具

与项目统一，管理更加方便

eslint结合webpack后续配置

extends: [
  ‘standard’，
  ‘plugin：react/recommended’
],

检查typescript


parser: \'@typescript-eslint/parser’,//配置语法解析器

parserOptions: {

ecmaVersion: 11

},
plugins: [

\'@typescript-eslint\'
],

eslint结合git hooks

pre-commit文件进行修改

husky可以实现git hooks的使用需求

\'husky\':{
   hook:{
   precommit:\'npm run test\'
   }
}