飞道的博客

Vue项目中使用ellint和prettier-规范和约束我们的代码

529人阅读  评论(0)

目录结构

在项目中使用eslint和prettier来规范和约束我们的代码

安装

我们在使用vue-cli创建vue项目的时候会让我们选择校验方式,我们选择ESLint + Prettier的方式,你也可以自己使用npm手动安装。

prettier

项目根目录新建.prettierrc.json文件,贴一下我常用的配置,文件夹建完,之后我们ctrl+s保存的时候,就会按照这个规则格式化我们的代码


  
  1. {
  2. // tab缩进大小,默认为2
  3. "tabWidth" : 4 ,
  4. // 使用tab缩进,默认false
  5. "useTabs" : false ,
  6. // 使用分号, 默认true
  7. "semi" : false ,
  8. // 使用单引号, 默认false(在jsx中配置无效, 默认都是双引号)
  9. "singleQuote" : false ,
  10. // 行尾逗号,默认none,可选 none|es5|all
  11. // es5 包括es5中的数组、对象
  12. // all 包括函数对象等所有可选
  13. "TrailingCooma" : "all" ,
  14. // 对象中的空格 默认true
  15. // true: { foo: bar }
  16. // false: {foo: bar}
  17. "bracketSpacing" : true ,
  18. // JSX标签闭合位置 默认false
  19. // false: <div
  20. // className=""
  21. // style={{}}
  22. // >
  23. // true: <div
  24. // className=""
  25. // style={{}} >
  26. "jsxBracketSameLine" : false ,
  27. // 箭头函数参数括号 默认avoid 可选 avoid| always
  28. // avoid 能省略括号的时候就省略 例如x => x
  29. // always 总是有括号
  30. "arrowParens" : "avoid"
  31. }

eslint

1.项目根目录新建.eslintrc.js文件


  
  1. module.exports = {
  2. root: true,
  3. env: {
  4. node: true,
  5. },
  6. extends: [
  7. 'plugin:vue/vue3-essential', //vue3核心的lint的规则
  8. 'eslint:recommended', //eslint的建议规则
  9. '@vue/typescript/recommended',
  10. '@vue/prettier', //prettier建议的规则
  11. // '@vue/prettier/@typescript-eslint',
  12. ],
  13. parserOptions: {
  14. ecmaVersion: 2020,
  15. },
  16. rules: {
  17. semi: [1, 'never'],//always(总是) 或者 never(从来不)
  18. 'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
  19. 'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
  20. 'prettier/prettier': [
  21. 'warn',
  22. {
  23. trailingComma: 'es5',
  24. },
  25. ],
  26. },
  27. overrides: [
  28. {
  29. files: [
  30. '**/__tests__/*.{j,t}s?(x)',
  31. '**/tests/unit/**/*.spec.{j,t}s?(x)',
  32. ],
  33. env: {
  34. jest: true,
  35. },
  36. },
  37. ],
  38. };

2.选项说明

"root": true

默认情况下,ESLint 会在所有父级目录里寻找配置文件,一直到根目录。如果发现配置文件中有 “root”: true,它就会停止在父级目录中寻找。


  
  1. extends: [
  2. 'plugin:vue/vue3-essential', //vue3核心的lint的规则
  3. 'eslint:recommended', //eslint的建议规则
  4. '@vue/typescript/recommended',
  5. '@vue/prettier', //prettier建议的规则
  6. '@vue/prettier/@typescript-eslint',
  7. ],

一个配置文件可以从基础配置中继承已启用的规则。如上,如果值为字符串数组则每个配置继承它前面的配置。值为 “eslint:recommended” 的 extends 属性启用了eslint默认的规则,请参考:https://cn.eslint.org/docs/rules/


  
  1. rules: {
  2. semi: [ 2, 'always'],
  3. 'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
  4. 'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
  5. 'prettier/prettier': [
  6. 'warn',
  7. {
  8. trailingComma: 'es5',
  9. },
  10. ],
  11. },

ESLint 附带有大量的规则。你可以在rules选项中设置,设置的规则将覆盖上面继承的默认规则。要改变一个规则设置,你必须将规则 ID 设置为下列值之一:

  • “off” 或 0 - 关闭规则
  • “warn” 或 1 - 开启规则,使用警告级别的错误:warn (不会导致程序退出)
  • “error” 或 2 - 开启规则,使用错误级别的错误:error (当被触发的时候,程序会退出)

3.看一个例子:
我上面在rules里面配置了semi: [1, 'never'],,意思就是禁止使用尾部分号,但是级别是警告,那么我如果项目中尾部有分号,我控制台就会报警告信息

那如果我改成semi:[2,'never']的时候,意思就是尾部禁止使用分号,但是级别变成错误那么我如果项目中尾部有分号,我程序就会报错,终止执行


转载:https://blog.csdn.net/JackieDYH/article/details/116799554
查看评论
* 以上用户言论只代表其个人观点,不代表本网站的观点或立场