@icebreakers/eslint-config 2.0.1 → 2.0.2

package/dist/index.d.cts

@@ -1862,7 +1862,7 @@ type CustomRuleVisitorWithExit$1<RuleVisitorType extends RuleVisitor$1> = { [Key
 type RuleVisitor = RuleVisitor$1;
 type CustomRuleVisitorWithExit<RuleVisitorType extends RuleVisitor> = CustomRuleVisitorWithExit$1<RuleVisitorType>;
 //#endregion
-//#region ../../node_modules/.pnpm/eslint@10.0.3_jiti@2.6.1/node_modules/eslint/lib/types/index.d.ts
+//#region ../../node_modules/.pnpm/eslint@10.1.0_jiti@2.6.1/node_modules/eslint/lib/types/index.d.ts
 //------------------------------------------------------------------------------
 // Exports
 //------------------------------------------------------------------------------
@@ -2538,31 +2538,65 @@ declare namespace ESLint {
   type Plugin = Plugin$1;
   type FixType = "directive" | "problem" | "suggestion" | "layout";
   type CacheStrategy = "content" | "metadata";
+  /** The options with which to configure the ESLint instance. */
   interface Options {
     // File enumeration
+    /** The value to use for the current working directory. */
     cwd?: string | undefined;
+    /** If `false` then `ESLint#lintFiles()` doesn't throw even if no target files found. Defaults to `true`. */
     errorOnUnmatchedPattern?: boolean | undefined;
+    /**
+     * Set to false to skip glob resolution of input file paths to lint (default: true).
+     * If false, each input file path is assumed to be a non-glob path to an existing file.
+     */
     globInputPaths?: boolean | undefined;
+    /** False disables all ignore patterns except for the default ones. */
     ignore?: boolean | undefined;
+    /** Ignore file patterns to use in addition to config ignores. These patterns are relative to `cwd`. */
     ignorePatterns?: string[] | null | undefined;
+    /** When set to true, missing patterns cause the linting operation to short circuit and not report any failures. */
     passOnNoPatterns?: boolean | undefined;
+    /** Show warnings when the file list includes ignored files. */
     warnIgnored?: boolean | undefined; // Linting
+    /** Enable or disable inline configuration comments. */
     allowInlineConfig?: boolean | undefined;
+    /** Base config, extended by all configs used with this instance. */
     baseConfig?: Linter.Config | Linter.Config[] | null | undefined;
+    /** Override config, overrides all configs used with this instance. */
     overrideConfig?: Linter.Config | Linter.Config[] | null | undefined;
+    /**
+     * Searches for default config file when falsy; doesn't do any config file lookup when `true`; considered to be a config filename when a string.
+     */
     overrideConfigFile?: string | true | null | undefined;
+    /** An array of plugin implementations. */
     plugins?: Record<string, Plugin> | null | undefined;
+    /**
+     * Default is `() => true`. A predicate function that filters rules to be run.
+     * This function is called with an object containing `ruleId` and `severity`, and returns `true` if the rule should be run.
+     */
     ruleFilter?: ((arg: {
       ruleId: string;
       severity: Exclude<Linter.Severity, 0>;
     }) => boolean) | undefined;
+    /** True enables added statistics on lint results. */
     stats?: boolean | undefined; // Autofix
+    /** Execute in autofix mode. If a function, should return a boolean. */
     fix?: boolean | ((message: Linter.LintMessage) => boolean) | undefined;
+    /** Array of rule types to apply fixes for. */
     fixTypes?: FixType[] | null | undefined; // Cache-related
+    /** Enable result caching. */
     cache?: boolean | undefined;
+    /** The cache file to use instead of .eslintcache. */
     cacheLocation?: string | undefined;
-    cacheStrategy?: CacheStrategy | undefined; // Other Options
+    /** The strategy used to detect changed files. */
+    cacheStrategy?: CacheStrategy | undefined;
+    /** If true, apply suppressions automatically. Defaults to false. */
+    applySuppressions?: boolean | undefined;
+    /** Path to suppressions file. Relative to cwd. Defaults to eslint-suppressions.json in cwd. */
+    suppressionsLocation?: string | undefined; // Other Options
+    /** Maximum number of linting threads, "auto" to choose automatically, "off" for no multithreading. */
     concurrency?: number | "auto" | "off" | undefined;
+    /** Array of feature flags to enable. */
     flags?: string[] | undefined;
   }
   /** A linting result. */
@@ -2972,9 +3006,11 @@ type UserConfigItem = Awaitable<TypedFlatConfigItem$1 | TypedFlatConfigItem$1[]
 //#endregion
 //#region src/factory.d.ts
 declare function icebreaker(options?: UserDefinedOptions, ...userConfigs: UserConfigItem[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
+type IcebreakerEslintConfig = ReturnType<typeof icebreaker>;
 declare function icebreakerLegacy(options?: UserDefinedOptions, ...userConfigs: UserConfigItem[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
+type IcebreakerLegacyEslintConfig = ReturnType<typeof icebreakerLegacy>;
 //#endregion
 //#region src/preset.d.ts
 declare function getPresets(options?: UserDefinedOptions, mode?: 'legacy'): [UserDefinedOptions, ...UserConfigItem[]];
 //#endregion
-export { type ConfigNames, type FlatConfigComposer, type StylelintBridgeConfig, type StylelintBridgeOption, type TailwindcssConfig, type TailwindcssOption, type TypedFlatConfigItem, type UserConfigItem, type UserDefinedOptions, getPresets, icebreaker, icebreakerLegacy };
+export { type ConfigNames, type FlatConfigComposer, IcebreakerEslintConfig, IcebreakerLegacyEslintConfig, type StylelintBridgeConfig, type StylelintBridgeOption, type TailwindcssConfig, type TailwindcssOption, type TypedFlatConfigItem, type UserConfigItem, type UserDefinedOptions, getPresets, icebreaker, icebreakerLegacy };

package/dist/index.d.ts

@@ -1862,7 +1862,7 @@ type CustomRuleVisitorWithExit$1<RuleVisitorType extends RuleVisitor$1> = { [Key
 type RuleVisitor = RuleVisitor$1;
 type CustomRuleVisitorWithExit<RuleVisitorType extends RuleVisitor> = CustomRuleVisitorWithExit$1<RuleVisitorType>;
 //#endregion
-//#region ../../node_modules/.pnpm/eslint@10.0.3_jiti@2.6.1/node_modules/eslint/lib/types/index.d.ts
+//#region ../../node_modules/.pnpm/eslint@10.1.0_jiti@2.6.1/node_modules/eslint/lib/types/index.d.ts
 //------------------------------------------------------------------------------
 // Exports
 //------------------------------------------------------------------------------
@@ -2538,31 +2538,65 @@ declare namespace ESLint {
   type Plugin = Plugin$1;
   type FixType = "directive" | "problem" | "suggestion" | "layout";
   type CacheStrategy = "content" | "metadata";
+  /** The options with which to configure the ESLint instance. */
   interface Options {
     // File enumeration
+    /** The value to use for the current working directory. */
     cwd?: string | undefined;
+    /** If `false` then `ESLint#lintFiles()` doesn't throw even if no target files found. Defaults to `true`. */
     errorOnUnmatchedPattern?: boolean | undefined;
+    /**
+     * Set to false to skip glob resolution of input file paths to lint (default: true).
+     * If false, each input file path is assumed to be a non-glob path to an existing file.
+     */
     globInputPaths?: boolean | undefined;
+    /** False disables all ignore patterns except for the default ones. */
     ignore?: boolean | undefined;
+    /** Ignore file patterns to use in addition to config ignores. These patterns are relative to `cwd`. */
     ignorePatterns?: string[] | null | undefined;
+    /** When set to true, missing patterns cause the linting operation to short circuit and not report any failures. */
     passOnNoPatterns?: boolean | undefined;
+    /** Show warnings when the file list includes ignored files. */
     warnIgnored?: boolean | undefined; // Linting
+    /** Enable or disable inline configuration comments. */
     allowInlineConfig?: boolean | undefined;
+    /** Base config, extended by all configs used with this instance. */
     baseConfig?: Linter.Config | Linter.Config[] | null | undefined;
+    /** Override config, overrides all configs used with this instance. */
     overrideConfig?: Linter.Config | Linter.Config[] | null | undefined;
+    /**
+     * Searches for default config file when falsy; doesn't do any config file lookup when `true`; considered to be a config filename when a string.
+     */
     overrideConfigFile?: string | true | null | undefined;
+    /** An array of plugin implementations. */
     plugins?: Record<string, Plugin> | null | undefined;
+    /**
+     * Default is `() => true`. A predicate function that filters rules to be run.
+     * This function is called with an object containing `ruleId` and `severity`, and returns `true` if the rule should be run.
+     */
     ruleFilter?: ((arg: {
       ruleId: string;
       severity: Exclude<Linter.Severity, 0>;
     }) => boolean) | undefined;
+    /** True enables added statistics on lint results. */
     stats?: boolean | undefined; // Autofix
+    /** Execute in autofix mode. If a function, should return a boolean. */
     fix?: boolean | ((message: Linter.LintMessage) => boolean) | undefined;
+    /** Array of rule types to apply fixes for. */
     fixTypes?: FixType[] | null | undefined; // Cache-related
+    /** Enable result caching. */
     cache?: boolean | undefined;
+    /** The cache file to use instead of .eslintcache. */
     cacheLocation?: string | undefined;
-    cacheStrategy?: CacheStrategy | undefined; // Other Options
+    /** The strategy used to detect changed files. */
+    cacheStrategy?: CacheStrategy | undefined;
+    /** If true, apply suppressions automatically. Defaults to false. */
+    applySuppressions?: boolean | undefined;
+    /** Path to suppressions file. Relative to cwd. Defaults to eslint-suppressions.json in cwd. */
+    suppressionsLocation?: string | undefined; // Other Options
+    /** Maximum number of linting threads, "auto" to choose automatically, "off" for no multithreading. */
     concurrency?: number | "auto" | "off" | undefined;
+    /** Array of feature flags to enable. */
     flags?: string[] | undefined;
   }
   /** A linting result. */
@@ -2972,9 +3006,11 @@ type UserConfigItem = Awaitable<TypedFlatConfigItem$1 | TypedFlatConfigItem$1[]
 //#endregion
 //#region src/factory.d.ts
 declare function icebreaker(options?: UserDefinedOptions, ...userConfigs: UserConfigItem[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
+type IcebreakerEslintConfig = ReturnType<typeof icebreaker>;
 declare function icebreakerLegacy(options?: UserDefinedOptions, ...userConfigs: UserConfigItem[]): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>;
+type IcebreakerLegacyEslintConfig = ReturnType<typeof icebreakerLegacy>;
 //#endregion
 //#region src/preset.d.ts
 declare function getPresets(options?: UserDefinedOptions, mode?: 'legacy'): [UserDefinedOptions, ...UserConfigItem[]];
 //#endregion
-export { type ConfigNames, type FlatConfigComposer, type StylelintBridgeConfig, type StylelintBridgeOption, type TailwindcssConfig, type TailwindcssOption, type TypedFlatConfigItem, type UserConfigItem, type UserDefinedOptions, getPresets, icebreaker, icebreakerLegacy };
+export { type ConfigNames, type FlatConfigComposer, IcebreakerEslintConfig, IcebreakerLegacyEslintConfig, type StylelintBridgeConfig, type StylelintBridgeOption, type TailwindcssConfig, type TailwindcssOption, type TypedFlatConfigItem, type UserConfigItem, type UserDefinedOptions, getPresets, icebreaker, icebreakerLegacy };

package/index.d.ts

@@ -46,11 +46,17 @@ export declare function icebreaker(
   ...userConfigs: UserConfigItem[]
 ): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>
 
+export type IcebreakerEslintConfig = ReturnType<typeof icebreaker>
+
 export declare function icebreakerLegacy(
   options?: UserDefinedOptions,
   ...userConfigs: UserConfigItem[]
 ): FlatConfigComposer<TypedFlatConfigItem, ConfigNames>
 
+export type IcebreakerLegacyEslintConfig = ReturnType<
+  typeof icebreakerLegacy
+>
+
 export type {
   ConfigNames,
   FlatConfigComposer,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@icebreakers/eslint-config",
   "type": "module",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "ESLint preset from Icebreaker's dev-configs",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -58,8 +58,8 @@
     "eslint-plugin-react-refresh": "^0.5.2",
     "eslint-plugin-tailwindcss": "3.18.2",
     "eslint-plugin-vuejs-accessibility": "^2.5.0",
-    "@icebreakers/stylelint-config": "2.1.0",
-    "eslint-plugin-better-stylelint": "0.1.1"
+    "eslint-plugin-better-stylelint": "0.1.1",
+    "@icebreakers/stylelint-config": "2.1.1"
   },
   "optionalDependencies": {
     "@unocss/eslint-plugin": "66.6.7",