当前位置:   article > 正文

Vue3+TS项目,eslint、prettier安装配置_vue3 ts 安装eslint

vue3 ts 安装eslint

        eslint和prettier的作用主要为:可以规范团队的代码风格。在实际项目中,团队的每个成员的编码习惯都不同,这极有可能造成,一个项目多个代码风格,这会造成代码阅读困难,后期维护难度大灯问题,这就需要配置下eslint和prettier。

1.eslint
1.安装依赖

首先我们需要先安装 @eslint/create-config 插件:

pnpm install -D @eslint/create-config

提示我未安装eslint,按y,回车安装

  1. Need to install the following packages:
  2. eslint@8.57.0
  3. Ok to proceed? (y) y

接下来执行初始化。

npx eslint --init

接下来会有弹出一些问题,可根据自身项目情况进行回答,期间会询问是否需要安装相应插件,y->回车。

2.配置eslintrc

会在项目根目录下生成.eslintrc.cjs文件,然后对项目进行自己需要的配置

  1. module.exports = {
  2. // 使 eslint 支持 node 与 ES6
  3. env: {
  4. browser: true,
  5. es2021: true,
  6. node: true
  7. },
  8. // 引入推荐的语法校验规则
  9. extends: [
  10. 'eslint:recommended',
  11. 'plugin:vue/vue3-recommended',
  12. 'plugin:@typescript-eslint/recommended',
  13. 'plugin:prettier/recommended'
  14. ],
  15. overrides: [],
  16. // 这里一定要配置对 先使用vue-eslint-parser 再使用@typescript-eslint/parser
  17. // 先解析 <template> 标签中的内容 然后再解析 vue <script> 标签中的 TS 代码
  18. // 选择使用的解析器
  19. parser: 'vue-eslint-parser',
  20. // 解析器的详细配置
  21. parserOptions: {
  22. // 使用最新版 ES 语法
  23. ecmaVersion: 'latest',
  24. // 使用 ESLint TS 解析器
  25. parser: '@typescript-eslint/parser',
  26. // 使用 ES 模块化规范
  27. sourceType: 'module'
  28. },
  29. // 使用的插件
  30. plugins: ['vue', '@typescript-eslint'],
  31. // 自定义规则
  32. rules: {
  33. '@typescript-eslint/no-unused-vars': 'off',
  34. indent: [
  35. 'error',
  36. 4,
  37. {
  38. SwitchCase: 1
  39. }
  40. ],
  41. 'vue/multi-word-component-names': [
  42. 'error',
  43. {
  44. ignores: ['index', 'Header'] //需要忽略的组件名
  45. }
  46. ],
  47. '@typescript-eslint/no-var-requires': 'off',
  48. '@typescript-eslint/no-explicit-any': 'off',
  49. semi: 'off',
  50. '@typescript-eslint/no-this-alias': 'off',
  51. 'eslintno-debugger': 'off',
  52. 'vue/no-unused-vars': 'off',
  53. 'vue/no-template-shadow': 'off',
  54. 'vue/require-v-for-key': 'off',
  55. 'vue/no-textarea-mustache': 'off',
  56. 'vue/no-v-html': 'off'
  57. }
  58. };
3.配置下忽略文件eslintignore

在根目录下创建.eslintignore文件,排除一些文件夹

  1. node_modules
  2. *.md
  3. .vscode
  4. .idea
  5. dist
  6. /public
  7. /docs
  8. .husky
  9. .local
  10. /bin
  11. Dockerfile
  12. .eslintrc.js
4.配置package.json

然后配置下package.json中的启动命令,这样便可以执行 pnpm run lint:fix 来进行自动格式化代码。

  1. "scripts": {
  2. "dev": "vite --open",
  3. "test": "echo \"Error: no test specified\" && exit 1",
  4. "eslint:fix": "eslint --fix"
  5. },
prettier
 1.安装 prettier 依赖
pnpm install -D prettier
pnpm install -D eslint-config-prettier eslint-plugin-prettier
2.创建.prettierrc.js 文件
  1. module.exports = {
  2. "singleQuote": true,
  3. "semi": false,
  4. "bracketSpacing": true,
  5. "htmlWhitespaceSensitivity": "ignore",
  6. "endOfLine": "auto",
  7. "trailingComma": "all",
  8. "tabWidth": 2,
  9. "printWidth": 100,
  10. "useTabs": false,
  11. "bracketSameLine": true,
  12. "arrowParens": "always",
  13. "vueIndentScriptAndStyle": false,
  14. "singleAttributePerLine": false
  15. }
3.创建 .prettierignore 文件
  1. dist/
  2. node_modules/
  3. .vscode/
  4. .idea/
  5. /public/*
  6. .local
  7. **/*.svg
  8. **/*.sh
4.配置package.json
  1. {
  2. "scripts": {
  3. "lint:prettier": "prettier --write **/*.{js,json,tsx,css,less,scss,vue,html,md}"
  4. }
  5. }

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/笔触狂放9/article/detail/769888
推荐阅读
相关标签
  

闽ICP备14008679号