@nekoyasuii/config 0.1.2 → 0.1.4

package/dist/tools/oxlint/config/js-plugins/index.d.ts

@@ -1,3 +1,42 @@
+/**
+ * eslint-plugin-github, eslint-plugin-sonarjs, and
+ * oxlint-plugin-react-doctor run through oxlint's JS plugin support to close
+ * the gap with the ESLint preset and to add React Doctor's extra checks
+ *
+ * This preset is opt-in: extend it alongside core (and any framework preset)
+ * only when you want those rules and accept the extra dependencies plus the
+ * slower JS-plugin lint pass. Rules that require type information are not
+ * supported by the JS plugin bridge and are excluded
+ *
+ * The react-doctor rules were previously bundled into the react/next/
+ * tanstack presets; they live here now so those framework presets run
+ * entirely on oxlint's native Rust rules. Framework-specific react-doctor
+ * rules (Next.js, TanStack) are NOT included here, since they fire on generic
+ * JSX and would false-positive in other frameworks
+ *
+ * For Next.js or TanStack, extend ultracite/oxlint/next/js-plugins or
+ * ultracite/oxlint/tanstack/js-plugins alongside this preset
+ *
+ * @example
+ * npm install -D eslint-plugin-github eslint-plugin-sonarjs oxlint-plugin-react-doctor
+ * import { defineConfig } from "oxlint";
+ * import core from "ultracite/oxlint/core";
+ * import jsPlugins, { jsPluginSettings } from "ultracite/oxlint/js-plugins";
+ * export default defineConfig({
+ *   extends: [core, jsPlugins],
+ *   ignorePatterns: core.ignorePatterns,
+ *   jsPlugins: jsPlugins.jsPlugins,
+ *   settings: jsPluginSettings,
+ * });
+ *
+ * `jsPlugins: jsPlugins.jsPlugins` re-declares the plugin packages on the
+ * root config: oxlint loads them from the extended preset either way, but
+ * dependency analyzers such as Knip only read `jsPlugins` off the root and
+ * would otherwise flag the packages as unused (#784)
+ *
+ * To enable only some of the plugins, extend selectJsPlugins(...) instead of
+ * the full preset, and see its doc comment below
+ */
 declare const jsPluginEntries: readonly [{
     readonly name: "github";
     readonly specifier: "eslint-plugin-github";
@@ -15,6 +54,25 @@ declare const jsPluginEntries: readonly [{
     readonly specifier: string;
 }];
 type JSPluginName = (typeof jsPluginEntries)[number]["name"];
+/**
+ * react-doctor 0.9.x rewrote its ported oxc/react-refresh rules (notably
+ * only-export-components) with a stripped-down default mode: no framework
+ * detection, no route-file skipping, and allowConstantExport off, so Next.js
+ * route-segment exports (`export const dynamic = ...`, metadata, etc.)
+ * false-positive in every route file (#771). "curated" restores the
+ * framework-aware behavior these rule selections were curated against.
+ *
+ * oxlint does not merge `settings` from extended configs, so this preset
+ * carrying the settings is not enough, so they must land on the root config:
+ *
+ * export default defineConfig({
+ * extends: [core, jsPlugins],
+ * ignorePatterns: core.ignorePatterns,
+ * settings: jsPluginSettings,
+ * });
+ *
+ * `ultracite init` wires this into generated configs automatically.
+ */
 export declare const jsPluginSettings: {
     "react-doctor": {
         portedRuleMode: string;
@@ -25,18 +83,54 @@ declare const config: {
         name: string;
         specifier: string;
     }[];
+    /**
+     * Inert until oxlint merges settings from extends; the root config applies
+     * jsPluginSettings itself (see above)
+     */
     settings: {
         "react-doctor": {
             portedRuleMode: string;
         };
     };
-    overrides: {
+    overrides: ({
         files: string[];
         rules: {
+            /**
+             * Repeated string literals (test titles, expected values) are normal
+             * and idiomatic in test files
+             */
             "sonarjs/no-duplicate-string": "off";
+            "lazuee/no-ts-accessibility"?: undefined;
+            "lazuee/interface-pascal-case"?: undefined;
+            "lazuee/canonical-header-names"?: undefined;
         };
-    }[];
+    } | {
+        files: string[];
+        rules: {
+            /**
+             * Repeated string literals (test titles, expected values) are normal
+             * and idiomatic in test files
+             */
+            "sonarjs/no-duplicate-string"?: undefined;
+            "lazuee/no-ts-accessibility": "error";
+            "lazuee/interface-pascal-case": "error";
+            "lazuee/canonical-header-names"?: undefined;
+        };
+    } | {
+        files: string[];
+        rules: {
+            /**
+             * Repeated string literals (test titles, expected values) are normal
+             * and idiomatic in test files
+             */
+            "sonarjs/no-duplicate-string"?: undefined;
+            "lazuee/no-ts-accessibility"?: undefined;
+            "lazuee/interface-pascal-case"?: undefined;
+            "lazuee/canonical-header-names": "off";
+        };
+    })[];
     rules: {
+        /** ── github ───────────────────────────────────────────────────────── */
         "github/a11y-aria-label-is-well-formatted": "error";
         "github/a11y-no-title-attribute": "error";
         "github/a11y-no-visually-hidden-interactive-element": "error";
@@ -51,8 +145,13 @@ declare const config: {
         "github/js-class-name": "error";
         "github/no-blur": "error";
         "github/no-d-none": "error";
+        /** Conflicts with unicorn/prefer-dom-node-dataset, which is the benchmark */
         "github/no-dataset": "off";
         "github/no-dynamic-script-tag": "error";
+        /**
+         * The JS plugin bridge misreads module-scoped declarations (e.g. Astro
+         * frontmatter) as implicit globals, producing false positives.
+         */
         "github/no-implicit-buggy-globals": "off";
         "github/no-inner-html": "error";
         "github/no-innerText": "error";
@@ -60,9 +159,11 @@ declare const config: {
         "github/no-useless-passive": "error";
         "github/prefer-observers": "error";
         "github/require-passive-events": "error";
+        /** Mirrors the ESLint preset */
         "github/unescaped-html-literal": "off";
         "sonarjs/arguments-usage": "error";
         "sonarjs/array-constructor": "error";
+        /** Fights the formatter (arrowParentheses: always) */
         "sonarjs/arrow-function-convention": "off";
         "sonarjs/aws-apigateway-public-api": "error";
         "sonarjs/aws-ec2-rds-dms-public": "error";
@@ -88,6 +189,7 @@ declare const config: {
         "sonarjs/chai-determinate-assertion": "error";
         "sonarjs/class-name": "error";
         "sonarjs/code-eval": "error";
+        /** Matches Biome's noExcessiveCognitiveComplexity limit */
         "sonarjs/cognitive-complexity": ["error", number];
         "sonarjs/comma-or-logical-or-case": "error";
         "sonarjs/comment-regex": "error";
@@ -97,15 +199,22 @@ declare const config: {
         "sonarjs/cookie-no-httponly": "error";
         "sonarjs/cors": "error";
         "sonarjs/csrf": "error";
+        /** Duplicate of the core complexity rule */
         "sonarjs/cyclomatic-complexity": "off";
         "sonarjs/declarations-in-global-scope": "error";
         "sonarjs/destructuring-assignment-syntax": "error";
         "sonarjs/disabled-timeout": "error";
         "sonarjs/dynamically-constructed-templates": "error";
+        /** Mirrors the ESLint preset */
         "sonarjs/elseif-without-else": "off";
         "sonarjs/encryption-secure-mode": "error";
         "sonarjs/expression-complexity": "error";
+        /** Requires a headerFormat option; errors on every file without one */
         "sonarjs/file-header": "off";
+        /**
+         * Fires on any file whose name differs from an exported class, which is
+         * noise for config and module files that export objects, not classes
+         */
         "sonarjs/file-name-differ-from-class": "off";
         "sonarjs/file-permissions": "error";
         "sonarjs/file-uploads": "error";
@@ -124,11 +233,14 @@ declare const config: {
         "sonarjs/inverted-assertion-arguments": "error";
         "sonarjs/label-position": "error";
         "sonarjs/link-with-target-blank": "error";
+        /** The preset disables max-lines everywhere */
         "sonarjs/max-lines": "off";
+        /** The preset disables max-lines-per-function everywhere */
         "sonarjs/max-lines-per-function": "off";
         "sonarjs/max-switch-cases": "error";
         "sonarjs/max-union-size": "error";
         "sonarjs/misplaced-loop-counter": "error";
+        /** Duplicate of max-depth, which is off */
         "sonarjs/nested-control-flow": "off";
         "sonarjs/no-all-duplicated-branches": "error";
         "sonarjs/no-angular-bypass-sanitization": "error";
@@ -162,6 +274,10 @@ declare const config: {
         "sonarjs/no-identical-expressions": "error";
         "sonarjs/no-identical-functions": "error";
         "sonarjs/no-ignored-exceptions": "error";
+        /**
+         * The JS plugin bridge has no dependency-manifest resolution, so this
+         * flags builtin (bun:test) and workspace imports as missing dependencies
+         */
         "sonarjs/no-implicit-dependencies": "off";
         "sonarjs/no-implicit-global": "error";
         "sonarjs/no-incomplete-assertions": "error";
@@ -183,6 +299,7 @@ declare const config: {
         "sonarjs/no-redundant-assignments": "error";
         "sonarjs/no-redundant-boolean": "error";
         "sonarjs/no-redundant-jump": "error";
+        /** The jsPlugins bridge provides no globals, so every identifier is flagged */
         "sonarjs/no-reference-error": "off";
         "sonarjs/no-referrer-policy": "error";
         "sonarjs/no-same-argument-assert": "error";
@@ -221,6 +338,7 @@ declare const config: {
         "sonarjs/redundant-type-aliases": "error";
         "sonarjs/review-blockchain-mnemonic": "error";
         "sonarjs/session-regeneration": "error";
+        /** Conflicts with sort-keys */
         "sonarjs/shorthand-property-grouping": "off";
         "sonarjs/stable-tests": "error";
         "sonarjs/stateful-regex": "error";
@@ -239,6 +357,7 @@ declare const config: {
         "sonarjs/weak-ssl": "error";
         "sonarjs/x-powered-by": "error";
         "sonarjs/xml-parser-xxe": "error";
+        /** Generic React rules */
         "react-doctor/activity-wraps-effect-heavy-subtree": "error";
         "react-doctor/advanced-event-handler-refs": "error";
         "react-doctor/async-await-in-loop": "error";
@@ -344,6 +463,7 @@ declare const config: {
         "react-doctor/no-uncontrolled-input": "error";
         "react-doctor/no-undeferred-third-party": "error";
         "react-doctor/no-usememo-simple-expression": "error";
+        /** "react-doctor/only-export-components": "error", */
         "react-doctor/prefer-dynamic-import": "error";
         "react-doctor/prefer-explicit-variants": "error";
         "react-doctor/prefer-html-dialog": "error";
@@ -387,6 +507,13 @@ declare const config: {
         "react-doctor/zod-v4-no-deprecated-error-customization": "error";
         "react-doctor/zod-v4-no-deprecated-schema-apis": "error";
         "react-doctor/zod-v4-prefer-top-level-string-formats": "error";
+        /**
+         * Full-ruleset parity adjustments: rules the react-doctor CLI ships
+         * disabled by default (defaultEnabled: false) that only produce noise
+         * when oxlint force-enables every listed rule, and rules the CLI gates
+         * behind framework detection (`nextjs`, `pure-preact`) that this
+         * Bun + Hono + react-router app never satisfies
+         */
         "react-doctor/react-in-jsx-scope": "off";
         "react-doctor/jsx-boolean-value": "off";
         "react-doctor/jsx-handler-names": "off";
@@ -395,24 +522,62 @@ declare const config: {
         "react-doctor/nextjs-no-a-element": "off";
         "react-doctor/nextjs-no-img-element": "off";
         "react-doctor/preact-no-react-hooks-import": "off";
+        /**
+         * Small presentational helpers stay colocated in one file (see
+         * src/components/api-tester.tsx); mirrors `react/no-multi-comp` being off
+         * in the presets
+         */
         "react-doctor/no-multi-comp": "off";
         "react-doctor/no-multi-component-file": "off";
+        /** src/router.tsx exports the router object rather than a component */
         "react-doctor/only-export-components": "off";
+        /**
+         * ── tailwindcss ────────────────────────────────────────────────────
+         * Correctness: catch real bugs
+         */
         "tailwindcss/no-conflicting-classes": "error";
         "tailwindcss/no-deprecated-classes": "error";
         "tailwindcss/no-duplicate-classes": "warn";
         "tailwindcss/no-unknown-classes": "error";
+        /** Modernization: keep classes in current canonical form */
         "tailwindcss/enforce-canonical": "warn";
         "tailwindcss/no-unnecessary-arbitrary-value": "warn";
+        /** Style and consistency */
         "tailwindcss/enforce-sort-order": "warn";
         "tailwindcss/consistent-variant-order": "warn";
         "tailwindcss/enforce-consistent-important-position": "warn";
         "tailwindcss/no-unnecessary-whitespace": "warn";
+        /** ── lazuee ──────────────────────────────────────────────────── */
         "lazuee/prefer-alias": "error";
+        "lazuee/no-ts-accessibility": "off";
+        "lazuee/interface-pascal-case": "off";
+        "lazuee/canonical-header-names": "off";
     };
 };
 export default config;
+/**
+ * Returns a copy of this preset narrowed to the given plugin names ("github",
+ * "sonarjs", "react-doctor"): only the selected jsPlugins entries are loaded
+ * and only their rules (top-level and per-override) are kept. `ultracite init`
+ * wires this into generated configs when a subset of the plugins is chosen,
+ * so the generated file stays a one-line extend instead of inlining the
+ * filtering logic:
+ *
+ * import { selectJsPlugins } from "ultracite/oxlint/js-plugins";
+ *
+ * const jsPlugins = selectJsPlugins(["github", "sonarjs"]);
+ *
+ * export default defineConfig({
+ * extends: [core, jsPlugins],
+ * ignorePatterns: core.ignorePatterns,
+ * jsPlugins: jsPlugins.jsPlugins,
+ * });
+ */
 export declare const selectJsPlugins: (pluginNames: JSPluginName[]) => {
+    /**
+     * Inert until oxlint merges settings from extends; the root config applies
+     * jsPluginSettings itself (see above)
+     */
     settings: {
         "react-doctor": {
             portedRuleMode: string;
@@ -434,12 +599,22 @@ export declare const selectJsPlugins: (pluginNames: JSPluginName[]) => {
         readonly name: "lazuee";
         readonly specifier: string;
     })[];
-    overrides: {
+    overrides: ({
         files: string[];
         rules: {
-            [k: string]: "off";
+            [k: string]: any;
         };
-    }[];
+    } | {
+        files: string[];
+        rules: {
+            [k: string]: any;
+        };
+    } | {
+        files: string[];
+        rules: {
+            [k: string]: any;
+        };
+    })[];
     rules: {
         [k: string]: "error" | "off" | "warn" | ["error", number];
     };

package/dist/tools/oxlint/config/js-plugins/index.js

@@ -2,7 +2,7 @@ import {
   jsPluginSettings,
   js_plugins_default,
   selectJsPlugins
-} from "../../../../chunk-1chg07xf.js";
+} from "../../../../chunk-fqcw0kzp.js";
 import"../../../../chunk-5wgwscd0.js";
 export {
   js_plugins_default as default,

package/dist/tools/oxlint/config/no-comment-slop/index.d.ts

@@ -0,0 +1,19 @@
+export declare const noCommentSlopConfig: {
+    jsPlugins: {
+        name: string;
+        specifier: string;
+    }[];
+    rules: {
+        "no-comment-slop/max-comment-lines": "error";
+        "no-comment-slop/no-banner-comment": "error";
+        "no-comment-slop/no-trailing-comment": "error";
+        "no-comment-slop/prefer-jsdoc-for-exports": "error";
+        "no-comment-slop/prefer-jsdoc-for-members": "error";
+        "no-comment-slop/require-member-docs": "error";
+        "no-comment-slop/multiline-jsdoc-format": "error";
+        "no-comment-slop/no-trailing-period": "error";
+        "no-comment-slop/no-em-dash": "error";
+        "no-comment-slop/no-jargon": "error";
+        "no-comment-slop/no-foreign-syntax": "error";
+    };
+};

package/dist/tools/oxlint/config/no-comment-slop/index.js

@@ -0,0 +1,7 @@
+import {
+  noCommentSlopConfig
+} from "../../../../chunk-97s6xvc6.js";
+import"../../../../chunk-5wgwscd0.js";
+export {
+  noCommentSlopConfig
+};