@gesslar/uglier 2.3.1 → 2.4.0

package/package.json

@@ -5,7 +5,7 @@
     "name": "gesslar",
     "url": "https://gesslar.dev"
   },
-  "version": "2.3.1",
+  "version": "2.4.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gesslar/uglier.git"
@@ -61,11 +61,12 @@
     "@gesslar/toolkit": ">=4.4.0",
     "@skarab/detect-package-manager": ">=1.0.0",
     "@stylistic/eslint-plugin": "^5.10.0",
+    "eslint-plugin-astro": "^1.6.0",
     "eslint-plugin-jsdoc": ">=62.8.1",
     "globals": ">=17.4.0"
   },
   "devDependencies": {
-    "@gesslar/uglier": ">=2.2.0",
+    "@gesslar/uglier": ">=2.3.1",
     "eslint": ">=10.1.0",
     "typescript": "^6.0.2"
   }

package/src/types/uglier.d.ts

@@ -14,7 +14,7 @@ export const availableConfigs: Array<ConfigName>;
 /**
  * Available config block names
  */
-export type ConfigName = "lints-js" | "lints-jsdoc" | "languageOptions" | "web" | "node" | "react" | "tauri" | "vscode-extension" | "cjs-override" | "mjs-override";
+export type ConfigName = "lints-js" | "lints-jsdoc" | "languageOptions" | "web" | "node" | "react" | "docusaurus" | "starlight" | "tauri" | "vscode-extension" | "cjs-override" | "mjs-override";
 /**
  * ESLint rule severity or configuration
  */
@@ -128,6 +128,8 @@ export type PerConfigOptions = {
     web?: EnvironmentOptions;
     node?: EnvironmentOptions;
     react?: EnvironmentOptions;
+    docusaurus?: EnvironmentOptions;
+    starlight?: EnvironmentOptions;
     tauri?: EnvironmentOptions;
     "vscode-extension"?: EnvironmentOptions;
     "cjs-override"?: ModuleOverrideOptions;
@@ -161,7 +163,7 @@ export type FlatConfig = {
     /**
      * - Glob patterns for files this config applies to
      */
-    files?: Array<string>;
+    files?: Array<string | string[]>;
     /**
      * - Glob patterns for files to ignore
      */

package/src/uglier.js

@@ -77,7 +77,7 @@
 /**
  * Available config block names
  *
- * @typedef {"lints-js" | "lints-jsdoc" | "languageOptions" | "web" | "node" | "react" | "tauri" | "vscode-extension" | "cjs-override" | "mjs-override"} ConfigName
+ * @typedef {"lints-js" | "lints-jsdoc" | "languageOptions" | "web" | "node" | "react" | "docusaurus" | "starlight" | "tauri" | "vscode-extension" | "cjs-override" | "mjs-override"} ConfigName
  */
 
 /**
@@ -141,7 +141,7 @@
 /**
  * Per-config options map
  *
- * @typedef {{"lints-js"?: LintsJsOptions, "lints-jsdoc"?: LintsJsdocOptions, languageOptions?: LanguageOptionsOptions, web?: EnvironmentOptions, node?: EnvironmentOptions, react?: EnvironmentOptions, tauri?: EnvironmentOptions, "vscode-extension"?: EnvironmentOptions, "cjs-override"?: ModuleOverrideOptions, "mjs-override"?: ModuleOverrideOptions}} PerConfigOptions
+ * @typedef {{"lints-js"?: LintsJsOptions, "lints-jsdoc"?: LintsJsdocOptions, languageOptions?: LanguageOptionsOptions, web?: EnvironmentOptions, node?: EnvironmentOptions, react?: EnvironmentOptions, docusaurus?: EnvironmentOptions, starlight?: EnvironmentOptions, tauri?: EnvironmentOptions, "vscode-extension"?: EnvironmentOptions, "cjs-override"?: ModuleOverrideOptions, "mjs-override"?: ModuleOverrideOptions}} PerConfigOptions
  */
 
 /**
@@ -158,7 +158,7 @@
  *
  * @typedef {object} FlatConfig
  * @property {string} [name] - Config name for debugging
- * @property {Array<string>} [files] - Glob patterns for files this config applies to
+ * @property {Array<string | string[]>} [files] - Glob patterns for files this config applies to
  * @property {Array<string>} [ignores] - Glob patterns for files to ignore
  * @property {{[pluginName: string]: object}} [plugins] - ESLint plugins
  * @property {{[ruleName: string]: RuleEntry}} [rules] - ESLint rules
@@ -167,6 +167,7 @@
  */
 
 import jsdoc from "eslint-plugin-jsdoc"
+import astro from "eslint-plugin-astro"
 import stylistic from "@stylistic/eslint-plugin"
 import globals from "globals"
 
@@ -174,7 +175,7 @@ import globals from "globals"
  * Registry of named configuration blocks.
  * Each config is a factory function that returns an ESLint flat config object.
  *
- * @type {{[K in ConfigName]: (options?: object) => FlatConfig}}
+ * @type {{[K in ConfigName]: (options?: object) => FlatConfig | Array<FlatConfig>}}
  */
 const CONFIGS = {
   /**
@@ -512,6 +513,63 @@ const CONFIGS = {
     }
   },
 
+  /**
+   * Docusaurus documentation site globals (browser + React + Docusaurus)
+   *
+   * @param {EnvironmentOptions} options - Configuration options
+   * @returns {FlatConfig} ESLint flat config object
+   */
+  "docusaurus": (options = {}) => {
+    const {
+      files = ["src/**/*.{js,jsx,mjs,cjs}", "docs/**/*.{js,jsx,mjs,cjs}"],
+      ignores = [],
+      additionalGlobals = {},
+    } = options
+
+    return {
+      name: "gesslar/uglier/docusaurus",
+      files: Array.isArray(files) ? files : [files],
+      ignores: Array.isArray(ignores) ? ignores : [ignores],
+      languageOptions: {
+        globals: {
+          ...globals.browser,
+          React: "readonly",
+          ReactDOM: "readonly",
+          ...additionalGlobals,
+        }
+      }
+    }
+  },
+
+  /**
+   * Starlight documentation site (browser + Astro + eslint-plugin-astro)
+   *
+   * @param {EnvironmentOptions} options - Configuration options
+   * @returns {Array<FlatConfig>} ESLint flat config array
+   */
+  "starlight": (options = {}) => {
+    const {
+      files = ["src/**/*.{js,mjs,cjs}", "docs/**/*.{js,mjs,cjs}"],
+      ignores = [],
+      additionalGlobals = {},
+    } = options
+
+    return [
+      ...astro.configs["flat/recommended"],
+      {
+        name: "gesslar/uglier/starlight",
+        files: Array.isArray(files) ? files : [files],
+        ignores: Array.isArray(ignores) ? ignores : [ignores],
+        languageOptions: {
+          globals: {
+            ...globals.browser,
+            ...additionalGlobals,
+          }
+        }
+      },
+    ]
+  },
+
   /**
    * Tauri application configuration (browser + Tauri APIs, no Node.js)
    *
@@ -570,7 +628,10 @@ export default function(options = {}) {
     const configOptions = perConfigOptions[configName] || {}
     const config = CONFIGS[configName](configOptions)
 
-    configs.push(config)
+    if(Array.isArray(config))
+      configs.push(...config)
+    else
+      configs.push(config)
   }
 
   return configs