Eslint配合Prettier实现代码校验

前置条件:

    1.禁用格式化插件 prettier format on save 关闭

    2.安装Eslint插件,并配置保存自动修复

    "editor.codeActionsOnSave": {
        "source.fixAll": true  // 保存自动修复
    },
    
     // 编辑器设置 - 保存时做格式化
    "editor.formatOnSave": false,

基础配置:

   在.eslintrc.cjs文件中配置

rules: {
    'prettier/prettier': [
      'warn',
      {
        singleQuote: true, // 单引号
        semi: false, // 无分号
        printwidth: 80, // 每行宽度至多80字符
        trailingComma: 'none', // 不假对象|数组最后逗号
        endOfLine: 'auto' // 换行符号不限制 (win mac 不一致)
      }
    ],
    'vue/multi-word-component-names': [
      'warn',
      {
        ignores: ['index'] // vue组件名称多单词组成(忽略index.vue)
      }
    ],
    'vue/no-setup-props-destructure': ['off'], // 关闭props结构校验
    'no-undef': 'error' // 添加未定义变量错误提示
  }

### ESLintPrettier 的区别 ESLint 是一种用于 JavaScript 和其他前端技术的静态代码分析工具,主要用于检测潜在错误并强制执行一致的编码标准[^1]。它通过定义一系列规则来帮助开发者发现代码中的问题,从而提高代码质量。 Prettier 则是一个代码格式化工具,专注于自动化调整代码样式,使团队成员能够遵循统一的代码风格[^2]。它的主要目标不是寻找逻辑错误,而是处理诸如缩进、空格、引号等视觉上的细节。 两者的主要区别在于功能定位: - **ESLint** 关注的是代码质量和潜在问题。 - **Prettier** 更侧重于代码样式的标准化和一致性。 --- ### 如何配合使用 ESLintPrettier 为了实现两者的无缝协作,可以按照以下方式设置: #### 1. 安装必要的依赖 在项目中安装 `eslint` 和 `prettier` 及其相关插件: ```bash npm install --save-dev eslint prettier eslint-config-prettier eslint-plugin-prettier ``` 其中,`eslint-config-prettier` 负责关闭可能与 Prettier 冲突的 ESLint 规则,而 `eslint-plugin-prettier` 将 Prettier 集成到 ESLint 中以便一起运行[^3]。 #### 2. 创建 `.eslintrc.js` 文件 在项目的根目录下创建或更新 ESLint 配置文件,确保包含以下内容: ```javascript module.exports = { extends: [ 'plugin:prettier/recommended', // 启用 Prettier 推荐配置 ], rules: { 'space-before-function-paren': 'off', // 解决特定冲突 }, }; ``` 此配置启用了 Prettier 并禁用了可能导致冲突的规则。 #### 3. 设置 `.prettierrc` 文件 在同一目录下创建 `.prettierrc` 文件,指定所需的代码格式选项: ```json { "semi": false, // 不尾随分号 "singleQuote": true, // 使用单引号 "trailingComma": "none" // 多行逗号分隔的语法中,最后一行不加逗号 } ``` 这些参数可以根据具体需求自定义。 #### 4. VSCode 插件支持 如果使用 Visual Studio Code 编辑器,则需安装官方推荐的扩展程序 `Prettier - Code Formatter`。随后,在编辑器设置中启用保存时自动格式化的功能: ```json { "editor.formatOnSave": true, "[javascript]": { "editor.defaultFormatter": "esbenp.prettier-vscode" } } ``` 以上步骤完成后,每次保存文件都会触发基于 PrettierESLint 的联合校验过程。 --- ### 总结 通过上述方法,可以使 ESLintPrettier 协同工作,既保持代码的一致性又避免重复劳动。这种组合不仅提高了开发效率还减少了人为失误的可能性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值