2021-06-30

安装商城中的组件

KoroFileHeader

文件头部注释，函数头部注释

Vetur

vetur可以彩色显示vue文件代码
进行静态错误语法提示
格式化代码

ESLint

可以根据eslint的配置，在代码中标注错误语法（程序未运行也可以生效）
可配合vsCode中的 settings.json进行配置，实现按照eslint规则格式化

配置现关文件

配置.eslintrc.js

module.exports = {
  root: true, // 根文件
  env: {
    node: true,
    browser: true, // browser: false 关闭对浏览器全局变量的支持，会导致使用window变量无法检验通过。这个属性如果未显示指明true也是可以编译通过的
    es6: true,
  },
  extends: ['plugin:vue/essential', 'eslint:recommended'], // "plugin:vue/essential":实现vue文件检测, "eslint:recommended": 启用eslint默认配置规则
  parserOptions: {
    parser: 'babel-eslint', // 使用babel-eslint进行解析
    sourceType: 'module', // 模块化代码
  },
  rules: {
    'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
    'vue/max-attributes-per-line': [
      2,
      {
        singleline: 10, // 配置单行能够防止的属性个数, 和多行的配置是二选一的
        multiline: {
          max: 2, // 配置单行能够防止的属性个数，和单行的配置是二选一的
          allowFirstLine: false, // false: 不允许标签名上带有属性
        },
      },
    ],
    'vue/singleline-html-element-content-newline': 'off', // 带属性的标签中的内容需另起一行
    'vue/multiline-html-element-content-newline': 'off', // 元素中有多行内容，需每行内容各占一行
    'vue/component-definition-name-casing': ['error', 'PascalCase'], // 规定组件中的name属性命名格式必须使用大驼峰命名法
    'vue/no-v-html': 'off', // 关闭禁止使用v-html的规定
    'accessor-pairs': 2, // 强制 getter 和 setter 在对象中成对出现，与计算属性的get和set无关
    'arrow-spacing': [
      2,
      {
        before: true,
        after: true,
      },
    ], // 要求箭头函数的箭头之前或之后有空格
    'block-spacing': [2, 'always'], // 禁止或强制在代码块中开括号前和闭括号后有空格
    'brace-style': [
      2,
      '1tbs',
      {
        allowSingleLine: true, // 允许块的开括号和闭括号在 同一行
      },
    ], // 大括号的风格统一使用one true brace style
    camelcase: [
      0,
      {
        properties: 'always',
      },
    ], // 禁用：要求使用骆驼拼写法
    'comma-dangle': [2, 'never'], // 拖尾逗号
    'comma-spacing': [
      2,
      {
        before: false,
        after: true,
      },
    ], // 强制在逗号周围使用空格
    'comma-style': [2, 'last'], // 逗号风格
    'constructor-super': 2, // 要求在构造函数中有 super() 的调用
    curly: [2, 'multi-line'], // 强制所有控制语句使用一致的括号风格，如：if可以省略大括号
    'dot-location': [2, 'property'], // 强制在 点号 之前和之后一致的换行
    'eol-last': 2, // 文件末尾需存在至少一行空行
    eqeqeq: ['error', 'always', { null: 'ignore' }], // 强制使用绝对等于（不等于）,不对null要求
    'generator-star-spacing': [
      2,
      {
        before: true,
        after: true,
      },
    ], // 强制 generator 函数中 * 号周围使用一致的空格
    'handle-callback-err': [2, '^(err|error)$'], // 要求回调函数中有容错处理
    indent: [
      2,
      2,
      {
        SwitchCase: 1, // 强制 switch 语句中的 case 子句的缩进2个空格
      },
    ], // 强制使用一致的缩进
    'jsx-quotes': [2, 'prefer-single'], // 强制所有不包含单引号的 JSX 属性值使用单引号
    'key-spacing': [
      2,
      {
        beforeColon: false,
        afterColon: true,
      },
    ], // 强制在对象字面量的属性中冒号后使用空格
    'keyword-spacing': [
      2,
      {
        before: true,
        after: true,
      },
    ], // 强制在关键字周围都使用空格
    'new-cap': [
      2,
      {
        newIsCap: true, // 构造函数方法名必须大写
        capIsNew: false, // 构造函数不需要一定使用new
      },
    ], // 构造函数大写限制
    'new-parens': 2, // 要求调用无参构造函数时带括号
    'no-array-constructor': 2, // 禁止使用 Array 构造函数
    'no-caller': 2, // 禁用 arguments.caller 或 arguments.callee
    'no-console': 'off', // 可以使用console
    'no-class-assign': 2, // 不允许修改类声明的变量
    'no-cond-assign': 2, // 禁止在条件语句中出现赋值操作符
    'no-const-assign': 2, // 禁止修改 const 声明的变量
    'no-control-regex': 0, // 禁止在正则表达式中使用控制字符
    'no-delete-var': 2, // 禁止对变量使用 delete 操作符。
    'no-dupe-args': 2, // 禁止在 function 定义中出现重复的参数
    'no-dupe-class-members': 2, // 禁止类成员中出现重复的名称
    'no-dupe-keys': 2, // 禁止对象字面量中出现重复的 key
    'no-duplicate-case': 2, // 禁止出现重复的 case 标签
    'no-empty-character-class': 2, // 禁止在正则表达式中出现空字符集
    'no-empty-pattern': 2, // 禁止使用空解构模式
    'no-eval': 2, // 禁用 eval()
    'no-ex-assign': 2, // 禁止对 catch 子句中的异常重新赋值
    'no-extend-native': 2, // 禁止扩展原生对象
    'no-extra-bind': 2, // 禁止不必要的bind()调用
    'no-extra-boolean-cast': 2, // 禁止不必要的布尔类型转换
    'no-extra-parens': [2, 'functions'], // 禁止冗余的括号
    'no-fallthrough': 2, // 禁止 case 语句落空
    'no-floating-decimal': 2, // 禁止数字字面量中使用前导和末尾小数点
    'no-func-assign': 2, // 禁止对 function 声明重新赋值
    'no-implied-eval': 2, // 禁止使用类似 eval() 的方法
    'no-inner-declarations': [2, 'functions'], // 禁止在嵌套的语句块中出现 function 声明
    'no-invalid-regexp': 2, // 禁止在 RegExp 构造函数中出现无效的正则表达式
    'no-irregular-whitespace': 2, // 禁止不规则的空白
    'no-iterator': 2, // 禁用 __iterator__ 属性
    'no-label-var': 2, // 禁止同一作用域下，标签与属性同名
    'no-labels': [
      2,
      {
        allowLoop: false,
        allowSwitch: false,
      },
    ], // 禁用标签语句
    'no-lone-blocks': 2, // 禁用不必要的嵌套块
    'no-mixed-spaces-and-tabs': 2, // 禁止空格和 tab 的混合缩进
    'no-multi-spaces': 2, // 禁止使用多个空格
    'no-multi-str': 2, // 禁止使用多行字符串
    'no-multiple-empty-lines': [
      2,
      {
        max: 1, // 最多空一行
      },
    ], // 禁止出现多行空行
    'no-global-assign': 2, // 禁止对原生对象或只读的全局对象进行赋值
    'no-unsafe-negation': 2, // 禁止对关系运算符的左操作数使用否定操作符
    'no-new-object': 2, // 禁用 Object 的构造函数
    'no-new-require': 2, // 禁止调用 require 时使用 new 操作符
    'no-new-symbol': 2, // 禁止 Symbol 对象前使用 new
    'no-new-wrappers': 2, // 禁止对 String，Number 和 Boolean 使用 new 操作符
    'no-obj-calls': 2, // 禁止把全局对象作为函数调用
    'no-octal': 2, // 禁用八进制字面量
    'no-octal-escape': 2, // 禁止在字符串字面量中使用八进制转义序列
    'no-path-concat': 2, // 禁止对 __dirname 和 __filename 进行字符串连接
    'no-proto': 2, // 禁用__proto__，可使用 Object.getPrototypeOf 和 Object.setPrototypeOf 代替。
    'no-redeclare': 2, // 禁止多次声明同一变量
    'no-regex-spaces': 2, // 禁止正则表达式字面量中出现多个空格
    'no-return-assign': [2, 'except-parens'], // 禁止在 return 语句中使用赋值语句
    'no-self-assign': 2, // 禁止自我赋值
    'no-self-compare': 2, // 禁止自身比较
    'no-sequences': 2, // 禁用逗号操作符
    'no-shadow-restricted-names': 2, // 禁止将标识符定义为受限的名字
    'func-call-spacing': 2, // 禁止在函数标识符和其调用之间有空格
    'no-sparse-arrays': 2, // 禁用稀疏数组（error:[,,] | true: [1,2,]）
    'no-this-before-super': 2, // 禁止在构造函数中，在调用 super() 之前使用 this 或 super
    'no-throw-literal': 2, // 禁止抛出的异常不是Error 对象
    'no-trailing-spaces': 2, // 禁止使用行尾空白（空格、tab 和其它 Unicode 空白字符）。
    'no-undef': 2, // 禁用未声明的变量，除非它们在 /*global */ 注释中被提到
    'no-undef-init': 2, // 禁止将变量初始化为 undefined
    'no-unexpected-multiline': 2, // 禁止出现令人困惑的多行表达式
    'no-unmodified-loop-condition': 2, // 禁用一成不变的循环条件，防止死循环
    'no-unneeded-ternary': [
      2,
      {
        defaultAssignment: false, // 禁止条件表达式作为默认的赋值模式
      },
    ], // 禁止可以在有更简单的可替代的表达式时使用三元操作符
    'no-unreachable': 2, // 禁止在 return、throw、continue 和 break 语句之后出现,如果执行的代码
    'no-unsafe-finally': 2, // 禁止在 finally 语句块中出现控制流语句
    'no-unused-vars': [
      2,
      {
        vars: 'all', // 检测所有变量，包括全局环境中的变量。
        args: 'none', // 不检查参数。
      },
    ], // 禁止出现未使用过的变量
    'no-useless-call': 2, // 禁止不必要的 .call() 和 .apply()
    'no-useless-computed-key': 2, // 禁止在对象中使用不必要的计算属性
    'no-useless-constructor': 2, // 禁用不必要的构造函数
    'no-useless-escape': 0, // 禁用不必要的转义字符
    'no-whitespace-before-property': 2, // 禁止属性前有空白
    'no-with': 2, // 禁用 with 语句
    'one-var': [
      2,
      {
        initialized: 'never', // 要求每个作用域的初始化的变量有多个变量声明，除非变量没有初始化
      },
    ], // 强制函数中的变量要么一起声明要么分开声明
    'operator-linebreak': [
      2,
      'after',
      {
        // 要求把换行符放在操作符后面
        overrides: {
          '?': 'before', // 问号置于操作数之前
          ':': 'before', // 冒号置于操作数之前
        },
      },
    ],
    'padded-blocks': [2, 'never'], // 禁止块内填充（块内不能出现首尾空行）
    quotes: [
      2,
      'single',
      {
        // js代码中，必须使用单引号
        avoidEscape: true, // 允许字符串使用单引号或双引号，只要字符串中包含了一个其它引号，否则需要转义
        allowTemplateLiterals: true, // 允许字符串使用反勾号
      },
    ], // 强制使用一致的反勾号、双引号或单引号
    semi: [2, 'never'], // 末尾不用出现分号
    'semi-spacing': [
      2,
      {
        before: false,
        after: true,
      },
    ],
    'semi-spacing': [
      2,
      {
        before: false, // 禁止分号之前有空格
        after: true, // 强制分号之后有空格
      },
    ],
    'space-before-blocks': [2, 'always'], // 强制代码块之前出现空格
    /*'space-before-function-paren'冲突： https://github.com/prettier/prettier/issues/3847 */
    'space-before-function-paren': 0, // 关闭函数圆括号之前有一个空格，这个会和prettier冲突，暂未找到解决方法
    'space-in-parens': [2, 'never'], // 禁止圆括号内出现空格
    'space-infix-ops': 2, // 强制操作符周围有空格
    'space-unary-ops': [
      2,
      {
        words: true, // 适用于单词类一元操作符，例如：new、delete、typeof、void、yield
        nonwords: false, // 不适用于这些一元操作符: -、+、--、++、!、!!
      },
    ], // 在一元操作符之前或之后存在空格
    'spaced-comment': [
      2,
      'always',
      {
        // // 或 /* 必须跟随至少一个空白。
        markers: [
          'global',
          'globals',
          'eslint',
          'eslint-disable',
          '*package',
          '!',
          ',',
        ], // 这些字符在注释头可以不出现空格
      },
    ], // 强制在注释中 // 或 /* 使用一致的空格
    'template-curly-spacing': [2, 'never'], // 禁止模板字符串花括号内出现空格（可以换行）
    'use-isnan': 2, // 强制使用 isNaN() 检查 NaN
    'valid-typeof': 2, // 强制 typeof 表达式与有效的字符串进行比较
    'wrap-iife': [2, 'any'], // 强制立即执行的函数用括号包裹
    'yield-star-spacing': [2, 'both'], // 强制在 yield* 表达式中 * 周围使用空格
    yoda: [2, 'never'], // 禁止将字面变量写在表达式的左边
    'prefer-const': 2, // 要求使用 const 声明那些声明后不再被修改的变量
    'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0, // 生产环境禁用 debugger
    'object-curly-spacing': [
      2,
      'always',
      {
        objectsInObjects: false,
      },
    ], // 强制在花括号中使用一致的空格
    'array-bracket-spacing': [2, 'never'], // 强制数组方括号中使用一致的空格
  },
};

配置setting.json(在VC设置中进入setting.json文件)

{
  "files.autoSave": "afterDelay", // 立即自动保存文件。有时会导致代码自动保存时无法正确格式化
  "editor.fontSize": 16, // 字体大小
  "editor.tabSize": 2, // 设定tabsize缩进的空格，editor.detectIndentation启用时会覆盖该设置
  "eslint.validate": ["javascript", "javascriptreact", "vue", "html"], // 配置 ESLint 检查的文件类型
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }, // 保存时按照eslint的规则格式化
  "fileheader.customMade": {
    "Descriptin": "",
    "Version": "0.1",
    "Autor": "Your Name",
    "Date": "Do not edit",
    "LastEditors": "Your Name",
    "LastEditTime": "Do not edit"
  }, // 文件头部注释
  "fileheader.cursorMode": {
    "descripton": "",
    "param": "",
    "return": "",
    "author": "Your Name"
  }, // 函数头部注释
  //Shift + Alt + F自动格式化
  "[jsonc]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "editor.formatOnSave": true, //保存自动格式化
  "editor.formatOnType": true, //换行自动格式化
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "files.eol": "\n",
  "typescript.preferences.quoteStyle": "single",
  "javascript.preferences.quoteStyle": "single",
  // 编辑器换行
  "editor.wordWrap": "off",
  // 开启 vscode 文件路径导航
  "breadcrumbs.enabled": true,
  // prettier 设置语句末尾不加分号
  "prettier.semi": true,
  // prettier 设置强制单引号
  "prettier.singleQuote": true,
  // 选择 vue 文件中 template 的格式化工具
  "vetur.format.defaultFormatter.html": "js-beautify-html",
  // vetur 的自定义设置
  "vetur.format.defaultFormatterOptions": {
    "js-beautify-html": {
      "wrap_attributes": "aligned-multiple"
    },
    "prettier": {
      "singleQuote": true,
      "semi": false,
      "printWidth": 100,
      "wrapAttributes": false,
      "sortAttributes": false,
      "trailingComma": "none" // 不使用拖尾逗号
    }
  },
  "eslint.autoFixOnSave": true, // 每次保存的时候将代码按eslint格式进行修复
  "prettier.eslintIntegration": true, //让prettier使用eslint的代码格式进行校验
  "javascript.format.insertSpaceBeforeFunctionParenthesis": true, //让函数(名)和后面的括号之间加个空格
  "vetur.format.defaultFormatter.js": "vscode-typescript", //让vue中的js按编辑器自带的ts格式进行格式化
  "vetur.validation.template": false,
  "[json]": {
    
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "html.format.wrapAttributes": "preserve",
  // vscode清晰图标配置
  "workbench.iconTheme": "vscode-icons",
  "editor.quickSuggestions": {
    "strings": true
  },
  "editor.suggestSelection": "first",
  "vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue",
  "cssrem.rootFontSize": 80,
  "[vue]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "appworks.materialSources": [],
  "[html]": {
    "editor.defaultFormatter": "vscode.html-language-features"
  },
  "window.zoomLevel": -1,
  "[less]": {
    "editor.defaultFormatter": "Wscats.eno"
  }
}

关于VC中应用于前端的配置扩展文件可以参考：
推荐文章链接