eslint常用配置,配合自动保存格式化

本文展示了如何配置ESLint以适应Vue项目,包括设置parserOptions、env、extends和自定义rules。同时,也详细说明了Prettier的配置项,用于代码自动格式化,如trailingComma、printWidth等。这些配置能帮助维护代码风格的一致性和提升代码质量。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

eslint 常用配置

// ESlint 检查配置
module.exports = {
  root: true,
  parserOptions: {
    parser: 'babel-eslint',
    sourceType: 'module'
  },
  env: {
    browser: true,
    node: true,
    es6: true,
  },
  extends: ['plugin:vue/recommended', 'eslint:recommended'],
 
  // add your custom rules here
  //it is base on https://github.com/vuejs/eslint-config-vue
  rules: {
    "vue/max-attributes-per-line": [2, {
      "singleline": 10,
      "multiline": {
        "max": 1,//最大一个
        "allowFirstLine": false
      }
    }],
    "vue/html-self-closing": ["error", {
      "html": {
        "void": "always",
        "normal": "always",
        "component": "always"
      },
      "svg": "always",
      "math": "always"
    }],
    "vue/singleline-html-element-content-newline": "off",
    "vue/multiline-html-element-content-newline":"off",
    "vue/name-property-casing": ["error", "PascalCase"],
    "vue/no-v-html": "off",
    'accessor-pairs': 2,
    'arrow-spacing': [2, {//强制箭头函前后都使用空格
      'before': true,
      'after': true
    }],
    'block-spacing': [2, 'always'],//强制括号中开头或者结尾有空格,要求使用至少一个或多个空格
    'brace-style': [2, '1tbs', {//强制开括号在同一行
      'allowSingleLine': true//允许开括号和闭括号在同一行,默认是false
    }],
    'camelcase': [0, {
      'properties': 'always'//强制属性名称为驼峰风格
    }],
    // (默认) 禁用拖尾逗号,根据 ECMAScript 5(和 ECMAScript 3!)规范,对象文字中的尾随逗号是有效的。
    // 但是,IE8(不在 IE8 文档模式下)及以下版本在遇到 JavaScript 中的尾随逗号时会抛出错误。
    'comma-dangle': [2, 'never'],
    'comma-spacing': [2, {//强制在逗号前后使用一致的空格
      'before': false,//前面不要
      'after': true//后面要
    }],
    'comma-style': [2, 'last'],//(默认) 要求逗号放在数组元素、对象属性或变量声明之后,且在同一行
    'constructor-super': 2,//要求在构造函数中有 super() 的调用
    'curly': [2, 'multi-line'],//强制所有控制语句使用一致的括号风格,允许在单行中省略大括号
    'dot-location': [2, 'property'],//强制在点号之前和之后一致的换行
    'eol-last': 2,//要求或禁止文件末尾存在空行,强制文件末尾不要有换行符
    'eqeqeq': ["error", "always", {"null": "ignore"}],//要求使用 === 和 !==,不要对null使用此规则
    'generator-star-spacing': [2, {//强制 generator 函数中 * 号周围使用一致的空格
      'before': true,
      'after': true
    }],
    'handle-callback-err': [2, '^(err|error)$'],//要求回调函数中有容错处理
    'indent': [2, 2, {
      'SwitchCase': 1
    }],
    'jsx-quotes': [2, 'prefer-single'],//强制在 JSX 属性中一致地使用双引号或单引号,强制所有不包含单引号的 JSX 属性值使用单引号。
    'key-spacing': [2, {//强制在对象字面量的属性中键和值之间使用一致的间距
      'beforeColon': false,
      'afterColon': true
    }],
    'keyword-spacing': [2, {//强制在关键字前后使用一致的空格
      'before': true,
      'after': true
    }],
    'new-cap': [2, {//要求构造函数首字母大写
      'newIsCap': true,// (默认) 要求调用 new 操作符时有首字母大小的函数
      'capIsNew': false//允许调用首字母大写的函数时没有 new 操作符。
    }],
    'new-parens': 2,//强制或禁止调用无参构造函数时有圆括号
    'no-array-constructor': 2,//禁用 Array 构造函数
    //arguments.caller 和 arguments.callee 的使用使一些代码优化变得不可能。
    // 在 JavaScript 的新版本中它们已被弃用,同时在 ECMAScript 5 的严格模式下,它们也是被禁用的
    'no-caller': 2,
    '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,//禁止删除变量
    '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-native-reassign': 2,//不允许修改只读全局变量
    'no-negated-in-lhs': 2,//不允许对表达式中的左操作数求反
    'no-new-object': 2,//禁用 Object 的构造函数
    'no-new-require': 2,//禁止调用 require 时使用 new 操作符
    'no-new-symbol': 2,//禁止 Symbolnew 操作符和 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__ 属性
    '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,//禁止将标识符定义为受限的名字
    'no-spaced-func': 2,//不允许函数标识符及其应用程序之间存在间距
    'no-sparse-arrays': 2,//禁用稀疏数组
    'no-this-before-super': 2,//禁止在构造函数中,在调用 super() 之前使用 this 或 super
    'no-throw-literal': 2,//禁止抛出异常字面量
    'no-trailing-spaces': 2,//禁用行尾空格
    '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', {
      'avoidEscape': true,
      'allowTemplateLiterals': true
    }],
    'semi': [2, 'never'],//要求或禁止使用分号代替 ASI
    'semi-spacing': [2, {//强制分号之前和之后使用一致的空格
      'before': false,
      'after': true
    }],
    'space-before-blocks': [2, 'always'],//强制在块之前使用一致的空格
    'space-before-function-paren': [2, 'never'],//强制在 function的左括号之前使用一致的空格
    'space-in-parens': [2, 'never'],//强制在圆括号内使用一致的空格
    'space-infix-ops': 2,//    要求操作符周围有空格
    'space-unary-ops': [2, {//强制在一元操作符前后使用一致的空格
      'words': true,
      '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'],//要求 IIFE 使用括号括起来
    'yield-star-spacing': [2, 'both'],//强制在 yield* 表达式中 * 周围使用空格
    'yoda': [2, 'never'],//要求或禁止 “Yoda” 条件
    'prefer-const': 2,//要求使用 const 声明那些声明后不再被修改的变量
    'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
    'Mixed spaces and tabs  no-mixed-spaces-and-tabs': 0,//混合空格和制表符没有混合空格和制表符
    'object-curly-spacing': [2, 'always', {//强制在花括号中使用一致的空格
      objectsInObjects: false
    }],
    'array-bracket-spacing': [2, 'never']//强制数组方括号中使用一致的空格
  }
}
``



配合 格式化代码插件prettier 设置保存自动格式化


/* prettier的配置 */
"prettier.trailingComma": "none", //禁止随时添加逗号

"prettier.printWidth": 600, // 超过最大值换行

"prettier.tabWidth": 2, // 缩进字节数

"prettier.useTabs": false, // 缩进不使用tab,使用空格

"prettier.semi": false, // 句尾添加分号

"prettier.singleQuote": true, // 使用单引号代替双引号

"prettier.proseWrap": "preserve", // 默认值。因为使用了一些折行敏感型的渲染器(如GitHub comment)而按照markdown文本样式进行折行

"prettier.arrowParens": "avoid", // (x) => {} 箭头函数参数只有一个时是否要有小括号。avoid:省略括号

"prettier.bracketSpacing": true, // 在对象,数组括号与文字之间加空格 "{ foo: bar }"


"prettier.endOfLine": "auto", // 结尾是 \n \r \n\r auto

"prettier.eslintIntegration": false, //不让prettier使用eslint的代码格式进行校验

"prettier.htmlWhitespaceSensitivity": "ignore",

"prettier.ignorePath": ".prettierignore", // 不使用prettier格式化的文件填写在项目的.prettierignore文件中

// "prettier.jsxBracketSameLine": false, // 在jsx中把'>' 单独放一行

"prettier.jsxSingleQuote": false, // 在jsx中使用单引号代替双引号

"prettier.parser": "babylon", // 格式化的解析器,默认是babylon

"prettier.requireConfig": false, // Require a 'prettierconfig' to format prettier

"prettier.stylelintIntegration": false, //不让prettier使用stylelint的代码格式进行校验

// "prettier.trailingComma": "es5", // 在对象或数组最后一个元素后面是否加逗号(在ES5中加尾逗号)

"prettier.tslintIntegration": false,
"files.autoSave": "afterDelay", // 不让prettier使用tslint的代码格式进行校验

// "trailingComma": "none" // 函数最后不需要逗号

先下载代码格式化插件 Prettier - Code formatter

把自动格式化代码放到。vs code < 设置< settings.json

如果设置无效。

设置。 有个.editorconfig。 勾选去掉

在这里插入图片描述

<think>好的,用户想了解如何使用Node.js配合Prettier进行代码格式化。首先,我需要确认用户的具体需求是什么。他们可能是在Node.js项目中集成Prettier,或者希望在开发过程中自动格式化代码。根据提供的引用内容,特别是引用[1]、[4]、[5],Prettier主要用于代码格式化,而ESLint处理代码质量问题。 首先,用户需要安装Prettier。根据Node.js的常规做法,应该使用npm或者yarn来安装。需要指导用户通过命令行安装Prettier作为开发依赖。例如,npm install --save-dev prettier。 接下来,用户可能需要配置Prettier的规则。引用[5]提到创建.prettierrc文件,并设置一些选项,比如分号、单引号等。需要详细说明如何创建这个配置文件,并列举常用配置项,确保用户能根据自己的需求调整。 然后,用户可能想知道如何运行Prettier。这里需要给出命令行指令,例如npx prettier --write .,这样可以直接格式化所有文件。同时,可能需要解释其他参数,如--check来检查但不修改文件。 另外,引用[4]提到了与ESLint配合使用。用户可能已经有ESLint,需要避免规则冲突。这时需要指导安装eslint-config-prettier,并在ESLint配置中扩展它,以禁用冲突的规则。 还有,用户可能使用VSCode编辑器,需要配置自动格式化。引用[5]提到设置VSCode的默认格式化工具为Prettier,并启用保存自动格式化。这部分需要给出具体的设置步骤,比如在settings.json中添加相关配置。 最后,用户可能需要处理多种文件类型,如HTML、CSS等。需要指出Prettier默认支持这些文件,但可能需要额外的插件,例如针对Vue文件的支持,需要安装对应的插件。 需要确保步骤清晰,分点说明,每个步骤都有具体的命令或配置示例。同时,根据引用内容中的最佳实践,强调Prettier专注于格式化,而ESLint处理代码质量,两者结合使用效果更好。可能还需要提醒用户注意配置文件的位置和语法,避免常见错误,比如JSON格式的正确性。 总结来说,回答需要涵盖安装、配置、运行命令、编辑器集成以及与ESLint的整合,确保用户能够全面了解如何在Node.js项目中使用Prettier进行代码格式化。</think>### 如何使用 Node.js 配合 Prettier 进行代码格式化 以下是分步实现的详细流程,结合 Node.js 和 Prettier 实现代码格式化的标准化管理: --- #### 1. **安装 Prettier** 在 Node.js 项目中,通过 npm 或 yarn 安装 Prettier 作为开发依赖: ```bash npm install --save-dev prettier # 或 yarn add --dev prettier ``` 此步骤确保项目本地拥有 Prettier 的运行环境[^1]。 --- #### 2. **配置 Prettier 规则** 在项目根目录创建 `.prettierrc` 文件(JSON 格式),定义格式化规则: ```json { "semi": false, // 禁止末尾分号 "singleQuote": true, // 使用单引号 "trailingComma": "none", // 对象/数组末尾不加逗号 "tabWidth": 2 // 缩进宽度为2空格 } ``` 支持自定义规则如 `printWidth`(单行最大长度)、`bracketSpacing`(括号空格)等[^5]。 --- #### 3. **运行 Prettier 格式化** 通过命令行执行格式化操作: ```bash npx prettier --write . # 格式化所有文件并覆盖 npx prettier --check . # 仅检查代码是否符合规则 ``` 支持指定文件类型或路径,例如 `npx prettier --write src/**/*.js`[^4]。 --- #### 4. **与 ESLint 集成(可选)** 若项目中已使用 ESLint,需解决规则冲突: 1. 安装依赖: ```bash npm install --save-dev eslint-config-prettier ``` 2. 修改 ESLint 配置文件(如 `.eslintrc.js`): ```javascript module.exports = { extends: [ 'eslint:recommended', 'plugin:vue/recommended', 'prettier' // 必须放在最后以覆盖冲突规则 ] } ``` 此配置确保 Prettier 格式化优先级高于 ESLint 的格式规则[^3]。 --- #### 5. **编辑器集成(以 VSCode 为例)** 1. 安装 VSCode 插件 **Prettier - Code formatter**; 2. 在项目或全局设置(`settings.json`)中添加: ```json { "editor.defaultFormatter": "esbenp.prettier-vscode", "editor.formatOnSave": true } ``` 保存文件时自动触发格式化,提升开发效率[^5]。 --- #### 6. **扩展文件类型支持** Prettier 默认支持 JavaScript、TypeScript、HTML、CSS、JSON 等。如需处理 Vue 文件或 Markdown,无需额外配置;若需增强功能(如样式排序),可安装插件如 `prettier-plugin-organize-imports`。 --- ### 相关工具对比 | 工具 | 定位 | 适用场景 | |-------------|-----------------------|---------------------------| | **Prettier**| 代码格式化 | 统一代码风格,强制格式规范 | | **ESLint** | 代码质量检查 | 发现潜在错误,逻辑问题 | ---
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值