@forthtilliath/eslint-config 0.1.0

package/README.md

@@ -0,0 +1,92 @@
+# @forthtilliath/eslint-config
+
+Shared ESLint flat configs (`eslint.config.js`/`.ts`) — for every package/app
+in this monorepo, and for any other project that wants the same setup via a
+single import instead of hand-assembling a dozen plugins. Built on
+`typescript-eslint`'s `strictTypeChecked` + `stylisticTypeChecked` presets,
+with import sorting, Turborepo's own lint plugin, and Prettier
+conflict-resolution baked in.
+
+## Install
+
+```bash
+npm install --save-dev @forthtilliath/eslint-config eslint typescript
+```
+
+Or, from within this monorepo, as a workspace dependency:
+
+```json
+{
+  "devDependencies": {
+    "@forthtilliath/eslint-config": "workspace:*"
+  }
+}
+```
+
+`eslint` and `typescript` are peer dependencies — install them yourself (any
+recent flat-config-era ESLint 9+/10+, and TypeScript 5+). Every ESLint plugin
+each variant actually uses (`typescript-eslint`, `eslint-plugin-react`,
+`angular-eslint`, etc.) ships as a regular dependency of this package, so
+there's nothing else to install per variant.
+
+## Usage
+
+Pick the variant that matches the package, in its `eslint.config.ts`:
+
+```ts
+// A plain TypeScript library (packages/lib, packages/types)
+import { baseConfig } from "@forthtilliath/eslint-config";
+export default baseConfig;
+```
+
+```ts
+// A React library (packages/react/*)
+import { reactConfig } from "@forthtilliath/eslint-config/react";
+export default reactConfig;
+```
+
+```ts
+// A Next.js app (apps/web)
+import { nextJsConfig } from "@forthtilliath/eslint-config/nextjs";
+export default nextJsConfig;
+```
+
+```ts
+// A Storybook app (apps/react-sb)
+import { storybookConfig } from "@forthtilliath/eslint-config/storybook";
+export default storybookConfig;
+```
+
+```ts
+// An Angular app/library
+import { angularConfig } from "@forthtilliath/eslint-config/angular";
+export default angularConfig;
+```
+
+All five are **named** exports — a default import (`import config from "..."`)
+resolves to the whole module namespace object instead of the config array and
+crashes ESLint's flat-config loader outright. Two of the five variants had
+exactly this bug at one point; use the named-import form above.
+
+Each variant is additive: `reactConfig`/`angularConfig` extend `baseConfig`,
+`nextJsConfig`/`storybookConfig` extend `reactConfig`.
+
+### Typed linting and non-project files
+
+Rules that need type information (`consistent-type-exports`,
+`naming-convention`, etc.) are scoped to `**/*.{ts,tsx,mts,cts}` only, and
+`eslint.config.js`/`.ts`, `storybook-static/**` and `dist/**` are excluded
+from linting entirely — none of them belong to a package's own `tsconfig`
+project, so type-aware rules crash on them otherwise.
+
+## Scripts
+
+```bash
+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/)
+```
+
+Run `pnpm run build` after editing `src/*.js` — consuming packages resolve
+`@forthtilliath/eslint-config/*` to `dist/*.js`, not the source.

package/dist/angular.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A custom ESLint configuration for Angular applications/libraries.
+ *
+ * Assumes the standard Angular CLI selector prefix ("app") set by `ng new`;
+ * for a project generated with a different `--prefix`, override
+ * `@angular-eslint/directive-selector` / `@angular-eslint/component-selector`
+ * locally after spreading this config.
+ *
+ * @type {import("eslint").Linter.Config[]} */
+export const angularConfig: import("eslint").Linter.Config[];
+//# sourceMappingURL=angular.d.ts.map

package/dist/angular.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"angular.d.ts","sourceRoot":"","sources":["../src/angular.js"],"names":[],"mappings":"AAMA;;;;;;;;8CAQ8C;AAC9C,4BADU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAwCvC"}

package/dist/angular.js

@@ -0,0 +1,53 @@
+import angular from "angular-eslint";
+import { defineConfig } from "eslint/config";
+import tseslint from "typescript-eslint";
+import { baseConfig } from "./base.js";
+/**
+ * A custom ESLint configuration for Angular applications/libraries.
+ *
+ * Assumes the standard Angular CLI selector prefix ("app") set by `ng new`;
+ * for a project generated with a different `--prefix`, override
+ * `@angular-eslint/directive-selector` / `@angular-eslint/component-selector`
+ * locally after spreading this config.
+ *
+ * @type {import("eslint").Linter.Config[]} */
+export const angularConfig = defineConfig([
+    ...baseConfig,
+    {
+        // Build/cache artifacts specific to the Angular CLI (baseConfig only knows
+        // about generic dist/**) : without this, ESLint also lints the bundled,
+        // minified Vite dep cache and reports thousands of spurious errors on it.
+        ignores: [".angular/**", "dist/**", "coverage/**"],
+    },
+    {
+        files: ["**/*.ts"],
+        extends: [angular.configs.tsRecommended],
+        processor: angular.processInlineTemplates,
+        rules: {
+            "@angular-eslint/directive-selector": [
+                "error",
+                { type: "attribute", prefix: "app", style: "camelCase" },
+            ],
+            "@angular-eslint/component-selector": [
+                "error",
+                { type: "element", prefix: "app", style: "kebab-case" },
+            ],
+            // 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",
+        },
+    },
+    {
+        // baseConfig's tseslint.configs.strictTypeChecked/stylisticTypeChecked apply
+        // with no `files` restriction, so without this they leak onto templates
+        // (parsed by angular-eslint/template-parser, which has no type information)
+        // and crash on the first type-aware rule ESLint tries to load.
+        files: ["**/*.html"],
+        extends: [
+            tseslint.configs.disableTypeChecked,
+            angular.configs.templateRecommended,
+            angular.configs.templateAccessibility,
+        ],
+        rules: {},
+    },
+]);

package/dist/base.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A shared ESLint configuration for the repository.
+ *
+ * @type {import("eslint").Linter.Config[]}
+ * */
+export const baseConfig: import("eslint").Linter.Config[];
+//# sourceMappingURL=base.d.ts.map

package/dist/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.js"],"names":[],"mappings":"AAQA;;;;KAIK;AACL,yBAFU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAiIvC"}

package/dist/base.js

@@ -0,0 +1,140 @@
+import eslint from "@eslint/js";
+import { defineConfig } from "eslint/config";
+import eslintConfigPrettier from "eslint-config-prettier";
+import simpleImportSortPlugin from "eslint-plugin-simple-import-sort";
+import turboPlugin from "eslint-plugin-turbo";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+/**
+ * A shared ESLint configuration for the repository.
+ *
+ * @type {import("eslint").Linter.Config[]}
+ * */
+export const baseConfig = defineConfig([
+    eslint.configs.recommended,
+    tseslint.configs.strictTypeChecked,
+    tseslint.configs.stylisticTypeChecked,
+    {
+        ignores: [
+            "dist/**",
+            "storybook-static/**",
+            "postcss.config.cjs",
+            "postcss.config.mjs",
+            "eslint.config.js",
+            "eslint.config.mjs",
+            "eslint.config.cjs",
+            "eslint.config.ts",
+        ],
+    },
+    {
+        languageOptions: {
+            // Globaux Node (process, __dirname, module, require...) : la config
+            // partagée elle-même s'exécute sous Node (ex. process.cwd() ci-dessous),
+            // et la plupart des consommateurs (scripts, configs, apps Next.js côté
+            // serveur) en ont aussi besoin. Sans risque de collision avec les
+            // globaux navigateur ajoutés par les configs plus spécifiques
+            // (react.js, nextjs.js) qui étendent celle-ci.
+            globals: {
+                ...globals.node,
+            },
+            parserOptions: {
+                projectService: true,
+                tsconfigRootDir: process.cwd(),
+            },
+        },
+    },
+    {
+        files: ["**/*.js"],
+        extends: [tseslint.configs.disableTypeChecked],
+    },
+    {
+        plugins: {
+            "simple-import-sort": simpleImportSortPlugin,
+        },
+        rules: {
+            "simple-import-sort/imports": [
+                "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)(/.*|$)",
+                        ],
+                        // Packages. `react` related packages come first.
+                        ["^react", "^@?\\w"],
+                        // Internal packages.
+                        ["^(@forthtilliath)(/.*|$)"],
+                        ["^(@|@ui|components|utils|config)(/.*|$)"],
+                        // Side effect imports.
+                        ["^\\u0000"],
+                        // Parent imports. Put `..` last.
+                        ["^\\.\\.(?!/?$)", "^\\.\\./?$"],
+                        // Other relative imports. Put same-folder imports and `.` last.
+                        ["^\\./(?=.*/)(?!/?$)", "^\\.(?!/?$)", "^\\./?$"],
+                        // Style imports.
+                        ["^.+\\.s?css$"],
+                    ],
+                },
+            ],
+            "simple-import-sort/exports": "error",
+        },
+    },
+    {
+        plugins: {
+            turbo: turboPlugin,
+        },
+        rules: {
+            "turbo/no-undeclared-env-vars": "error",
+        },
+    },
+    {
+        files: ["**/*.{ts,tsx,mts,cts}"],
+        plugins: {},
+        rules: {
+            // "@typescript-eslint/no-unused-vars": "error",
+            "@typescript-eslint/ban-ts-comment": "error",
+            "@typescript-eslint/ban-tslint-comment": "error",
+            "@typescript-eslint/consistent-type-exports": "error",
+            "@typescript-eslint/consistent-type-imports": "error",
+            "@typescript-eslint/method-signature-style": "error",
+            // ignoreStatic : sans ca, une reference a une methode statique (ex.
+            // Validators.required dans un FormBuilder Angular) est a tort consideree
+            // comme "unbound" alors qu'une methode statique n'a pas de `this` a lier.
+            "@typescript-eslint/unbound-method": ["error", { ignoreStatic: true }],
+            // allowNumber : tres courant de construire une URL avec un id numerique
+            // (`${this.baseUrl}/${id}`) ; sans ca, chaque service HTTP typique
+            // declenche une erreur pour un usage parfaitement sur.
+            "@typescript-eslint/restrict-template-expressions": [
+                "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"],
+                },
+            ],
+        },
+    },
+    eslintConfigPrettier,
+]);

package/dist/nextjs.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A custom ESLint configuration for libraries that use Next.js.
+ *
+ * @type {import("eslint").Linter.Config[]}
+ * */
+export const nextJsConfig: import("eslint").Linter.Config[];
+//# sourceMappingURL=nextjs.d.ts.map

package/dist/nextjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nextjs.d.ts","sourceRoot":"","sources":["../src/nextjs.js"],"names":[],"mappings":"AAWA;;;;KAIK;AACL,2BAFU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAiEvC"}

package/dist/nextjs.js

@@ -0,0 +1,78 @@
+import js from "@eslint/js";
+import pluginNext from "@next/eslint-plugin-next";
+import { defineConfig } from "eslint/config";
+import eslintConfigPrettier from "eslint-config-prettier";
+import pluginReact from "eslint-plugin-react";
+import pluginReactHooks from "eslint-plugin-react-hooks";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import { baseConfig } from "./base.js";
+/**
+ * A custom ESLint configuration for libraries that use Next.js.
+ *
+ * @type {import("eslint").Linter.Config[]}
+ * */
+export const nextJsConfig = defineConfig([
+    {
+        ignores: [".next/**", "next-env.d.ts"],
+    },
+    ...baseConfig,
+    js.configs.recommended,
+    eslintConfigPrettier,
+    ...tseslint.configs.recommended,
+    {
+        ...pluginReact.configs.flat.recommended,
+        languageOptions: {
+            ...pluginReact.configs.flat.recommended.languageOptions,
+            globals: {
+                ...globals.serviceworker,
+            },
+        },
+    },
+    {
+        plugins: {
+            "@next/next": pluginNext,
+        },
+        rules: {
+            ...pluginNext.configs.recommended.rules,
+            ...pluginNext.configs["core-web-vitals"].rules,
+        },
+    },
+    {
+        plugins: {
+            "react-hooks": pluginReactHooks,
+        },
+        settings: { react: { version: "19" } },
+        rules: {
+            ...pluginReactHooks.configs.recommended.rules,
+            // React scope no longer necessary with new JSX transform.
+            "react/react-in-jsx-scope": "off",
+        },
+    },
+    {
+        rules: {
+            "@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"],
+                },
+            ],
+        },
+    },
+]);

package/dist/react.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A custom ESLint configuration for libraries that use React.
+ *
+ * @type {import("eslint").Linter.Config[]} */
+export const reactConfig: import("eslint").Linter.Config[];
+//# sourceMappingURL=react.d.ts.map

package/dist/react.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.js"],"names":[],"mappings":"AASA;;;8CAG8C;AAC9C,0BADU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CA8DvC"}

package/dist/react.js

@@ -0,0 +1,73 @@
+import pluginEslintReact from "@eslint-react/eslint-plugin";
+import { defineConfig } from "eslint/config";
+import pluginReact from "eslint-plugin-react";
+import pluginReactHooks from "eslint-plugin-react-hooks";
+import pluginReactRefresh from "eslint-plugin-react-refresh";
+import globals from "globals";
+import { baseConfig } from "./base.js";
+/**
+ * A custom ESLint configuration for libraries that use React.
+ *
+ * @type {import("eslint").Linter.Config[]} */
+export const reactConfig = defineConfig([
+    ...baseConfig,
+    pluginReact.configs.flat["jsx-runtime"],
+    pluginEslintReact.configs["recommended-type-checked"],
+    {
+        languageOptions: {
+            ...pluginReact.configs.flat.recommended.languageOptions,
+            globals: {
+                ...globals.serviceworker,
+                ...globals.browser,
+            },
+        },
+    },
+    {
+        plugins: {
+            "react-hooks": pluginReactHooks,
+        },
+        settings: { react: { version: "19" } },
+        rules: {
+            ...pluginReactHooks.configs.recommended.rules,
+            // React scope no longer necessary with new JSX transform.
+            "react/react-in-jsx-scope": "off",
+        },
+    },
+    {
+        // in main config for TSX/JSX source files
+        plugins: {
+            "react-refresh": pluginReactRefresh,
+        },
+        rules: {
+            "react-refresh/only-export-components": "error",
+        },
+    },
+    {
+        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"],
+                },
+            ],
+        },
+    },
+]);

package/dist/storybook.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A custom ESLint configuration for libraries that use React.
+ *
+ * @type {import("eslint").Linter.Config[]} */
+export const storybookConfig: import("eslint").Linter.Config[];
+//# sourceMappingURL=storybook.d.ts.map

package/dist/storybook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storybook.d.ts","sourceRoot":"","sources":["../src/storybook.js"],"names":[],"mappings":"AAKA;;;8CAG8C;AAC9C,8BADU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAiBvC"}

package/dist/storybook.js

@@ -0,0 +1,24 @@
+import { defineConfig } from "eslint/config";
+import storybook from "eslint-plugin-storybook";
+import { reactConfig } from "./react.js";
+/**
+ * A custom ESLint configuration for libraries that use React.
+ *
+ * @type {import("eslint").Linter.Config[]} */
+export const storybookConfig = defineConfig([
+    ...reactConfig,
+    ...storybook.configs["flat/recommended"],
+    {
+        ignores: ["!.storybook"],
+    },
+    {
+        // 👇 This should match the `stories` property in .storybook/main.js|ts
+        files: ["**/*.stories.@(ts|tsx|js|jsx|mjs|cjs)"],
+        rules: {
+            // 👇 Enable this rule
+            "storybook/csf-component": "error",
+            // 👇 Disable this rule
+            "storybook/default-exports": "off",
+        },
+    },
+]);

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@forthtilliath/eslint-config",
+  "version": "0.1.0",
+  "type": "module",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Forthtilliath/forthtilliath-packages.git",
+    "directory": "packages/eslint-config"
+  },
+  "homepage": "https://github.com/Forthtilliath/forthtilliath-packages/tree/main/packages/eslint-config#readme",
+  "bugs": "https://github.com/Forthtilliath/forthtilliath-packages/issues",
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "check-types": "tsc --noEmit",
+    "lint": "eslint . --max-warnings 0"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": "./dist/base.js",
+    "./*": "./dist/*.js"
+  },
+  "dependencies": {
+    "@eslint-react/eslint-plugin": "^5.18.3",
+    "@eslint/js": "^10.0.1",
+    "@next/eslint-plugin-next": "^16.3.0",
+    "angular-eslint": "^21.4.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.1.1",
+    "eslint-plugin-react-refresh": "^0.5.4",
+    "eslint-plugin-simple-import-sort": "^13.0.0",
+    "eslint-plugin-storybook": "^9.1.20",
+    "eslint-plugin-turbo": "^2.10.9",
+    "globals": "^17.9.0",
+    "typescript-eslint": "^8.67.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=9.0.0",
+    "typescript": ">=5.0.0"
+  },
+  "devDependencies": {
+    "@forthtilliath/typescript-config": "workspace:*",
+    "eslint": "catalog:",
+    "typescript": "catalog:"
+  }
+}