@forthtilliath/eslint-config 0.4.2 → 0.6.0

package/README.md

@@ -31,6 +31,17 @@ there's nothing else to install per variant.
 
 ## Usage
 
+Quick reference — pick the row matching the package, in its `eslint.config.ts`:
+
+| Variant             | Subpath         | Use for                    | Extends       |
+| ------------------- | --------------- | -------------------------- | ------------- |
+| `baseConfig`        | `.` (root)      | A plain TypeScript library | —             |
+| `reactConfig`       | `/react`        | A React library            | `baseConfig`  |
+| `nextJsConfig`      | `/nextjs`       | A Next.js app              | `reactConfig` |
+| `storybookConfig`   | `/storybook`    | A Storybook app            | `reactConfig` |
+| `reactNativeConfig` | `/react-native` | A React Native / Expo app  | `reactConfig` |
+| `angularConfig`     | `/angular`      | An Angular app/library     | `baseConfig`  |
+
 Pick the variant that matches the package, in its `eslint.config.ts`:
 
 ```ts
@@ -104,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.                                                                                 |
@@ -144,6 +156,23 @@ Rules that need type information (`consistent-type-exports`,
 from linting entirely — none of them belong to a package's own `tsconfig`
 project, so type-aware rules crash on them otherwise.
 
+### Angular import order
+
+`angularConfig` overrides `simple-import-sort/imports` on `**/*.ts` so
+`@angular/core`/`rxjs` sort before every other package, ahead of the generic
+"third-party packages, alphabetically" group `baseConfig` uses everywhere
+else — the conventional Angular reading order (framework, then everything
+else, then app code).
+
+## Testing this package
+
+Unlike the other five variants — each already exercised by whatever
+package/app in this monorepo lints under them — `angularConfig` has no real
+consumer here yet, so `src/angular.test.js` lints small fixture files under
+`src/__fixtures__/angular/` through ESLint's Node API directly, standing in
+for that. Extend it (or add a sibling `<variant>.test.js`) whenever a variant
+changes without a real consumer to catch a regression.
+
 ## Scripts
 
 ```bash
@@ -151,6 +180,8 @@ pnpm run build        # tsc -> dist/ (consumers import the built output)
 pnpm run dev           # tsc --watch
 pnpm run check-types   # tsc --noEmit
 pnpm run lint          # eslint (lints its own src/)
+pnpm run test          # vitest run
+pnpm run test:watch    # vitest
 ```
 
 Run `pnpm run build` after editing `src/*.js` — consuming packages resolve

package/dist/angular.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"angular.d.ts","sourceRoot":"","sources":["../src/angular.js"],"names":[],"mappings":"AAMA;;;;;;;;;;GAUG;AACH,8CAHW,OAAO,WAAW,EAAE,iBAAiB,GACnC,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CA2C5C;AAED;;;;8CAI8C;AAC9C,4BADU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CACS"}
+{"version":3,"file":"angular.d.ts","sourceRoot":"","sources":["../src/angular.js"],"names":[],"mappings":"AAMA;;;;;;;;;;GAUG;AACH,8CAHW,OAAO,WAAW,EAAE,iBAAiB,GACnC,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CA+D5C;AAED;;;;8CAI8C;AAC9C,4BADU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CACS"}

package/dist/angular.js

@@ -1,7 +1,7 @@
 import angular from "angular-eslint";
 import { defineConfig } from "eslint/config";
 import tseslint from "typescript-eslint";
-import { createBaseConfig } from "./base.js";
+import { createBaseConfig, NODE_BUILTIN_IMPORT_GROUP } from "./base.js";
 /**
  * A custom ESLint configuration for Angular applications/libraries.
  *
@@ -38,6 +38,26 @@ export function createAngularConfig(options) {
                 // Un composant/page Angular sans logique propre (juste un template +
                 // decorateur) est un corps de classe legitimement vide, pas du code mort.
                 "@typescript-eslint/no-extraneous-class": "off",
+                // Convention Angular : le framework (et RxJS, quasi-systematiquement
+                // utilise a ses cotes) se lit avant le reste — packages tiers, puis
+                // imports internes de l'app. baseConfig's generic "^@?\\w" group
+                // sorts every third-party package alphabetically together, which
+                // would interleave "@angular/core" with unrelated libs instead.
+                "simple-import-sort/imports": [
+                    "error",
+                    {
+                        groups: [
+                            NODE_BUILTIN_IMPORT_GROUP,
+                            ["^@angular", "^rxjs"],
+                            ["^@?\\w"],
+                            ["^(@forthtilliath)(/.*|$)"],
+                            ["^(@|@ui|components|utils|config)(/.*|$)"],
+                            ["^\\u0000"],
+                            ["^\\.\\.(?!/?$)", "^\\.\\./?$"],
+                            ["^\\./(?=.*/)(?!/?$)", "^\\.(?!/?$)", "^\\./?$"],
+                        ],
+                    },
+                ],
             },
         },
         {

package/dist/base.d.ts

@@ -11,14 +11,41 @@
  * @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.
+ * angular.js, which overrides this rule with Angular-specific groups) don't
+ * have to duplicate the list to keep builtins sorted first too.
+ * @type {string[]}
+ */
+export const NODE_BUILTIN_IMPORT_GROUP: string[];
 /**
  * A shared ESLint configuration for the repository, with the default options.
  * Use `createBaseConfig(options)` instead to customize it.
@@ -47,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":"AAQA;;;;;;;;;;;;;GAaG;AAEH;;;;;GAKG;AACH,gEAHW,iBAAiB,GACf,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAyI5C;AAED;;;;;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

@@ -5,6 +5,20 @@ import simpleImportSortPlugin from "eslint-plugin-simple-import-sort";
 import turboPlugin from "eslint-plugin-turbo";
 import globals from "globals";
 import tseslint from "typescript-eslint";
+/**
+ * Node.js builtins without the `node:` prefix, as the first
+ * `simple-import-sort/imports` group. Exported so other variants (e.g.
+ * angular.js, which overrides this rule with Angular-specific groups) don't
+ * have to duplicate the list to keep builtins sorted first too.
+ * @type {string[]}
+ */
+export const NODE_BUILTIN_IMPORT_GROUP = [
+    // Node.js builtins. You could also generate this regex if you use a `.js` config.
+    // For example: `^(${require("module").builtinModules.join("|")})(/|$)`
+    // Note that if you use the `node:` prefix for Node.js builtins,
+    // you can avoid this complexity: You can simply use "^node:".
+    "^(assert|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|https|module|net|os|path|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|tty|url|util|vm|zlib|freelist|v8|process|async_hooks|http2|perf_hooks)(/.*|$)",
+];
 /**
  * @typedef {object} BaseConfigOptions
  * @property {boolean} [prettier=true] - Append eslint-config-prettier at the
@@ -18,14 +32,56 @@ import tseslint from "typescript-eslint";
  * @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,
@@ -33,6 +89,7 @@ export function createBaseConfig({ prettier = true, strict = true, turbo = true,
         {
             ignores: [
                 "dist/**",
+                "coverage/**",
                 "storybook-static/**",
                 "postcss.config.cjs",
                 "postcss.config.mjs",
@@ -72,13 +129,7 @@ export function createBaseConfig({ prettier = true, strict = true, turbo = true,
                     "error",
                     {
                         groups: [
-                            // Node.js builtins. You could also generate this regex if you use a `.js` config.
-                            // For example: `^(${require("module").builtinModules.join("|")})(/|$)`
-                            // Note that if you use the `node:` prefix for Node.js builtins,
-                            // you can avoid this complexity: You can simply use "^node:".
-                            [
-                                "^(assert|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|https|module|net|os|path|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|tty|url|util|vm|zlib|freelist|v8|process|async_hooks|http2|perf_hooks)(/.*|$)",
-                            ],
+                            NODE_BUILTIN_IMPORT_GROUP,
                             // Packages. `react` related packages come first.
                             ["^react", "^@?\\w"],
                             // Internal packages.
@@ -129,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":"AAqBA;;;;;;;;;;;;;;;;GAgBG;AAEH;;;;;GAKG;AACH,0FAHW,OAAO,WAAW,EAAE,iBAAiB,GAAG,kBAAkB,GACxD,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CA8E5C;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.`...) —
@@ -39,9 +39,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
             ? {
@@ -102,28 +102,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.4.2",
+  "version": "0.6.0",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
@@ -45,15 +45,20 @@
     "typescript": ">=5.0.0"
   },
   "devDependencies": {
+    "@angular/core": "^21.0.0",
     "eslint": "10.7.0",
+    "rxjs": "^7.8.0",
     "typescript": "^5.9.3",
-    "@forthtilliath/typescript-config": "0.0.0"
+    "vitest": "^4.1.10",
+    "@forthtilliath/typescript-config": "0.1.0"
   },
   "scripts": {
-    "dev": "tsc --watch",
-    "build": "tsc",
+    "dev": "tsc --watch -p tsconfig.build.json",
+    "build": "tsc -p tsconfig.build.json",
     "clean": "rm -rf dist",
     "check-types": "tsc --noEmit",
-    "lint": "eslint . --max-warnings 0"
+    "lint": "eslint . --max-warnings 0",
+    "test": "vitest run",
+    "test:watch": "vitest"
   }
 }