eslint-plugin-etc-misc 1.1.6 → 1.1.7

package/docs/docusaurus/docusaurus.config.ts

@@ -1,9 +1,9 @@
-import { themes as prismThemes } from "prism-react-renderer";
-
-import type { Config } from "@docusaurus/types";
 import type { Options as DocsPluginOptions } from "@docusaurus/plugin-content-docs";
 import type * as Preset from "@docusaurus/preset-classic";
+import type { Config } from "@docusaurus/types";
+
 import { fileURLToPath } from "node:url";
+import { themes as prismThemes } from "prism-react-renderer";
 
 /** Canonical site origin used for sitemap/canonical URL generation. */
 const siteUrl =
@@ -44,16 +44,14 @@ const removeHeadAttrFlagKey = [
 
 /** Docusaurus future flags, including optional experimental fast path. */
 const futureConfig = {
-    ...(enableExperimentalFaster
-        ? {
-              experimental_faster: {
-                  mdxCrossCompilerCache: true,
-                  rspackBundler: true,
-                  rspackPersistentCache: true,
-                  ssgWorkerThreads: true,
-              },
-          }
-        : {}),
+    ...(enableExperimentalFaster && {
+        experimental_faster: {
+            mdxCrossCompilerCache: true,
+            rspackBundler: true,
+            rspackPersistentCache: true,
+            ssgWorkerThreads: true,
+        },
+    }),
     v4: {
         [removeHeadAttrFlagKey]: true,
         // NOTE: Enabling cascade layers currently breaks our production CSS output
@@ -68,11 +66,11 @@ const futureConfig = {
 const config = {
     baseUrl,
     baseUrlIssueBanner: true,
+    clientModules: [modernEnhancementsClientModule],
     deploymentBranch: "gh-pages",
     favicon: "img/favicon.ico",
     // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
     future: futureConfig,
-    clientModules: [modernEnhancementsClientModule],
     i18n: {
         defaultLocale: "en",
         locales: ["en"],
@@ -189,9 +187,9 @@ const config = {
                 docs: {
                     breadcrumbs: true,
                     editUrl: `https://github.com/${organizationName}/${projectName}/blob/main/docs/docusaurus/`,
-                    path: "site-docs",
                     includeCurrentVersion: true,
                     onInlineTags: "ignore",
+                    path: "site-docs",
                     routeBasePath: "docs",
                     showLastUpdateAuthor: true,
                     showLastUpdateTime: true,
@@ -233,7 +231,7 @@ const config = {
                 svgr: {
                     svgrConfig: {
                         dimensions: false, // Remove width/height so CSS controls size
-                        expandProps: "start", // Spread props at the start: <svg {...props}>
+                        expandProps: "start", // Spread props at the start: <SVG {...props}>
                         icon: true, // Treat SVGs as icons (scales via viewBox)
                         memo: true, // Wrap component with React.memo
                         native: false, // Produce web React components (not React Native)
@@ -269,12 +267,6 @@ const config = {
             disableSwitch: false,
             respectPrefersColorScheme: true,
         },
-        metadata: [
-            {
-                content: "eslint-plugin-etc-misc",
-                name: "keywords",
-            },
-        ],
         footer: {
             copyright: footerCopyright,
             links: [
@@ -310,12 +302,12 @@ const config = {
                             label: "🔍 ESLint Inspector",
                         },
                         {
-                            to: "/docs/rules/overview",
                             label: "📏 Rule Docs",
+                            to: "/docs/rules/overview",
                         },
                         {
-                            to: "/docs/rules/presets/all",
                             label: "🟣 All Preset",
+                            to: "/docs/rules/presets/all",
                         },
                     ],
                     title: "🚀 Project",
@@ -344,14 +336,20 @@ const config = {
             ],
             logo: {
                 alt: "eslint-plugin-etc-misc logo",
+                height: "auto",
                 href: `https://github.com/${organizationName}/${projectName}`,
                 src: "img/logo_128x128.png",
                 width: "auto",
-                height: "auto",
             },
             style: "dark",
         },
         image: "img/logo.png",
+        metadata: [
+            {
+                content: "eslint-plugin-etc-misc",
+                name: "keywords",
+            },
+        ],
         navbar: {
             items: [
                 {

package/docs/docusaurus/package.json

@@ -74,6 +74,7 @@
         "react-github-btn": "^1.4.0",
         "typed-css-modules": "^0.9.1",
         "typedoc": "^0.28.19",
+        "typedoc-config-nick2bad4u": "^2.0.0",
         "typedoc-docusaurus-theme": "^1.4.2",
         "typedoc-plugin-coverage": "^4.0.3",
         "typedoc-plugin-dt-links": "^2.0.54",

package/docs/docusaurus/sidebars.rules.ts

@@ -1,26 +1,26 @@
+import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
+
 /**
  * @packageDocumentation
  * Dynamic sidebar generation for plugin rule documentation sections.
  */
-import { readFileSync, readdirSync } from "node:fs";
+import { readdirSync, readFileSync } from "node:fs";
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 
-import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
-
-/** Minimal document item shape used by generated rule categories. */
-type SidebarDocItem = {
-    readonly id: string;
-    readonly label?: string;
-    readonly type: "doc";
-};
-
 type RuleCatalogMapEntry = Readonly<{
     catalogId: string;
     docId: string;
     ruleName: string;
 }>;
 
+/** Minimal document item shape used by generated rule categories. */
+interface SidebarDocItem {
+    readonly id: string;
+    readonly label?: string;
+    readonly type: "doc";
+}
+
 /** Directory containing this sidebar module. */
 const sidebarDirectoryPath = dirname(fileURLToPath(import.meta.url));
 /** Directory containing generated rule docs consumed by the sidebar. */
@@ -39,7 +39,7 @@ const sourceRulesDirectoryPath = join(
 );
 
 /** Docs that are part of the rules docs plugin but are not individual rule docs. */
-const nonRuleDocIds = new Set(["overview", "getting-started"]);
+const nonRuleDocIds = new Set(["getting-started", "overview"]);
 
 const ruleCatalogMap = JSON.parse(
     readFileSync(ruleCatalogMapFilePath, "utf8")
@@ -62,7 +62,7 @@ const toRuleId = (fileName: string): string => fileName.slice(0, -3);
 
 /** Convert a markdown path (e.g. `foo/bar.md`) to a Docusaurus doc id. */
 const toDocIdFromRelativePath = (relativePath: string): string =>
-    relativePath.replace(/\\/gu, "/").replace(/\.md$/u, "");
+    relativePath.replaceAll("\\", "/").replace(/\.md$/u, "");
 
 /** Collect markdown doc ids recursively from a docs directory. */
 const collectMarkdownDocIdsRecursively = (
@@ -112,11 +112,9 @@ const allRulesMarkdownDocIds = readdirSync(rulesDocsDirectoryPath, {
     .sort((left, right) => left.localeCompare(right));
 
 /** Sorted markdown doc ids discovered from `docs/rules/**`. */
-const allRulesPluginDocIds = collectMarkdownDocIdsRecursively(
-    rulesDocsDirectoryPath
-)
-    .slice()
-    .sort((left, right) => left.localeCompare(right));
+const allRulesPluginDocIds = [
+    ...collectMarkdownDocIdsRecursively(rulesDocsDirectoryPath),
+].sort((left, right) => left.localeCompare(right));
 const allRulesPluginDocIdSet = new Set(allRulesPluginDocIds);
 
 const hasRulesPluginDocId = (docId: string): boolean =>
@@ -224,15 +222,15 @@ if (guideItems.length > 0) {
         customProps: {
             badge: "guides",
         },
-        type: "category",
+        items: guideItems,
         label: "🧭 Adoption & Rollout",
         link: {
-            type: "generated-index",
-            title: "Adoption & Rollout",
             description:
                 "Shared migration, rollout, and fix-safety guidance for rule adoption.",
+            title: "Adoption & Rollout",
+            type: "generated-index",
         },
-        items: guideItems,
+        type: "category",
     });
 }
 
@@ -293,15 +291,15 @@ if (presetItems.length > 0) {
         customProps: {
             badge: "presets",
         },
-        type: "category",
+        items: presetItems,
         label: "🎛 Presets",
         link: {
-            type: "generated-index",
-            title: "Presets",
             description:
                 "Predefined flat-config preset bundles for different adoption levels.",
+            title: "Presets",
+            type: "generated-index",
         },
-        items: presetItems,
+        type: "category",
     });
 }
 
@@ -337,15 +335,6 @@ const sidebars = {
             customProps: {
                 badge: "rules",
             },
-            type: "category",
-            label: "📏 Rules",
-            link: {
-                type: "generated-index",
-                title: "Rule Reference",
-                slug: "/",
-                description:
-                    "Rule documentation for every eslint-plugin-etc-misc rule.",
-            },
             items: [
                 {
                     className: "sb-cat-rules-core",
@@ -353,15 +342,15 @@ const sidebars = {
                     customProps: {
                         badge: "core",
                     },
-                    type: "category",
+                    items: createRuleItems(coreRuleDocIds),
                     label: "🧱 Core Rules",
                     link: {
-                        type: "generated-index",
-                        title: "Core Rules",
                         description:
                             "General-purpose etc-misc rules for safer and clearer TypeScript code.",
+                        title: "Core Rules",
+                        type: "generated-index",
                     },
-                    items: createRuleItems(coreRuleDocIds),
+                    type: "category",
                 },
                 {
                     className: "sb-cat-rules-typescript",
@@ -369,17 +358,26 @@ const sidebars = {
                     customProps: {
                         badge: "typescript",
                     },
-                    type: "category",
+                    items: createRuleItems(typeScriptRuleDocIds),
                     label: "🧠 TypeScript Rules",
                     link: {
-                        type: "generated-index",
-                        title: "TypeScript Rules",
                         description:
                             "Rules focused on stronger TypeScript-only constraints and type-level consistency.",
+                        title: "TypeScript Rules",
+                        type: "generated-index",
                     },
-                    items: createRuleItems(typeScriptRuleDocIds),
+                    type: "category",
                 },
             ],
+            label: "📏 Rules",
+            link: {
+                description:
+                    "Rule documentation for every eslint-plugin-etc-misc rule.",
+                slug: "/",
+                title: "Rule Reference",
+                type: "generated-index",
+            },
+            type: "category",
         },
     ],
 } as const satisfies SidebarsConfig;

package/docs/docusaurus/sidebars.ts

@@ -25,7 +25,12 @@ const sidebars = {
             customProps: {
                 badge: "playbooks",
             },
-            type: "category",
+            items: [
+                {
+                    dirName: "guides",
+                    type: "autogenerated",
+                },
+            ],
             label: "🧭 Guides",
             link: {
                 description:
@@ -33,12 +38,7 @@ const sidebars = {
                 title: "Guides",
                 type: "generated-index",
             },
-            items: [
-                {
-                    dirName: "guides",
-                    type: "autogenerated",
-                },
-            ],
+            type: "category",
         },
         {
             className: "sb-cat-architecture",
@@ -46,7 +46,12 @@ const sidebars = {
             customProps: {
                 badge: "adr",
             },
-            type: "category",
+            items: [
+                {
+                    dirName: "architecture/adr",
+                    type: "autogenerated",
+                },
+            ],
             label: "🏗️ Architecture",
             link: {
                 description:
@@ -54,12 +59,7 @@ const sidebars = {
                 title: "Architecture Decisions",
                 type: "generated-index",
             },
-            items: [
-                {
-                    dirName: "architecture/adr",
-                    type: "autogenerated",
-                },
-            ],
+            type: "category",
         },
         {
             className: "sb-cat-developer",
@@ -67,12 +67,6 @@ const sidebars = {
             customProps: {
                 badge: "api",
             },
-            type: "category",
-            label: "🛠 Dev",
-            link: {
-                type: "doc",
-                id: "developer/api/index",
-            },
             items: [
                 {
                     className: "sb-doc-releasing",
@@ -129,6 +123,12 @@ const sidebars = {
                     type: "category",
                 },
             ],
+            label: "🛠 Dev",
+            link: {
+                id: "developer/api/index",
+                type: "doc",
+            },
+            type: "category",
         },
     ],
 } as const satisfies SidebarsConfig;

package/docs/docusaurus/src/components/GitHubStats.jsx

@@ -57,19 +57,19 @@ export default function GitHubStats({ className = "" } = {}) {
     return (
         <ul className={badgeListClassName}>
             {liveBadges.map((badge) => (
-                <li key={badge.src} className={styles.liveBadgeListItem}>
+                <li className={styles.liveBadgeListItem} key={badge.src}>
                     <Link
                         className={styles.liveBadgeAnchor}
                         href={badge.href}
-                        target="_blank"
                         rel="noopener noreferrer"
+                        target="_blank"
                     >
                         <img
                             alt={badge.alt}
                             className={styles.liveBadgeImage}
-                            src={badge.src}
-                            loading="lazy"
                             decoding="async"
+                            loading="lazy"
+                            src={badge.src}
                         />
                     </Link>
                 </li>

package/docs/docusaurus/src/js/modernEnhancements.ts

@@ -7,9 +7,9 @@
 type CleanupFunction = () => void;
 
 /** Mutable holder used to swap active cleanup handlers between route refreshes. */
-type CleanupRef = {
+interface CleanupRef {
     current: CleanupFunction | null;
-};
+}
 
 declare global {
     interface Window {
@@ -21,14 +21,47 @@ declare global {
 const ROUTE_REFRESH_DELAY_MS = 100;
 
 /**
- * Check whether a node is an {@link HTMLElement}.
- *
- * @param element - DOM element candidate.
+ * Apply a subtle animation to the theme toggle control.
  *
- * @returns `true` when element is an `HTMLElement` instance.
+ * @returns Cleanup callback that removes click listeners and pending timers.
  */
-function isHTMLElement(element: Element | null): element is HTMLElement {
-    return element instanceof HTMLElement;
+function applyThemeToggleAnimation(): CleanupFunction {
+    const themeToggle = document.querySelector(
+        '[aria-label*="color mode"], [title*="Switch"]'
+    );
+
+    if (!isHTMLElement(themeToggle)) {
+        return (): void => {
+            // No-op when theme toggle is not present.
+        };
+    }
+
+    let animationTimer: null | ReturnType<typeof setTimeout> = null;
+
+    const handleClick = (): void => {
+        themeToggle.style.transform = "scale(0.94)";
+        themeToggle.style.transition = "transform 120ms ease";
+
+        if (animationTimer) {
+            clearTimeout(animationTimer);
+        }
+
+        animationTimer = setTimeout(() => {
+            themeToggle.style.transform = "scale(1)";
+            animationTimer = null;
+        }, 90);
+    };
+
+    themeToggle.addEventListener("click", handleClick);
+
+    return (): void => {
+        if (animationTimer) {
+            clearTimeout(animationTimer);
+            animationTimer = null;
+        }
+
+        themeToggle.removeEventListener("click", handleClick);
+    };
 }
 
 /**
@@ -72,57 +105,13 @@ function createScrollIndicator(): CleanupFunction {
     };
 }
 
-/**
- * Apply a subtle animation to the theme toggle control.
- *
- * @returns Cleanup callback that removes click listeners and pending timers.
- */
-function applyThemeToggleAnimation(): CleanupFunction {
-    const themeToggle = document.querySelector(
-        '[aria-label*="color mode"], [title*="Switch"]'
-    );
-
-    if (!isHTMLElement(themeToggle)) {
-        return (): void => {
-            // No-op when theme toggle is not present.
-        };
-    }
-
-    let animationTimer: null | ReturnType<typeof setTimeout> = null;
-
-    const handleClick = (): void => {
-        themeToggle.style.transform = "scale(0.94)";
-        themeToggle.style.transition = "transform 120ms ease";
-
-        if (animationTimer) {
-            clearTimeout(animationTimer);
-        }
-
-        animationTimer = setTimeout(() => {
-            themeToggle.style.transform = "scale(1)";
-            animationTimer = null;
-        }, 90);
-    };
-
-    themeToggle.addEventListener("click", handleClick);
-
-    return (): void => {
-        if (animationTimer) {
-            clearTimeout(animationTimer);
-            animationTimer = null;
-        }
-
-        themeToggle.removeEventListener("click", handleClick);
-    };
-}
-
 /**
  * Initialize modern interaction features and return cleanup hooks.
  *
  * @returns Cleanup callback for all registered enhancement handlers.
  */
 function initializeAdvancedFeatures(): CleanupFunction {
-    const prefersReducedMotion = window.matchMedia(
+    const prefersReducedMotion = globalThis.matchMedia(
         "(prefers-reduced-motion: reduce)"
     ).matches;
     const cleanupFunctions: CleanupFunction[] = [];
@@ -134,9 +123,9 @@ function initializeAdvancedFeatures(): CleanupFunction {
     }
 
     return (): void => {
-        cleanupFunctions.forEach((cleanup) => {
+        for (const cleanup of cleanupFunctions) {
             cleanup();
-        });
+        }
     };
 }
 
@@ -210,6 +199,17 @@ function initializeEnhancements(): CleanupFunction {
     };
 }
 
+/**
+ * Check whether a node is an {@link HTMLElement}.
+ *
+ * @param element - DOM element candidate.
+ *
+ * @returns `true` when element is an `HTMLElement` instance.
+ */
+function isHTMLElement(element: Element | null): element is HTMLElement {
+    return element instanceof HTMLElement;
+}
+
 if (typeof window !== "undefined" && typeof document !== "undefined") {
     initializeEnhancements();
     window.initializeAdvancedFeatures = initializeAdvancedFeatures;

package/docs/docusaurus/src/pages/index.jsx

@@ -1,9 +1,9 @@
 import Link from "@docusaurus/Link";
 import useBaseUrl from "@docusaurus/useBaseUrl";
-import Layout from "@theme/Layout";
 import Heading from "@theme/Heading";
-import GitHubStats from "../components/GitHubStats";
+import Layout from "@theme/Layout";
 
+import GitHubStats from "../components/GitHubStats";
 import styles from "./index.module.css";
 
 const heroBadges = [
@@ -47,24 +47,24 @@ const heroStats = [
 
 const homeCards = [
     {
-        icon: "\uf135",
-        title: "Get Started",
         description:
             "Install the plugin, enable a preset, and start enforcing consistent TypeScript-first conventions.",
+        icon: "\u{F135}",
+        title: "Get Started",
         to: "/docs/rules/getting-started",
     },
     {
-        icon: "\uf14e",
-        title: "Presets",
         description:
             "Choose between the focused recommended preset and the complete all-rules preset.",
+        icon: "\u{F14E}",
+        title: "Presets",
         to: "/docs/rules/presets/all",
     },
     {
-        icon: "\uf02d",
-        title: "Rule Reference",
         description:
             "Browse every rule with concrete incorrect/correct examples and migration guidance.",
+        icon: "\u{F02D}",
+        title: "Rule Reference",
         to: "/docs/rules",
     },
 ];
@@ -79,8 +79,8 @@ export default function Home() {
 
     return (
         <Layout
-            title="eslint-plugin-etc-misc docs"
             description="Documentation for eslint-plugin-etc-misc"
+            title="eslint-plugin-etc-misc docs"
         >
             <header className={styles.heroBanner}>
                 <div className={`container ${styles.heroContent}`}>
@@ -102,8 +102,8 @@ export default function Home() {
                             <div className={styles.heroBadgeRow}>
                                 {heroBadges.map((badge) => (
                                     <article
-                                        key={badge.label}
                                         className={styles.heroBadge}
+                                        key={badge.label}
                                     >
                                         <p className={styles.heroBadgeLabel}>
                                             <span
@@ -159,8 +159,8 @@ export default function Home() {
                     <div className={styles.heroStats}>
                         {heroStats.map((stat) => (
                             <article
-                                key={stat.headline}
                                 className={styles.heroStatCard}
+                                key={stat.headline}
                             >
                                 <p className={styles.heroStatHeading}>
                                     {stat.headline}
@@ -178,7 +178,7 @@ export default function Home() {
                 <section className="container">
                     <div className={styles.cardGrid}>
                         {homeCards.map((card) => (
-                            <article key={card.title} className={styles.card}>
+                            <article className={styles.card} key={card.title}>
                                 <div className={styles.cardHeader}>
                                     <p className={styles.cardIcon}>
                                         {card.icon}

package/docs/docusaurus/typedoc-plugins/hashToBangLinksCore.d.mts

@@ -3,7 +3,8 @@
  */
 
 /**
- * Rewrites `module#Export` to `module!Export` for module-source-like references.
+ * Rewrites `module#Export` to `module!Export` for module-source-like
+ * references.
  *
  * @param inlineTagText - The inline-tag payload stored by TypeDoc.
  */
@@ -24,7 +25,8 @@ export declare function convertHashLinksToBangLinksInComment(
 /**
  * Mutates an array of TypeDoc comment display parts in-place.
  *
- * @param parts - Display parts collection whose inline-tag text may be rewritten.
+ * @param parts - Display parts collection whose inline-tag text may be
+ *   rewritten.
  */
 export declare function convertHashLinksToBangLinksInParts(
     parts: Array<Record<string, unknown>>