@venizia/dev-configs 0.2.0 → 0.2.1

package/README.md

@@ -63,21 +63,59 @@ earlier. Every IGNIS example does.
 
 | Entry point | What it gives |
 | :--- | :--- |
-| `@venizia/dev-configs` | `eslintConfigs` (flat config array), `prettierConfigs`, `BunCompiler` |
+| `@venizia/dev-configs` | `eslintConfigs` (flat config array), `ReactEslintConfigs`, `prettierConfigs`, `BunCompiler` |
 | `@venizia/dev-configs/tsconfig.base.json` | Target and lib ES2024, `module` Node16, strict mode with `noImplicitAny`, `strictPropertyInitialization` and `useUnknownInCatchVariables` off, `noEmitOnError`, tests excluded |
 | `@venizia/dev-configs/tsconfig.common.json` | Extends the base and switches `module` and `moduleResolution` to `nodenext` |
 
 ## What each config sets
 
 `eslintConfigs` is `@minimaltech/eslint-node` (ESLint recommended, typescript-eslint, Prettier as a
-lint rule, naming conventions, `eslint-plugin-n`) plus three IGNIS rules:
+lint rule, naming conventions, `curly`, `eslint-plugin-n`) plus these IGNIS rules:
 
 | Rule | Setting |
 | :--- | :--- |
 | `@typescript-eslint/no-explicit-any` | `off` |
-| `curly` | `['error', 'all']` |
+| `@typescript-eslint/ban-ts-comment` | `error` - `@ts-expect-error` with a description is still allowed |
+| `@typescript-eslint/no-namespace` | `error` |
 | `unicorn/switch-case-braces` | `['error', 'always']` |
 
+`ReactEslintConfigs.create({ plugins })` is `eslintConfigs` plus what a React frontend needs. The
+plugins come in as options, so a backend installs none of them:
+
+```js
+// eslint.config.mjs
+import { ReactEslintConfigs } from '@venizia/dev-configs';
+import react from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+
+export default [
+  { ignores: ['dist/'] },
+  ...ReactEslintConfigs.create({ plugins: { react, reactHooks, jsxA11y } }),
+];
+```
+
+| Adds | Setting |
+| :--- | :--- |
+| React correctness (`jsx-key`, `no-children-prop`, `no-deprecated`, ... - 14 rules) | `error`, `.jsx`/`.tsx` |
+| `jsx-a11y` basics (`alt-text`, `aria-props`, `aria-role`, ... - 9 rules) | `error`, `.jsx`/`.tsx` |
+| `react-hooks/rules-of-hooks` / `exhaustive-deps` | `error` / `warn`, every source file |
+| `@typescript-eslint/consistent-type-imports` | `['error', { prefer: 'type-imports' }]` |
+| `naming-convention` | the base rule, plus PascalCase functions (`function App()`), `.jsx`/`.tsx` |
+| `no-floating-promises`, `no-void`, `no-invalid-this`, `no-use-before-define` | `off` - a UI fires promises from handlers and uses components above their declaration |
+| `no-explicit-any` | `warn` (the base has it `off`) |
+| `no-shadow` | `warn` |
+| `no-unused-vars` | `warn`, `_`-prefixed names ignored |
+
+Rules the automatic JSX runtime or `tsc` already enforce (`react-in-jsx-scope`, `prop-types`,
+`jsx-no-undef`, ...) are left out.
+
+- `reactVersion` defaults to `'detect'`. Under ESLint 10, eslint-plugin-react 7 cannot detect it and
+  aborts - pass the version: `create({ plugins, reactVersion: '19.2' })`.
+- In an `eslint.config.ts`, `eslint-plugin-jsx-a11y` needs `@types/eslint-plugin-jsx-a11y`.
+- `consistent-type-imports` keeps the default `fixStyle`; a codebase that prefers
+  `inline-type-imports` sets it on top.
+
 `prettierConfigs`:
 
 | Setting | Value |

package/dist/eslint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eslint.d.ts","sourceRoot":"","sources":["../src/eslint.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGrC,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAcxC,CAAC"}
+{"version":3,"file":"eslint.d.ts","sourceRoot":"","sources":["../src/eslint.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGrC,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAexC,CAAC"}

package/dist/eslint.js

@@ -11,12 +11,13 @@ exports.eslintConfigs = [
     {
         rules: {
             "@typescript-eslint/no-explicit-any": "off",
+            "@typescript-eslint/ban-ts-comment": "error",
+            "@typescript-eslint/no-namespace": "error",
         },
     },
     {
         plugins: { unicorn: eslint_plugin_unicorn_1.default },
         rules: {
-            curly: ["error", "all"],
             "unicorn/switch-case-braces": ["error", "always"],
         },
     },

package/dist/eslint.js.map

@@ -1 +1 @@
-{"version":3,"file":"eslint.js","sourceRoot":"","sources":["../src/eslint.ts"],"names":[],"mappings":";;;;;;AAAA,2EAAqD;AAErD,kFAA4C;AAE/B,QAAA,aAAa,GAAoB;IAC5C,GAAG,qBAAa;IAChB;QACE,KAAK,EAAE;YACL,oCAAoC,EAAE,KAAK;SAC5C;KACF;IACD;QACE,OAAO,EAAE,EAAE,OAAO,EAAP,+BAAO,EAAE;QACpB,KAAK,EAAE;YACL,KAAK,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC;YACvB,4BAA4B,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;SAClD;KACF;CACF,CAAC"}
+{"version":3,"file":"eslint.js","sourceRoot":"","sources":["../src/eslint.ts"],"names":[],"mappings":";;;;;;AAAA,2EAAqD;AAErD,kFAA4C;AAE/B,QAAA,aAAa,GAAoB;IAC5C,GAAG,qBAAa;IAChB;QACE,KAAK,EAAE;YACL,oCAAoC,EAAE,KAAK;YAC3C,mCAAmC,EAAE,OAAO;YAC5C,iCAAiC,EAAE,OAAO;SAC3C;KACF;IACD;QACE,OAAO,EAAE,EAAE,OAAO,EAAP,+BAAO,EAAE;QACpB,KAAK,EAAE;YACL,4BAA4B,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;SAClD;KACF;CACF,CAAC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./compile";
 export * from "./eslint";
 export * from "./prettier";
+export * from "./react";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./compile"), exports);
 __exportStar(require("./eslint"), exports);
 __exportStar(require("./prettier"), exports);
+__exportStar(require("./react"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,2CAAyB;AACzB,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,2CAAyB;AACzB,6CAA2B;AAC3B,0CAAwB"}

package/dist/react.d.ts

@@ -0,0 +1,32 @@
+import type { ESLint, Linter } from "eslint";
+/** Without `configs`: each plugin types its presets its own way, and only the rules are used here. */
+type TRulesPlugin = Omit<ESLint.Plugin, "configs">;
+export interface IReactEslintPlugins {
+    react: TRulesPlugin;
+    reactHooks: TRulesPlugin;
+    jsxA11y: TRulesPlugin;
+}
+/**
+ * The base preset plus what a React frontend needs on top: the React, hooks and accessibility rules,
+ * and the base rules a UI relaxes on purpose. The plugins come in as options, so a backend that
+ * never calls this installs none of them.
+ *
+ * ```js
+ * import react from 'eslint-plugin-react';
+ * import reactHooks from 'eslint-plugin-react-hooks';
+ * import jsxA11y from 'eslint-plugin-jsx-a11y';
+ *
+ * export default ReactEslintConfigs.create({ plugins: { react, reactHooks, jsxA11y } });
+ * ```
+ *
+ * `reactVersion` defaults to `detect`. Under ESLint 10, eslint-plugin-react 7 cannot detect it and
+ * aborts, so pass the version there (`reactVersion: '19.2'`).
+ */
+export declare class ReactEslintConfigs {
+    static create(opts: {
+        plugins: IReactEslintPlugins;
+        reactVersion?: string;
+    }): Linter.Config[];
+}
+export {};
+//# sourceMappingURL=react.d.ts.map

package/dist/react.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAG7C,sGAAsG;AACtG,KAAK,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAEnD,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,YAAY,CAAC;IACpB,UAAU,EAAE,YAAY,CAAC;IACzB,OAAO,EAAE,YAAY,CAAC;CACvB;AAID;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,kBAAkB;IAC7B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;QAClB,OAAO,EAAE,mBAAmB,CAAC;QAC7B,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,GAAG,MAAM,CAAC,MAAM,EAAE;CA+FpB"}

package/dist/react.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReactEslintConfigs = void 0;
+const eslint_1 = require("./eslint");
+const NAMING_CONVENTION = "@typescript-eslint/naming-convention";
+/**
+ * The base preset plus what a React frontend needs on top: the React, hooks and accessibility rules,
+ * and the base rules a UI relaxes on purpose. The plugins come in as options, so a backend that
+ * never calls this installs none of them.
+ *
+ * ```js
+ * import react from 'eslint-plugin-react';
+ * import reactHooks from 'eslint-plugin-react-hooks';
+ * import jsxA11y from 'eslint-plugin-jsx-a11y';
+ *
+ * export default ReactEslintConfigs.create({ plugins: { react, reactHooks, jsxA11y } });
+ * ```
+ *
+ * `reactVersion` defaults to `detect`. Under ESLint 10, eslint-plugin-react 7 cannot detect it and
+ * aborts, so pass the version there (`reactVersion: '19.2'`).
+ */
+class ReactEslintConfigs {
+    static create(opts) {
+        const { react, reactHooks, jsxA11y } = opts.plugins;
+        const { reactVersion = "detect" } = opts;
+        // The last config that sets it wins, as in ESLint itself.
+        const baseNaming = [...eslint_1.eslintConfigs]
+            .reverse()
+            .find((config) => config.rules?.[NAMING_CONVENTION])?.rules?.[NAMING_CONVENTION];
+        // A bare severity carries no selectors; nothing to extend then but the severity.
+        const [severity, ...selectors] = Array.isArray(baseNaming) ? baseNaming : [baseNaming ?? "error"];
+        return [
+            ...eslint_1.eslintConfigs,
+            {
+                files: ["**/*.{jsx,tsx}"],
+                plugins: { react, "jsx-a11y": jsxA11y },
+                settings: { react: { version: reactVersion } },
+                rules: {
+                    // The base naming rule, plus PascalCase functions: a component declared as `function App()`.
+                    [NAMING_CONVENTION]: [
+                        severity,
+                        ...selectors,
+                        { selector: "function", format: ["camelCase", "PascalCase"] },
+                    ],
+                    // Correctness rules from react's recommended set. Left out: what the automatic JSX runtime or
+                    // tsc already covers (react-in-jsx-scope, jsx-uses-react, prop-types, jsx-no-undef,
+                    // jsx-no-duplicate-props, no-unknown-property).
+                    "react/display-name": "error",
+                    "react/jsx-boolean-value": "error",
+                    "react/jsx-key": "error",
+                    "react/jsx-no-comment-textnodes": "error",
+                    "react/jsx-no-target-blank": "error",
+                    "react/no-children-prop": "error",
+                    "react/no-danger-with-children": "error",
+                    "react/no-deprecated": "error",
+                    "react/no-direct-mutation-state": "error",
+                    "react/no-find-dom-node": "error",
+                    "react/no-is-mounted": "error",
+                    "react/no-render-return-value": "error",
+                    "react/no-string-refs": "error",
+                    "react/require-render-return": "error",
+                    "jsx-a11y/alt-text": "error",
+                    "jsx-a11y/anchor-has-content": "error",
+                    "jsx-a11y/aria-props": "error",
+                    "jsx-a11y/aria-proptypes": "error",
+                    "jsx-a11y/aria-role": "error",
+                    "jsx-a11y/aria-unsupported-elements": "error",
+                    "jsx-a11y/role-has-required-aria-props": "error",
+                    "jsx-a11y/role-supports-aria-props": "error",
+                    "jsx-a11y/tabindex-no-positive": "error",
+                },
+            },
+            {
+                // Custom hooks live in .ts files too.
+                files: ["**/*.{js,jsx,ts,tsx}"],
+                plugins: { "react-hooks": reactHooks },
+                rules: {
+                    "react-hooks/rules-of-hooks": "error",
+                    "react-hooks/exhaustive-deps": "warn",
+                },
+            },
+            {
+                rules: {
+                    "@typescript-eslint/consistent-type-imports": [
+                        "error",
+                        { prefer: "type-imports" },
+                    ],
+                    // A UI hands promises to event handlers and effects that do not await them.
+                    "@typescript-eslint/no-floating-promises": "off",
+                    "no-void": "off",
+                    // Function components, not classes; a component may be used above its declaration.
+                    "@typescript-eslint/no-invalid-this": "off",
+                    "@typescript-eslint/no-use-before-define": "off",
+                    "@typescript-eslint/no-explicit-any": "warn",
+                    "@typescript-eslint/no-shadow": "warn",
+                    "@typescript-eslint/no-unused-vars": [
+                        "warn",
+                        {
+                            argsIgnorePattern: "^_",
+                            varsIgnorePattern: "^_",
+                            caughtErrorsIgnorePattern: "^_",
+                            ignoreRestSiblings: true,
+                        },
+                    ],
+                },
+            },
+        ];
+    }
+}
+exports.ReactEslintConfigs = ReactEslintConfigs;
+//# sourceMappingURL=react.js.map

package/dist/react.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.js","sourceRoot":"","sources":["../src/react.ts"],"names":[],"mappings":";;;AACA,qCAAyC;AAWzC,MAAM,iBAAiB,GAAG,sCAAsC,CAAC;AAEjE;;;;;;;;;;;;;;;GAeG;AACH,MAAa,kBAAkB;IAC7B,MAAM,CAAC,MAAM,CAAC,IAGb;QACC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACpD,MAAM,EAAE,YAAY,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QAEzC,0DAA0D;QAC1D,MAAM,UAAU,GAAG,CAAC,GAAG,sBAAa,CAAC;aAClC,OAAO,EAAE;aACT,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,CAC7D,iBAAiB,CAClB,CAAC;QACF,iFAAiF;QACjF,MAAM,CAAC,QAAQ,EAAE,GAAG,SAAS,CAAC,GAC5B,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,IAAI,OAAO,CAAC,CAAC;QAEnE,OAAO;YACL,GAAG,sBAAa;YAChB;gBACE,KAAK,EAAE,CAAC,gBAAgB,CAAC;gBACzB,OAAO,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE;gBACvC,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE;gBAC9C,KAAK,EAAE;oBACL,6FAA6F;oBAC7F,CAAC,iBAAiB,CAAC,EAAE;wBACnB,QAAQ;wBACR,GAAG,SAAS;wBACZ,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,EAAE;qBAC9D;oBAED,8FAA8F;oBAC9F,oFAAoF;oBACpF,gDAAgD;oBAChD,oBAAoB,EAAE,OAAO;oBAC7B,yBAAyB,EAAE,OAAO;oBAClC,eAAe,EAAE,OAAO;oBACxB,gCAAgC,EAAE,OAAO;oBACzC,2BAA2B,EAAE,OAAO;oBACpC,wBAAwB,EAAE,OAAO;oBACjC,+BAA+B,EAAE,OAAO;oBACxC,qBAAqB,EAAE,OAAO;oBAC9B,gCAAgC,EAAE,OAAO;oBACzC,wBAAwB,EAAE,OAAO;oBACjC,qBAAqB,EAAE,OAAO;oBAC9B,8BAA8B,EAAE,OAAO;oBACvC,sBAAsB,EAAE,OAAO;oBAC/B,6BAA6B,EAAE,OAAO;oBAEtC,mBAAmB,EAAE,OAAO;oBAC5B,6BAA6B,EAAE,OAAO;oBACtC,qBAAqB,EAAE,OAAO;oBAC9B,yBAAyB,EAAE,OAAO;oBAClC,oBAAoB,EAAE,OAAO;oBAC7B,oCAAoC,EAAE,OAAO;oBAC7C,uCAAuC,EAAE,OAAO;oBAChD,mCAAmC,EAAE,OAAO;oBAC5C,+BAA+B,EAAE,OAAO;iBACzC;aACF;YACD;gBACE,sCAAsC;gBACtC,KAAK,EAAE,CAAC,sBAAsB,CAAC;gBAC/B,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,EAAE;gBACtC,KAAK,EAAE;oBACL,4BAA4B,EAAE,OAAO;oBACrC,6BAA6B,EAAE,MAAM;iBACtC;aACF;YACD;gBACE,KAAK,EAAE;oBACL,4CAA4C,EAAE;wBAC5C,OAAO;wBACP,EAAE,MAAM,EAAE,cAAc,EAAE;qBAC3B;oBACD,4EAA4E;oBAC5E,yCAAyC,EAAE,KAAK;oBAChD,SAAS,EAAE,KAAK;oBAEhB,mFAAmF;oBACnF,oCAAoC,EAAE,KAAK;oBAC3C,yCAAyC,EAAE,KAAK;oBAEhD,oCAAoC,EAAE,MAAM;oBAC5C,8BAA8B,EAAE,MAAM;oBACtC,mCAAmC,EAAE;wBACnC,MAAM;wBACN;4BACE,iBAAiB,EAAE,IAAI;4BACvB,iBAAiB,EAAE,IAAI;4BACvB,yBAAyB,EAAE,IAAI;4BAC/B,kBAAkB,EAAE,IAAI;yBACzB;qBACF;iBACF;aACF;SACF,CAAC;IACJ,CAAC;CACF;AAnGD,gDAmGC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@venizia/dev-configs",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Shareable development configurations for TypeScript projects: ESLint v9 flat config (with unicorn plugin), Prettier formatting, and TypeScript compiler options with critical decorator support (experimentalDecorators, emitDecoratorMetadata, useDefineForClassFields). Single source of truth for consistent code style, type checking, and build settings across monorepo packages. 3-line consumption pattern per config.",
   "keywords": [
     "build-tools",