@icebreakers/eslint-config 2.0.0 → 2.0.1

package/README.md

@@ -10,7 +10,7 @@
 
 - Node.js 18 or newer
 - ESLint 9 with flat config support
-- Install optional peer plugins when you turn on Tailwind (`eslint-plugin-tailwindcss` or `eslint-plugin-better-tailwindcss`), MDX (`eslint-plugin-mdx`), Stylelint bridge (`eslint-plugin-better-stylelint`), or UnoCSS (`@unocss/eslint-plugin`)
+- Install optional peer plugins when you turn on Tailwind (`eslint-plugin-tailwindcss` or `eslint-plugin-better-tailwindcss`), MDX (`eslint-plugin-mdx`), or UnoCSS (`@unocss/eslint-plugin`)
 
 ## Installation
 
@@ -74,24 +74,42 @@ export default icebreaker({
 
 ### Stylelint Bridge
 
-Set `stylelint: true` to bridge Stylelint diagnostics into ESLint for
-`*.css`, `*.scss`, and `.vue` style blocks:
+`@icebreakers/eslint-config` bundles the Stylelint bridge and uses
+`@icebreakers/stylelint-config` as the default Stylelint preset when you opt in.
+The bridge is still disabled by default. Turn it on with `stylelint: true` to
+lint `*.css`, `*.scss`, and `.vue` style blocks through ESLint:
 
-```bash
-pnpm add -D eslint-plugin-better-stylelint
+```ts
+import { icebreaker } from '@icebreakers/eslint-config'
+
+export default icebreaker({
+  vue: true,
+  stylelint: true,
+})
 ```
 
+You can also inline Stylelint preset options directly in `eslint.config.ts`:
+
 ```ts
 import { icebreaker } from '@icebreakers/eslint-config'
 
 export default icebreaker({
   vue: true,
-  stylelint: true,
+  stylelint: {
+    cwd: process.cwd(),
+    presets: {
+      order: false,
+    },
+    rules: {
+      'color-named': 'never',
+    },
+  },
 })
 ```
 
-You can also pass `stylelint: { cwd: '/path/to/project' }` if Stylelint should
-resolve its config from a different working directory.
+`stylelint.cwd` changes the resolution root, and the remaining fields follow
+the `@icebreakers/stylelint-config` options (`presets`, `tailwindcssPreset`,
+`ignores`, `extends`, `overrides`, `rules`).
 
 ### NestJS Projects
 

package/README.zh.md

@@ -8,7 +8,7 @@
 
 - Node.js 18 或更高版本
 - 支持 Flat Config 的 ESLint 9
-- 如需启用 Tailwind、MDX、Stylelint 桥接、UnoCSS 等，可安装对应的可选依赖：`eslint-plugin-tailwindcss` / `eslint-plugin-better-tailwindcss`、`eslint-plugin-mdx`、`eslint-plugin-better-stylelint`、`@unocss/eslint-plugin`
+- 如需启用 Tailwind、MDX、UnoCSS 等，可安装对应的可选依赖：`eslint-plugin-tailwindcss` / `eslint-plugin-better-tailwindcss`、`eslint-plugin-mdx`、`@unocss/eslint-plugin`
 
 ## 安装
 
@@ -72,16 +72,14 @@ export default icebreaker({
 
 ### Stylelint 桥接
 
+`@icebreakers/eslint-config` 已内置 Stylelint bridge，并在启用时默认使用
+`@icebreakers/stylelint-config` 作为 Stylelint 预设；但 bridge 默认仍是关闭的。
 设置 `stylelint: true` 后，会把 Stylelint 诊断桥接到 ESLint，用于：
 
 - `*.css`
 - `*.scss`
 - `.vue` 文件里的 `<style>` 块
 
-```bash
-pnpm add -D eslint-plugin-better-stylelint
-```
-
 ```ts
 import { icebreaker } from '@icebreakers/eslint-config'
 
@@ -91,18 +89,29 @@ export default icebreaker({
 })
 ```
 
-如果 Stylelint 需要从其它目录解析配置，也可以传：
+也可以直接把 Stylelint 预设配置写进 `eslint.config.ts`：
 
 ```ts
 import { icebreaker } from '@icebreakers/eslint-config'
 
 export default icebreaker({
+  vue: true,
   stylelint: {
-    cwd: '/path/to/project',
+    cwd: process.cwd(),
+    presets: {
+      order: false,
+    },
+    rules: {
+      'color-named': 'never',
+    },
   },
 })
 ```
 
+其中 `stylelint.cwd` 用来指定配置解析根目录，其余字段沿用
+`@icebreakers/stylelint-config` 的选项结构，例如 `presets`、
+`tailwindcssPreset`、`ignores`、`extends`、`overrides`、`rules`。
+
 ### NestJS 项目
 
 建议在 Nest 项目中同时开启 `typescript` 与 `nestjs`，以便应用以下定制：

package/dist/index.cjs

@@ -149,6 +149,9 @@ function getDefaultTypescriptOptions(opts) {
 }
 //#endregion
 //#region src/features.ts
+function resolveStylelintConfigLoader() {
+	return require("url").pathToFileURL(__filename).href.endsWith(".ts") ? new URL("./stylelint.ts", require("url").pathToFileURL(__filename).href).href : new URL("./stylelint.js", require("url").pathToFileURL(__filename).href).href;
+}
 function resolveTailwindPresets(option) {
 	if (!option) return [];
 	if (typeof option === "object") return [(0, antfu_exports.interopDefault)(import("eslint-plugin-better-tailwindcss")).then((eslintPluginBetterTailwindcss) => {
@@ -170,29 +173,37 @@ function resolveTailwindPresets(option) {
 		return tailwind.configs["flat/recommended"];
 	}), { rules: { "tailwindcss/no-custom-classname": "off" } }];
 }
+function resolveStylelintBridgeOptions(option) {
+	const { cwd, ...stylelintConfigOptions } = typeof option === "object" ? option : {};
+	return {
+		...cwd ? { cwd } : {},
+		configLoader: resolveStylelintConfigLoader(),
+		configOptions: stylelintConfigOptions
+	};
+}
 function resolveStylelintBridgePresets(option) {
 	if (!option) return [];
-	const stylelintOptions = typeof option === "object" ? option : {};
-	const pluginPromise = (0, antfu_exports.interopDefault)(import("eslint-plugin-better-stylelint"));
+	const pluginModulePromise = import("eslint-plugin-better-stylelint");
+	const stylelintOptions = resolveStylelintBridgeOptions(option);
 	return [
-		pluginPromise.then((plugin) => {
+		pluginModulePromise.then((pluginModule) => {
 			return {
 				files: ["**/*.{css,pcss,postcss}"],
-				plugins: { stylelint: plugin },
-				processor: "stylelint/css"
+				plugins: { stylelint: pluginModule.default },
+				processor: pluginModule.createStylelintProcessor(stylelintOptions)
 			};
 		}),
-		pluginPromise.then((plugin) => {
+		pluginModulePromise.then((pluginModule) => {
 			return {
 				files: ["**/*.{scss,sass}"],
-				plugins: { stylelint: plugin },
-				processor: "stylelint/scss"
+				plugins: { stylelint: pluginModule.default },
+				processor: pluginModule.createStylelintProcessor(stylelintOptions)
 			};
 		}),
-		pluginPromise.then((plugin) => {
+		pluginModulePromise.then((pluginModule) => {
 			return {
 				files: ["**/*.vue"],
-				plugins: { stylelint: plugin },
+				plugins: { stylelint: pluginModule.default },
 				rules: { "stylelint/stylelint": ["error", stylelintOptions] }
 			};
 		})
@@ -475,6 +486,7 @@ function icebreakerLegacy(options = {}, ...userConfigs) {
 	return (0, antfu_exports.antfu)(...getPresets(options, "legacy"), ...userConfigs);
 }
 //#endregion
+exports.__toESM = __toESM;
 exports.getPresets = getPresets;
 exports.icebreaker = icebreaker;
 exports.icebreakerLegacy = icebreakerLegacy;

package/dist/index.d.cts

@@ -2922,9 +2922,10 @@ interface TailwindcssOption {
   tailwindConfig?: string;
 }
 type TailwindcssConfig = boolean | TailwindcssOption;
-type StylelintBridgeConfig = boolean | {
+interface StylelintBridgeOption {
   cwd?: string;
-};
+}
+type StylelintBridgeConfig = boolean | StylelintBridgeOption;
 type UserDefinedOptions = OptionsConfig & TypedFlatConfigItem$1 & {
   /**
    * Enable TailwindCSS support
@@ -2976,4 +2977,4 @@ declare function icebreakerLegacy(options?: UserDefinedOptions, ...userConfigs:
 //#region src/preset.d.ts
 declare function getPresets(options?: UserDefinedOptions, mode?: 'legacy'): [UserDefinedOptions, ...UserConfigItem[]];
 //#endregion
-export { type ConfigNames, type FlatConfigComposer, type TailwindcssConfig, type TailwindcssOption, type TypedFlatConfigItem, type UserConfigItem, type UserDefinedOptions, getPresets, icebreaker, icebreakerLegacy };
+export { type ConfigNames, type FlatConfigComposer, type StylelintBridgeConfig, type StylelintBridgeOption, type TailwindcssConfig, type TailwindcssOption, type TypedFlatConfigItem, type UserConfigItem, type UserDefinedOptions, getPresets, icebreaker, icebreakerLegacy };

package/dist/index.d.ts

@@ -2922,9 +2922,10 @@ interface TailwindcssOption {
   tailwindConfig?: string;
 }
 type TailwindcssConfig = boolean | TailwindcssOption;
-type StylelintBridgeConfig = boolean | {
+interface StylelintBridgeOption {
   cwd?: string;
-};
+}
+type StylelintBridgeConfig = boolean | StylelintBridgeOption;
 type UserDefinedOptions = OptionsConfig & TypedFlatConfigItem$1 & {
   /**
    * Enable TailwindCSS support
@@ -2976,4 +2977,4 @@ declare function icebreakerLegacy(options?: UserDefinedOptions, ...userConfigs:
 //#region src/preset.d.ts
 declare function getPresets(options?: UserDefinedOptions, mode?: 'legacy'): [UserDefinedOptions, ...UserConfigItem[]];
 //#endregion
-export { type ConfigNames, type FlatConfigComposer, type TailwindcssConfig, type TailwindcssOption, type TypedFlatConfigItem, type UserConfigItem, type UserDefinedOptions, getPresets, icebreaker, icebreakerLegacy };
+export { type ConfigNames, type FlatConfigComposer, type StylelintBridgeConfig, type StylelintBridgeOption, type TailwindcssConfig, type TailwindcssOption, type TypedFlatConfigItem, type UserConfigItem, type UserDefinedOptions, getPresets, icebreaker, icebreakerLegacy };

package/dist/index.js

@@ -140,6 +140,9 @@ function getDefaultTypescriptOptions(opts) {
 }
 //#endregion
 //#region src/features.ts
+function resolveStylelintConfigLoader() {
+	return import.meta.url.endsWith(".ts") ? new URL("./stylelint.ts", import.meta.url).href : new URL("./stylelint.js", import.meta.url).href;
+}
 function resolveTailwindPresets(option) {
 	if (!option) return [];
 	if (typeof option === "object") return [(0, antfu_exports.interopDefault)(import("eslint-plugin-better-tailwindcss")).then((eslintPluginBetterTailwindcss) => {
@@ -161,29 +164,37 @@ function resolveTailwindPresets(option) {
 		return tailwind.configs["flat/recommended"];
 	}), { rules: { "tailwindcss/no-custom-classname": "off" } }];
 }
+function resolveStylelintBridgeOptions(option) {
+	const { cwd, ...stylelintConfigOptions } = typeof option === "object" ? option : {};
+	return {
+		...cwd ? { cwd } : {},
+		configLoader: resolveStylelintConfigLoader(),
+		configOptions: stylelintConfigOptions
+	};
+}
 function resolveStylelintBridgePresets(option) {
 	if (!option) return [];
-	const stylelintOptions = typeof option === "object" ? option : {};
-	const pluginPromise = (0, antfu_exports.interopDefault)(import("eslint-plugin-better-stylelint"));
+	const pluginModulePromise = import("eslint-plugin-better-stylelint");
+	const stylelintOptions = resolveStylelintBridgeOptions(option);
 	return [
-		pluginPromise.then((plugin) => {
+		pluginModulePromise.then((pluginModule) => {
 			return {
 				files: ["**/*.{css,pcss,postcss}"],
-				plugins: { stylelint: plugin },
-				processor: "stylelint/css"
+				plugins: { stylelint: pluginModule.default },
+				processor: pluginModule.createStylelintProcessor(stylelintOptions)
 			};
 		}),
-		pluginPromise.then((plugin) => {
+		pluginModulePromise.then((pluginModule) => {
 			return {
 				files: ["**/*.{scss,sass}"],
-				plugins: { stylelint: plugin },
-				processor: "stylelint/scss"
+				plugins: { stylelint: pluginModule.default },
+				processor: pluginModule.createStylelintProcessor(stylelintOptions)
 			};
 		}),
-		pluginPromise.then((plugin) => {
+		pluginModulePromise.then((pluginModule) => {
 			return {
 				files: ["**/*.vue"],
-				plugins: { stylelint: plugin },
+				plugins: { stylelint: pluginModule.default },
 				rules: { "stylelint/stylelint": ["error", stylelintOptions] }
 			};
 		})

package/dist/stylelint.cjs

@@ -0,0 +1,9 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("./index.cjs");
+let _icebreakers_stylelint_config = require("@icebreakers/stylelint-config");
+//#region src/stylelint.ts
+function resolveStylelintConfig(options = {}) {
+	return (0, _icebreakers_stylelint_config.createStylelintConfig)(options);
+}
+//#endregion
+exports.resolveStylelintConfig = resolveStylelintConfig;

package/dist/stylelint.d.cts

@@ -0,0 +1,6 @@
+import { IcebreakerStylelintOptions, IcebreakerStylelintOptions as IcebreakerStylelintOptions$1, createStylelintConfig } from "@icebreakers/stylelint-config";
+
+//#region src/stylelint.d.ts
+declare function resolveStylelintConfig(options?: IcebreakerStylelintOptions$1): ReturnType<typeof createStylelintConfig>;
+//#endregion
+export { type IcebreakerStylelintOptions, resolveStylelintConfig };

package/dist/stylelint.d.ts

@@ -0,0 +1,6 @@
+import { IcebreakerStylelintOptions, IcebreakerStylelintOptions as IcebreakerStylelintOptions$1, createStylelintConfig } from "@icebreakers/stylelint-config";
+
+//#region src/stylelint.d.ts
+declare function resolveStylelintConfig(options?: IcebreakerStylelintOptions$1): ReturnType<typeof createStylelintConfig>;
+//#endregion
+export { type IcebreakerStylelintOptions, resolveStylelintConfig };

package/dist/stylelint.js

@@ -0,0 +1,7 @@
+import { createStylelintConfig } from "@icebreakers/stylelint-config";
+//#region src/stylelint.ts
+function resolveStylelintConfig(options = {}) {
+	return createStylelintConfig(options);
+}
+//#endregion
+export { resolveStylelintConfig };

package/index.d.ts

@@ -13,9 +13,14 @@ export interface TailwindcssOption {
 }
 
 export type TailwindcssConfig = boolean | TailwindcssOption
+export interface StylelintBridgeOption {
+  cwd?: string
+}
+export type StylelintBridgeConfig = boolean | StylelintBridgeOption
 
 export type UserDefinedOptions = OptionsConfig & TypedFlatConfigItem & {
   tailwindcss?: TailwindcssConfig
+  stylelint?: StylelintBridgeConfig
   mdx?: boolean
   a11y?: boolean
   nestjs?: boolean

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@icebreakers/eslint-config",
   "type": "module",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "ESLint preset from Icebreaker's dev-configs",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -24,6 +24,11 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
+    "./stylelint": {
+      "types": "./dist/stylelint.d.ts",
+      "import": "./dist/stylelint.js",
+      "require": "./dist/stylelint.cjs"
+    },
     "./*": "./*"
   },
   "main": "./dist/index.cjs",
@@ -34,13 +39,9 @@
     "index.d.ts"
   ],
   "peerDependencies": {
-    "eslint-plugin-pnpm": "^1.4.3",
-    "eslint-plugin-better-stylelint": "0.1.0"
+    "eslint-plugin-pnpm": "^1.4.3"
   },
   "peerDependenciesMeta": {
-    "eslint-plugin-better-stylelint": {
-      "optional": true
-    },
     "eslint-plugin-pnpm": {
       "optional": true
     }
@@ -56,7 +57,9 @@
     "eslint-plugin-react-hooks": "^7.0.1",
     "eslint-plugin-react-refresh": "^0.5.2",
     "eslint-plugin-tailwindcss": "3.18.2",
-    "eslint-plugin-vuejs-accessibility": "^2.5.0"
+    "eslint-plugin-vuejs-accessibility": "^2.5.0",
+    "@icebreakers/stylelint-config": "2.1.0",
+    "eslint-plugin-better-stylelint": "0.1.1"
   },
   "optionalDependencies": {
     "@unocss/eslint-plugin": "66.6.7",
@@ -69,6 +72,8 @@
   "tsd": {
     "directory": "test-d",
     "compilerOptions": {
+      "module": "esnext",
+      "moduleResolution": "bundler",
       "skipLibCheck": true
     }
   },