@luxass/eslint-config 4.10.0 → 4.10.2

package/README.md

@@ -88,9 +88,6 @@ Install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=d
 ```jsonc
 // .vscode/settings.json
 {
-  // will ensure that eslint can use the experimental flat config
-  "eslint.experimental.useFlatConfig": true,
-
   // disable the default formatter
   "prettier.enable": false,
   "editor.formatOnSave": false,
@@ -103,15 +100,16 @@ Install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=d
 
   // silent the stylistic rules in you IDE, but still auto fix them
   "eslint.rules.customizations": [
-    { "rule": "style/*", "severity": "off" },
-    { "rule": "*-indent", "severity": "off" },
-    { "rule": "*-spacing", "severity": "off" },
-    { "rule": "*-spaces", "severity": "off" },
-    { "rule": "*-order", "severity": "off" },
-    { "rule": "*-dangle", "severity": "off" },
-    { "rule": "*-newline", "severity": "off" },
-    { "rule": "*quotes", "severity": "off" },
-    { "rule": "*semi", "severity": "off" }
+    { "rule": "style/*", "severity": "off", "fixable": true },
+    { "rule": "format/*", "severity": "off", "fixable": true },
+    { "rule": "*-indent", "severity": "off", "fixable": true },
+    { "rule": "*-spacing", "severity": "off", "fixable": true },
+    { "rule": "*-spaces", "severity": "off", "fixable": true },
+    { "rule": "*-order", "severity": "off", "fixable": true },
+    { "rule": "*-dangle", "severity": "off", "fixable": true },
+    { "rule": "*-newline", "severity": "off", "fixable": true },
+    { "rule": "*quotes", "severity": "off", "fixable": true },
+    { "rule": "*semi", "severity": "off", "fixable": true }
   ],
 
   // The following is optional.
@@ -134,6 +132,9 @@ Install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=d
     "graphql",
     "astro",
     "css",
+    "less",
+    "scss",
+    "pcss",
     "postcss"
   ]
 }

package/dist/index.d.cts

@@ -14119,14 +14119,14 @@ declare function combine(...configs: Awaitable<TypedFlatConfigItem | TypedFlatCo
  *
  * @example
  * ```ts
- * import { renameRules } from '@luxass/eslint-config'
+ * import { renameRules } from "@luxass/eslint-config";
  *
  * export default [{
  *   rules: renameRules(
  *     {
- *       '@typescript-eslint/indent': 'error'
+ *       "@typescript-eslint/indent": "error"
  *     },
- *     { '@typescript-eslint': 'ts' }
+ *     { "@typescript-eslint": "ts" }
  *   )
  * }]
  * ```
@@ -14137,23 +14137,111 @@ declare function renameRules(rules: Record<string, any>, map: Record<string, str
  *
  * @example
  * ```ts
- * import { renamePluginInConfigs } from '@antfu/eslint-config'
- * import someConfigs from './some-configs'
+ * import { renamePluginInConfigs } from "@luxass/eslint-config";
+ * import someConfigs from "./some-configs";
  *
  * export default renamePluginInConfigs(someConfigs, {
- *   '@typescript-eslint': 'ts',
- *   'import-x': 'import',
+ *   "@typescript-eslint": "ts",
+ *   "import-x": "import",
  * })
  * ```
  */
 declare function renamePluginInConfigs(configs: TypedFlatConfigItem[], map: Record<string, string>): TypedFlatConfigItem[];
+/**
+ * Convert a value to an array.
+ * If the value is an array, return it as is.
+ * Otherwise, return the value as the only element in an array.
+ *
+ * @param {T | T[]} value - Value to convert to an array.
+ * @returns {T[]} - The value as an array.
+ *
+ * @example
+ * ```ts
+ * import { toArray } from "@luxass/eslint-config";
+ *
+ * toArray("foo") // ["foo"]
+ * toArray(["foo"]) // ["foo"]
+ * ```
+ */
 declare function toArray<T>(value: T | T[]): T[];
+/**
+ * Import a module and return the default export.
+ * If the module does not have a default export, return the module itself.
+ *
+ * @param {Promise<T>} m - Module to import.
+ * @returns {Promise<T extends { default: infer U } ? U : T>} - The default export or the module itself.
+ * @template T
+ *
+ * @example
+ * ```ts
+ * import { interop } from "@luxass/eslint-config";
+ *
+ * const module = await interop(import("module"));
+ * ```
+ */
 declare function interop<T>(m: Awaitable<T>): Promise<T extends {
     default: infer U;
 } ? U : T>;
+/**
+ * Ensure that packages are installed.
+ * If the packages are not installed, prompt the user to install them.
+ *
+ * @param {string[]} packages - Packages to ensure are installed.
+ * @returns {Promise<void>} - A promise that resolves when the packages are installed.
+ *
+ * @example
+ * ```ts
+ * import { ensure } from "@luxass/eslint-config";
+ *
+ * await ensure(["eslint-plugin-jsdoc"]);
+ * ```
+ */
 declare function ensure(packages: (string | undefined)[]): Promise<void>;
 type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+/**
+ * Resolve sub-options from a config options object.
+ *
+ * @param {ConfigOptions} options - The config options object.
+ * @template K - The key of the sub-options to resolve.
+ * @param {K} key - The key of the sub-options to resolve.
+ * @returns {ResolvedOptions<ConfigOptions[K]>} - The resolved sub-options.
+ *
+ * @example
+ * ```ts
+ * import { resolveSubOptions } from "@luxass/eslint-config";
+ *
+ * const options = {
+ *   foo: {
+ *     bar: true,
+ *   },
+ * };
+ *
+ * const subOptions = resolveSubOptions(options, "foo");
+ * ```
+ */
 declare function resolveSubOptions<K extends keyof ConfigOptions>(options: ConfigOptions, key: K): ResolvedOptions<ConfigOptions[K]>;
+/**
+ * Get overrides from a config options object.
+ * @param {ConfigOptions} options The config options object.
+ * @template K The key of the sub-options to resolve.
+ * @param {K} key The key of the sub-options to resolve.
+ * @returns {Partial<Linter.RulesRecord & RuleOptions>} The overrides.
+ *
+ * @example
+ * ```ts
+ * import { getOverrides } from "@luxass/eslint-config";
+ *
+ * const options = {
+ *   overrides: {
+ *     rules: {
+ *       "no-console": "off",
+ *     },
+ *   },
+ * };
+ *
+ * const overrides = getOverrides(options, "overrides");
+ * ```
+ */
 declare function getOverrides<K extends keyof ConfigOptions>(options: ConfigOptions, key: K): Partial<Linter.RulesRecord & RuleOptions>;
 
 export { type AstroOptions, type Awaitable, type ConfigNames, type ConfigOptions, type FormattersOptions, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_EXCLUDE, GLOB_GRAPHQL, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_NEXTJS_OG, GLOB_NEXTJS_ROUTES, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type ImportsOptions, type JSDOCOptions, type JSONOptions, type JavaScriptOptions, type MarkdownOptions, type ProjectType, type ReactOptions, type RegExpOptions, type ResolvedOptions, type Rules, type StylisticConfig, type StylisticOptions, type TOMLOptions, type TailwindCSSOptions, type TestOptions, type TypeScriptOptions, type TypedFlatConfigItem, type UnoCSSOptions, type UserConfigItem, type VueOptions, type YAMLOptions, astro, combine, comments, luxass as default, ensure, formatters, getOverrides, ignores, imports, interop, javascript, jsdoc, jsonc, jsx, luxass, markdown, node, parserPlain, react, regexp, renamePluginInConfigs, renameRules, resolveSubOptions, sortPackageJson, sortTsconfig, stylistic, tailwindcss, test, toArray, toml, typescript, unicorn, unocss, vue, yaml };

package/dist/index.d.ts

@@ -14119,14 +14119,14 @@ declare function combine(...configs: Awaitable<TypedFlatConfigItem | TypedFlatCo
  *
  * @example
  * ```ts
- * import { renameRules } from '@luxass/eslint-config'
+ * import { renameRules } from "@luxass/eslint-config";
  *
  * export default [{
  *   rules: renameRules(
  *     {
- *       '@typescript-eslint/indent': 'error'
+ *       "@typescript-eslint/indent": "error"
  *     },
- *     { '@typescript-eslint': 'ts' }
+ *     { "@typescript-eslint": "ts" }
  *   )
  * }]
  * ```
@@ -14137,23 +14137,111 @@ declare function renameRules(rules: Record<string, any>, map: Record<string, str
  *
  * @example
  * ```ts
- * import { renamePluginInConfigs } from '@antfu/eslint-config'
- * import someConfigs from './some-configs'
+ * import { renamePluginInConfigs } from "@luxass/eslint-config";
+ * import someConfigs from "./some-configs";
  *
  * export default renamePluginInConfigs(someConfigs, {
- *   '@typescript-eslint': 'ts',
- *   'import-x': 'import',
+ *   "@typescript-eslint": "ts",
+ *   "import-x": "import",
  * })
  * ```
  */
 declare function renamePluginInConfigs(configs: TypedFlatConfigItem[], map: Record<string, string>): TypedFlatConfigItem[];
+/**
+ * Convert a value to an array.
+ * If the value is an array, return it as is.
+ * Otherwise, return the value as the only element in an array.
+ *
+ * @param {T | T[]} value - Value to convert to an array.
+ * @returns {T[]} - The value as an array.
+ *
+ * @example
+ * ```ts
+ * import { toArray } from "@luxass/eslint-config";
+ *
+ * toArray("foo") // ["foo"]
+ * toArray(["foo"]) // ["foo"]
+ * ```
+ */
 declare function toArray<T>(value: T | T[]): T[];
+/**
+ * Import a module and return the default export.
+ * If the module does not have a default export, return the module itself.
+ *
+ * @param {Promise<T>} m - Module to import.
+ * @returns {Promise<T extends { default: infer U } ? U : T>} - The default export or the module itself.
+ * @template T
+ *
+ * @example
+ * ```ts
+ * import { interop } from "@luxass/eslint-config";
+ *
+ * const module = await interop(import("module"));
+ * ```
+ */
 declare function interop<T>(m: Awaitable<T>): Promise<T extends {
     default: infer U;
 } ? U : T>;
+/**
+ * Ensure that packages are installed.
+ * If the packages are not installed, prompt the user to install them.
+ *
+ * @param {string[]} packages - Packages to ensure are installed.
+ * @returns {Promise<void>} - A promise that resolves when the packages are installed.
+ *
+ * @example
+ * ```ts
+ * import { ensure } from "@luxass/eslint-config";
+ *
+ * await ensure(["eslint-plugin-jsdoc"]);
+ * ```
+ */
 declare function ensure(packages: (string | undefined)[]): Promise<void>;
 type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
+/**
+ * Resolve sub-options from a config options object.
+ *
+ * @param {ConfigOptions} options - The config options object.
+ * @template K - The key of the sub-options to resolve.
+ * @param {K} key - The key of the sub-options to resolve.
+ * @returns {ResolvedOptions<ConfigOptions[K]>} - The resolved sub-options.
+ *
+ * @example
+ * ```ts
+ * import { resolveSubOptions } from "@luxass/eslint-config";
+ *
+ * const options = {
+ *   foo: {
+ *     bar: true,
+ *   },
+ * };
+ *
+ * const subOptions = resolveSubOptions(options, "foo");
+ * ```
+ */
 declare function resolveSubOptions<K extends keyof ConfigOptions>(options: ConfigOptions, key: K): ResolvedOptions<ConfigOptions[K]>;
+/**
+ * Get overrides from a config options object.
+ * @param {ConfigOptions} options The config options object.
+ * @template K The key of the sub-options to resolve.
+ * @param {K} key The key of the sub-options to resolve.
+ * @returns {Partial<Linter.RulesRecord & RuleOptions>} The overrides.
+ *
+ * @example
+ * ```ts
+ * import { getOverrides } from "@luxass/eslint-config";
+ *
+ * const options = {
+ *   overrides: {
+ *     rules: {
+ *       "no-console": "off",
+ *     },
+ *   },
+ * };
+ *
+ * const overrides = getOverrides(options, "overrides");
+ * ```
+ */
 declare function getOverrides<K extends keyof ConfigOptions>(options: ConfigOptions, key: K): Partial<Linter.RulesRecord & RuleOptions>;
 
 export { type AstroOptions, type Awaitable, type ConfigNames, type ConfigOptions, type FormattersOptions, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_EXCLUDE, GLOB_GRAPHQL, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_NEXTJS_OG, GLOB_NEXTJS_ROUTES, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_SVELTE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_VUE, GLOB_YAML, type ImportsOptions, type JSDOCOptions, type JSONOptions, type JavaScriptOptions, type MarkdownOptions, type ProjectType, type ReactOptions, type RegExpOptions, type ResolvedOptions, type Rules, type StylisticConfig, type StylisticOptions, type TOMLOptions, type TailwindCSSOptions, type TestOptions, type TypeScriptOptions, type TypedFlatConfigItem, type UnoCSSOptions, type UserConfigItem, type VueOptions, type YAMLOptions, astro, combine, comments, luxass as default, ensure, formatters, getOverrides, ignores, imports, interop, javascript, jsdoc, jsonc, jsx, luxass, markdown, node, parserPlain, react, regexp, renamePluginInConfigs, renameRules, resolveSubOptions, sortPackageJson, sortTsconfig, stylistic, tailwindcss, test, toArray, toml, typescript, unicorn, unocss, vue, yaml };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luxass/eslint-config",
-  "version": "4.10.0",
+  "version": "4.10.2",
   "description": "ESLint config for @luxass",
   "type": "module",
   "author": {
@@ -12,7 +12,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/luxass/eslint-config.git"
+    "url": "git+https://github.com/luxass/eslint-config.git"
   },
   "keywords": [
     "eslint",