@142vip工程化

切换主题

@142vip/eslint-config ​

NPM version

通用的 ESLint 配置规则和规范，简化 ESLint 配置。

安装 ​

shell
# npm
npm install -D @142vip/eslint-config eslint

# pnpm
pnpm add -D @142vip/eslint-config eslint

功能 ​

  • ✅ defineVipEslintConfig 基于 @antfu/eslint-config 的扁平配置
  • ✅ 默认开启 TypeScript、Vue、JSONC、YAML、Markdown 处理
  • ✅ Markdown 内嵌代码块规则降级（教学示例不误报）
  • ✅ baseEslintRules：no-console warn 与受限 console 调用
  • ✅ 依赖 @antfu/eslint-config 9.x（ESM）；本包仅 import 导出，供 fa lint 与自建 eslint.config.* 使用

配置 ​

未建 eslint.config.* 时，安装 @142vip/fairy-cli 后执行 fa lint 会使用包内 config/default-eslint.config.mjs。也可自建 eslint.config.js / eslint.config.mjs，或 fa lint -f ./eslint.config.mjs。

使用 ​

js
// eslint.config.js（可选；未建文件时用 fa lint 内置配置）
import { defineVipEslintConfig } from '@142vip/eslint-config'

export default defineVipEslintConfig()

自定义规则写在参数里即可，不必再 .then() 把配置拼到末尾。同名规则以后出现的整段替换。

不带 files 的 rules 全局生效：

js
export default defineVipEslintConfig({
  rules: {
    'no-console': 'off',
  },
})

只作用于部分文件时带上 files，或从第二个参数传入。这样不会和 antfu 第一参冲突，也不会让 Vue 规则套到其它文件上：

js
export default defineVipEslintConfig({
  files: ['**/*.vue'],
  rules: {
    'vue/multi-word-component-names': ['warn', {
      ignores: ['index', 'App', 'Register', '[id]', '[url]'],
    }],
    'vue/component-name-in-template-casing': ['warn', 'PascalCase', {
      registeredComponentsOnly: false,
      ignores: ['/^icon-/'],
    }],
  },
})

升级 ​

shell
# 依赖更新
pnpm upgrade @142vip/eslint-config

参考 ​

证书 ​

MIT

Copyright (c) 2019-present, @142vip 储凡

仅供学习参考，商业使用请保留作者版权信息，作者不保证也不承担任何软件的使用风险。