eslint-config-cmyr

草梅友仁个人使用的 eslint 检测规范

支持 ESLint v9+ 的扁平化配置（Flat Config）

"lint": "cross-env NODE_ENV=production eslint src --fix"

风格理念

1. 若无必要，勿增实体。
2. 如果某元素可有可无，则无
3. 若移除某元素会导致 bug ，则留，否则无

安装

# 前置依赖
npm install typescript eslint --save-dev
# 安装 eslint-config-cmyr
npm install eslint-config-cmyr --save-dev

配置

ESLint v9+ （推荐）

使用新的扁平化配置格式：

// eslint.config.js
import { defineConfig } from "eslint/config";
import cmyr from "eslint-config-cmyr";

export default defineConfig([cmyr]);

不同环境的配置

TypeScript 项目（默认）

// eslint.config.js
import { defineConfig } from "eslint/config";
import cmyr from "eslint-config-cmyr";

export default defineConfig([cmyr]);

TypeScript 项目（严格模式）

严格模式入口适用于对类型安全和代码质量要求更高的项目。该入口会启用基于类型信息的 TypeScript 检查，并对 any、不安全调用、不安全赋值等问题给出提示。

// eslint.config.js
import { defineConfig } from "eslint/config";
import cmyrStrict from "eslint-config-cmyr/strict";

export default defineConfig([cmyrStrict]);

默认入口与严格模式的区别：

1. 默认入口保留通用且必要的规则，兼容性优先。
2. 严格模式会启用 typescript-eslint 的类型感知严格规则。
3. 严格模式下新增规则以 warning 为主，便于存量项目渐进治理。
4. 只有少量开发期噪音较高的规则会按 NODE_ENV 在 production 中启用，例如 no-console、no-debugger 与行数限制。

Vue 项目

npm install typescript eslint eslint-plugin-vue eslint-config-cmyr --save-dev

// eslint.config.js
import { defineConfig } from "eslint/config";
import cmyr from "eslint-config-cmyr/vue";

export default defineConfig([cmyr]);

Vue 项目（严格模式）

// eslint.config.js
import { defineConfig } from "eslint/config";
import cmyrVueStrict from "eslint-config-cmyr/vue/strict";

export default defineConfig([cmyrVueStrict]);

React 项目

npm install typescript eslint eslint-plugin-react eslint-config-cmyr --save-dev

// eslint.config.js
import { defineConfig } from "eslint/config";
import cmyr from "eslint-config-cmyr/react";

export default defineConfig([cmyr]);

React 项目（严格模式）

// eslint.config.js
import { defineConfig } from "eslint/config";
import cmyrReactStrict from "eslint-config-cmyr/react/strict";

export default defineConfig([cmyrReactStrict]);

Browser 项目

// eslint.config.js
import { defineConfig } from "eslint/config";
import cmyr from "eslint-config-cmyr/browser";

export default defineConfig([cmyr]);

Nuxt 项目

npm install typescript eslint eslint-plugin-vue eslint-config-cmyr @nuxt/eslint --save-dev

// nuxt.config.ts;
export default defineNuxtConfig({
    modules: ["@nuxt/eslint"],
    eslint: {
        config: {
            standalone: false,
        },
    },
});

// eslint.config.js
import cmyrConfig from "eslint-config-cmyr/nuxt";
import withNuxt from "./.nuxt/eslint.config.mjs";

export default withNuxt(cmyrConfig, {
    rules: {},
});

Nuxt 项目（严格模式）

// eslint.config.js
import cmyrNuxtStrict from "eslint-config-cmyr/nuxt/strict";
import withNuxt from "./.nuxt/eslint.config.mjs";

export default withNuxt(cmyrNuxtStrict, {
    rules: {},
});

严格模式入口一览

1. eslint-config-cmyr/strict
2. eslint-config-cmyr/react/strict
3. eslint-config-cmyr/vue/strict
4. eslint-config-cmyr/nuxt/strict

这些入口都会在对应环境规则之上，额外启用类型感知的 TypeScript 严格检查；新增规则以 warning 为主，适合渐进式治理。