@forthtilliath/eslint-config 0.5.0 → 0.7.0

package/README.md

@@ -115,6 +115,7 @@ export default createBaseConfig({ strict: false, turbo: false });
 | `prettier`       | `true`   | Append `eslint-config-prettier` at the end.                                                                                                                                                              |
 | `strict`         | `true`   | Use `strictTypeChecked`/`stylisticTypeChecked` instead of plain `recommended`.                                                                                                                           |
 | `turbo`          | `true`   | Enable `eslint-plugin-turbo`'s `no-undeclared-env-vars` rule.                                                                                                                                            |
+| `snakeCase`      | `false`  | Also accept `snake_case` variable names in `@typescript-eslint/naming-convention` (e.g. rows destructured straight from a Supabase/SQL database).                                                        |
 | `a11y`           | `true`\* | _(react/nextjs/storybook/react-native)_ Enable `eslint-plugin-jsx-a11y`'s recommended rules. \*Defaults to `false` in `createReactNativeConfig` (jsx-a11y targets DOM semantics, which RN doesn't have). |
 | `i18n`           | `false`  | _(react/nextjs/storybook/react-native)_ Enable `eslint-plugin-i18next`'s `no-literal-string` rule.                                                                                                       |
 | `testingLibrary` | `false`  | _(react/nextjs/storybook/react-native)_ Enable `eslint-plugin-testing-library` + `eslint-plugin-jest-dom` on test files.                                                                                 |

package/dist/base.d.ts

@@ -11,14 +11,33 @@
  * @property {boolean} [turbo=true] - Enable eslint-plugin-turbo's
  *   `no-undeclared-env-vars` rule. Only relevant inside a Turborepo; set to
  *   `false` for a standalone project.
+ * @property {boolean} [snakeCase=false] - Also accept `snake_case` variable
+ *   names in `@typescript-eslint/naming-convention` — for code that
+ *   destructures rows straight from a SQL database (e.g. Supabase), whose
+ *   columns are snake_case.
  */
+/**
+ * Builds the `@typescript-eslint/naming-convention` rule entry. Exported so
+ * variants that loosen it (react.js accepts PascalCase components) stay in
+ * sync with the `snakeCase` option instead of redeclaring the whole list.
+ *
+ * @param {object} [options]
+ * @param {boolean} [options.snakeCase=false] - See {@link BaseConfigOptions}.
+ * @param {boolean} [options.react=false] - Accept PascalCase for `const`
+ *   variables and functions (React components).
+ * @returns {import("eslint").Linter.RuleEntry}
+ */
+export function createNamingConventionRule({ snakeCase, react, }?: {
+    snakeCase?: boolean | undefined;
+    react?: boolean | undefined;
+}): import("eslint").Linter.RuleEntry;
 /**
  * Builds a shared ESLint configuration for the repository.
  *
  * @param {BaseConfigOptions} [options]
  * @returns {import("eslint").Linter.Config[]}
  */
-export function createBaseConfig({ prettier, strict, turbo, }?: BaseConfigOptions): import("eslint").Linter.Config[];
+export function createBaseConfig({ prettier, strict, turbo, snakeCase, }?: BaseConfigOptions): import("eslint").Linter.Config[];
 /**
  * Node.js builtins without the `node:` prefix, as the first
  * `simple-import-sort/imports` group. Exported so other variants (e.g.
@@ -55,5 +74,12 @@ export type BaseConfigOptions = {
      * `false` for a standalone project.
      */
     turbo?: boolean | undefined;
+    /**
+     * - Also accept `snake_case` variable
+     * names in `@typescript-eslint/naming-convention` — for code that
+     * destructures rows straight from a SQL database (e.g. Supabase), whose
+     * columns are snake_case.
+     */
+    snakeCase?: boolean | undefined;
 };
 //# sourceMappingURL=base.d.ts.map

package/dist/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.js"],"names":[],"mappings":"AAuBA;;;;;;;;;;;;;GAaG;AAEH;;;;;GAKG;AACH,gEAHW,iBAAiB,GACf,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAoI5C;AAtKD;;;;;;GAMG;AACH,wCAFU,MAAM,EAAE,CAQhB;AA2JF;;;;;KAKK;AACL,yBAFU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAEG"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.js"],"names":[],"mappings":"AAuBA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;GAUG;AACH,mEALG;IAA0B,SAAS;IACT,KAAK;CAE/B,GAAU,OAAO,QAAQ,EAAE,MAAM,CAAC,SAAS,CA+B7C;AAED;;;;;GAKG;AACH,2EAHW,iBAAiB,GACf,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAiH5C;AAjMD;;;;;;GAMG;AACH,wCAFU,MAAM,EAAE,CAQhB;AAsLF;;;;;KAKK;AACL,yBAFU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAEG"}

package/dist/base.js

@@ -32,14 +32,56 @@ export const NODE_BUILTIN_IMPORT_GROUP = [
  * @property {boolean} [turbo=true] - Enable eslint-plugin-turbo's
  *   `no-undeclared-env-vars` rule. Only relevant inside a Turborepo; set to
  *   `false` for a standalone project.
+ * @property {boolean} [snakeCase=false] - Also accept `snake_case` variable
+ *   names in `@typescript-eslint/naming-convention` — for code that
+ *   destructures rows straight from a SQL database (e.g. Supabase), whose
+ *   columns are snake_case.
  */
+/**
+ * Builds the `@typescript-eslint/naming-convention` rule entry. Exported so
+ * variants that loosen it (react.js accepts PascalCase components) stay in
+ * sync with the `snakeCase` option instead of redeclaring the whole list.
+ *
+ * @param {object} [options]
+ * @param {boolean} [options.snakeCase=false] - See {@link BaseConfigOptions}.
+ * @param {boolean} [options.react=false] - Accept PascalCase for `const`
+ *   variables and functions (React components).
+ * @returns {import("eslint").Linter.RuleEntry}
+ */
+export function createNamingConventionRule({ snakeCase = false, react = false, } = {}) {
+    const snake = snakeCase ? ["snake_case"] : [];
+    const pascal = react ? ["PascalCase"] : [];
+    return [
+        "error",
+        // https://typescript-eslint.io/rules/naming-convention
+        {
+            selector: "variable",
+            format: ["camelCase", ...snake],
+            leadingUnderscore: "allow",
+        },
+        {
+            selector: "variable",
+            modifiers: ["const"],
+            format: ["camelCase", "UPPER_CASE", ...pascal, ...snake],
+            leadingUnderscore: "allow",
+        },
+        {
+            selector: "function",
+            format: ["camelCase", ...pascal],
+        },
+        {
+            selector: "typeLike",
+            format: ["PascalCase"],
+        },
+    ];
+}
 /**
  * Builds a shared ESLint configuration for the repository.
  *
  * @param {BaseConfigOptions} [options]
  * @returns {import("eslint").Linter.Config[]}
  */
-export function createBaseConfig({ prettier = true, strict = true, turbo = true, } = {}) {
+export function createBaseConfig({ prettier = true, strict = true, turbo = true, snakeCase = false, } = {}) {
     return defineConfig([
         eslint.configs.recommended,
         strict ? tseslint.configs.strictTypeChecked : tseslint.configs.recommended,
@@ -138,29 +180,9 @@ export function createBaseConfig({ prettier = true, strict = true, turbo = true,
                     "error",
                     { allowNumber: true },
                 ],
-                "@typescript-eslint/naming-convention": [
-                    "error",
-                    // https://typescript-eslint.io/rules/naming-convention
-                    {
-                        selector: "variable",
-                        format: ["camelCase"],
-                        leadingUnderscore: "allow",
-                    },
-                    {
-                        selector: "variable",
-                        modifiers: ["const"],
-                        format: ["camelCase", "UPPER_CASE"],
-                        leadingUnderscore: "allow",
-                    },
-                    {
-                        selector: "function",
-                        format: ["camelCase"],
-                    },
-                    {
-                        selector: "typeLike",
-                        format: ["PascalCase"],
-                    },
-                ],
+                "@typescript-eslint/naming-convention": createNamingConventionRule({
+                    snakeCase,
+                }),
             },
         },
         prettier ? eslintConfigPrettier : [],

package/dist/nextjs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nextjs.d.ts","sourceRoot":"","sources":["../src/nextjs.js"],"names":[],"mappings":"AAKA;;;;;;;KAOK;AACL,6CAHW,OAAO,WAAW,EAAE,iBAAiB,GAAG,OAAO,YAAY,EAAE,kBAAkB,GAC7E,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAmD5C;AAED;;;;;KAKK;AACL,2BAFU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAEO"}
+{"version":3,"file":"nextjs.d.ts","sourceRoot":"","sources":["../src/nextjs.js"],"names":[],"mappings":"AAKA;;;;;;;KAOK;AACL,6CAHW,OAAO,WAAW,EAAE,iBAAiB,GAAG,OAAO,YAAY,EAAE,kBAAkB,GAC7E,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAsD5C;AAED;;;;;KAKK;AACL,2BAFU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAEO"}

package/dist/nextjs.js

@@ -12,7 +12,10 @@ import { createReactConfig } from "./react.js";
 export function createNextJsConfig(options) {
     return defineConfig([
         {
-            ignores: [".next/**", "next-env.d.ts"],
+            // Same default ignores as eslint-config-next: build output
+            // (`.next/`, and `out/`/`build/` for static exports) and the generated
+            // `next-env.d.ts`.
+            ignores: [".next/**", "out/**", "build/**", "next-env.d.ts"],
         },
         ...createReactConfig(options),
         {

package/dist/react.d.ts

@@ -21,7 +21,7 @@
  * @param {import("./base.js").BaseConfigOptions & ReactConfigOptions} [options]
  * @returns {import("eslint").Linter.Config[]}
  */
-export function createReactConfig({ a11y, i18n, testingLibrary, ...options }?: import("./base.js").BaseConfigOptions & ReactConfigOptions): import("eslint").Linter.Config[];
+export function createReactConfig({ a11y, i18n, testingLibrary, snakeCase, ...options }?: import("./base.js").BaseConfigOptions & ReactConfigOptions): import("eslint").Linter.Config[];
 /**
  * A custom ESLint configuration for libraries that use React, with the
  * default options. Use `createReactConfig(options)` instead to customize it.

package/dist/react.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.js"],"names":[],"mappings":"AAqBA;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;GAKG;AACH,+EAHW,OAAO,WAAW,EAAE,iBAAiB,GAAG,kBAAkB,GACxD,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CA+F5C;AAED;;;;8CAI8C;AAC9C,0BADU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CACK"}
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.js"],"names":[],"mappings":"AAuCA;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;GAKG;AACH,0FAHW,OAAO,WAAW,EAAE,iBAAiB,GAAG,kBAAkB,GACxD,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAwF5C;AAED;;;;8CAI8C;AAC9C,0BADU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CACK"}

package/dist/react.js

@@ -8,7 +8,7 @@ import pluginReactHooks from "eslint-plugin-react-hooks";
 import pluginReactRefresh from "eslint-plugin-react-refresh";
 import pluginTestingLibrary from "eslint-plugin-testing-library";
 import globals from "globals";
-import { createBaseConfig } from "./base.js";
+import { createBaseConfig, createNamingConventionRule } from "./base.js";
 /**
  * Any file matching this is a test file, whatever runner or naming
  * convention is used to suffix it (`.test.`, `.spec.`, `.dom.test.`...) —
@@ -16,6 +16,23 @@ import { createBaseConfig } from "./base.js";
  * @type {string[]}
  */
 const TEST_FILE_GLOBS = ["**/*.{test,spec}.{ts,tsx,js,jsx}"];
+/**
+ * eslint-plugin-react-hooks rules that @eslint-react also implements, under
+ * the same name. Only the @eslint-react version is kept (see the rules block
+ * below); `src/nextjs.test.js` fails if a new overlap appears.
+ * @type {string[]}
+ */
+const RULES_COVERED_BY_ESLINT_REACT = [
+    "rules-of-hooks",
+    "exhaustive-deps",
+    "static-components",
+    "use-memo",
+    "set-state-in-effect",
+    "error-boundaries",
+    "purity",
+    "set-state-in-render",
+    "unsupported-syntax",
+];
 /**
  * @typedef {object} ReactConfigOptions
  * @property {boolean} [a11y=true] - Enable eslint-plugin-jsx-a11y's
@@ -39,9 +56,9 @@ const TEST_FILE_GLOBS = ["**/*.{test,spec}.{ts,tsx,js,jsx}"];
  * @param {import("./base.js").BaseConfigOptions & ReactConfigOptions} [options]
  * @returns {import("eslint").Linter.Config[]}
  */
-export function createReactConfig({ a11y = true, i18n = false, testingLibrary = false, ...options } = {}) {
+export function createReactConfig({ a11y = true, i18n = false, testingLibrary = false, snakeCase = false, ...options } = {}) {
     return defineConfig([
-        ...createBaseConfig(options),
+        ...createBaseConfig({ snakeCase, ...options }),
         a11y ? pluginJsxA11y.flatConfigs.recommended : [],
         i18n
             ? {
@@ -79,6 +96,14 @@ export function createReactConfig({ a11y = true, i18n = false, testingLibrary =
             settings: { react: { version: "19" } },
             rules: {
                 ...pluginReactHooks.configs.recommended.rules,
+                // Already covered by @eslint-react's recommended-type-checked preset
+                // (sometimes more thoroughly: its `purity` flags `new Date()`, the
+                // react-hooks one doesn't). Left on, every problem is reported twice
+                // and every disable comment has to name both plugins.
+                ...Object.fromEntries(RULES_COVERED_BY_ESLINT_REACT.map((rule) => [
+                    `react-hooks/${rule}`,
+                    "off",
+                ])),
                 // React scope no longer necessary with new JSX transform.
                 "react/react-in-jsx-scope": "off",
             },
@@ -102,28 +127,10 @@ export function createReactConfig({ a11y = true, i18n = false, testingLibrary =
             rules: {
                 "@typescript-eslint/no-unsafe-call": "warn",
                 "@typescript-eslint/restrict-template-expressions": "warn",
-                "@typescript-eslint/naming-convention": [
-                    "error",
-                    {
-                        selector: "variable",
-                        format: ["camelCase"],
-                        leadingUnderscore: "allow",
-                    },
-                    {
-                        selector: "variable",
-                        modifiers: ["const"],
-                        format: ["camelCase", "UPPER_CASE", "PascalCase"],
-                        leadingUnderscore: "allow",
-                    },
-                    {
-                        selector: "function",
-                        format: ["camelCase", "PascalCase"],
-                    },
-                    {
-                        selector: "typeLike",
-                        format: ["PascalCase"],
-                    },
-                ],
+                "@typescript-eslint/naming-convention": createNamingConventionRule({
+                    snakeCase,
+                    react: true,
+                }),
             },
         },
     ]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forthtilliath/eslint-config",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
@@ -50,7 +50,7 @@
     "rxjs": "^7.8.0",
     "typescript": "^5.9.3",
     "vitest": "^4.1.10",
-    "@forthtilliath/typescript-config": "0.0.0"
+    "@forthtilliath/typescript-config": "0.1.1"
   },
   "scripts": {
     "dev": "tsc --watch -p tsconfig.build.json",