@forthtilliath/eslint-config 0.2.1 → 0.3.0

package/README.md

@@ -93,15 +93,30 @@ import { createBaseConfig } from "@forthtilliath/eslint-config";
 export default createBaseConfig({ strict: false, turbo: false });
 ```
 
-| Option     | Default | Effect                                                                         |
-| ---------- | ------- | ------------------------------------------------------------------------------ |
-| `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.                  |
+| Option           | Default | Effect                                                                                                      |
+| ---------------- | ------- | ----------------------------------------------------------------------------------------------------------- |
+| `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.                                               |
+| `a11y`           | `true`  | _(react/nextjs/storybook)_ Enable `eslint-plugin-jsx-a11y`'s recommended rules.                             |
+| `i18n`           | `false` | _(react/nextjs/storybook)_ Enable `eslint-plugin-i18next`'s `no-literal-string` rule.                       |
+| `testingLibrary` | `false` | _(react/nextjs/storybook)_ Enable `eslint-plugin-testing-library` + `eslint-plugin-jest-dom` on test files. |
 
 Options are forwarded down the chain, so `createNextJsConfig({ prettier: false })`
 also disables Prettier in the `reactConfig`/`baseConfig` layers it builds on.
 
+```ts
+// Full i18n project (next-intl, react-intl...): forbid hardcoded JSX strings
+import { createNextJsConfig } from "@forthtilliath/eslint-config/nextjs";
+export default createNextJsConfig({ i18n: true });
+```
+
+```ts
+// React Native / Expo: jsx-a11y targets DOM semantics and doesn't apply
+import { createReactConfig } from "@forthtilliath/eslint-config/react";
+export default createReactConfig({ a11y: false });
+```
+
 ### Typed linting and non-project files
 
 Rules that need type information (`consistent-type-exports`,

package/dist/nextjs.d.ts

@@ -3,10 +3,10 @@
  * {@link createReactConfig} (same React/naming-convention rules, plus
  * Next.js's own plugin).
  *
- * @param {import("./base.js").BaseConfigOptions} [options]
+ * @param {import("./base.js").BaseConfigOptions & import("./react.js").ReactConfigOptions} [options]
  * @returns {import("eslint").Linter.Config[]}
  * */
-export function createNextJsConfig(options?: import("./base.js").BaseConfigOptions): import("eslint").Linter.Config[];
+export function createNextJsConfig(options?: import("./base.js").BaseConfigOptions & import("./react.js").ReactConfigOptions): import("eslint").Linter.Config[];
 /**
  * A custom ESLint configuration for Next.js applications, with the default
  * options. Use `createNextJsConfig(options)` instead to customize it.

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,GACnC,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CA6C5C;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,CAmD5C;AAED;;;;;KAKK;AACL,2BAFU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAEO"}

package/dist/nextjs.js

@@ -6,7 +6,7 @@ import { createReactConfig } from "./react.js";
  * {@link createReactConfig} (same React/naming-convention rules, plus
  * Next.js's own plugin).
  *
- * @param {import("./base.js").BaseConfigOptions} [options]
+ * @param {import("./base.js").BaseConfigOptions & import("./react.js").ReactConfigOptions} [options]
  * @returns {import("eslint").Linter.Config[]}
  * */
 export function createNextJsConfig(options) {
@@ -46,6 +46,12 @@ export function createNextJsConfig(options) {
                             "runtime",
                             "preferredRegion",
                             "maxDuration",
+                            // icon.tsx / apple-icon.tsx / opengraph-image.tsx /
+                            // twitter-image.tsx: same convention, for the image-generation
+                            // route handlers.
+                            "alt",
+                            "size",
+                            "contentType",
                         ],
                     },
                 ],

package/dist/react.d.ts

@@ -1,14 +1,56 @@
+/**
+ * @typedef {object} ReactConfigOptions
+ * @property {boolean} [a11y=true] - Enable eslint-plugin-jsx-a11y's
+ *   recommended rules.
+ * @property {boolean} [i18n=false] - Enable eslint-plugin-i18next's
+ *   `no-literal-string` rule, forbidding any hardcoded string in JSX. Only
+ *   makes sense for a project fully committed to i18n (e.g. driven by
+ *   next-intl) — off by default since it flags every literal otherwise.
+ * @property {boolean} [testingLibrary=false] - Enable
+ *   eslint-plugin-testing-library's React rules and eslint-plugin-jest-dom's
+ *   recommended rules, scoped to test files only. Off by default:
+ *   `testing-library/no-manual-cleanup` in particular assumes
+ *   `@testing-library/*`'s automatic `afterEach(cleanup)` is active, which
+ *   only happens when `afterEach` is a real global (vitest's `test.globals:
+ *   true`, or Jest) — without that, a manual `cleanup()` call is genuinely
+ *   required and this rule would be a false positive.
+ */
 /**
  * A custom ESLint configuration for libraries that use React.
  *
- * @param {import("./base.js").BaseConfigOptions} [options]
+ * @param {import("./base.js").BaseConfigOptions & ReactConfigOptions} [options]
  * @returns {import("eslint").Linter.Config[]}
  */
-export function createReactConfig(options?: import("./base.js").BaseConfigOptions): import("eslint").Linter.Config[];
+export function createReactConfig({ a11y, i18n, testingLibrary, ...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.
  *
  * @type {import("eslint").Linter.Config[]} */
 export const reactConfig: import("eslint").Linter.Config[];
+export type ReactConfigOptions = {
+    /**
+     * - Enable eslint-plugin-jsx-a11y's
+     * recommended rules.
+     */
+    a11y?: boolean | undefined;
+    /**
+     * - Enable eslint-plugin-i18next's
+     * `no-literal-string` rule, forbidding any hardcoded string in JSX. Only
+     * makes sense for a project fully committed to i18n (e.g. driven by
+     * next-intl) — off by default since it flags every literal otherwise.
+     */
+    i18n?: boolean | undefined;
+    /**
+     * - Enable
+     * eslint-plugin-testing-library's React rules and eslint-plugin-jest-dom's
+     * recommended rules, scoped to test files only. Off by default:
+     * `testing-library/no-manual-cleanup` in particular assumes
+     * `@testing-library/*`'s automatic `afterEach(cleanup)` is active, which
+     * only happens when `afterEach` is a real global (vitest's `test.globals:
+     * true`, or Jest) — without that, a manual `cleanup()` call is genuinely
+     * required and this rule would be a false positive.
+     */
+    testingLibrary?: boolean | undefined;
+};
 //# sourceMappingURL=react.d.ts.map

package/dist/react.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"react.d.ts","sourceRoot":"","sources":["../src/react.js"],"names":[],"mappings":"AASA;;;;;GAKG;AACH,4CAHW,OAAO,WAAW,EAAE,iBAAiB,GACnC,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAuE5C;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,+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"}

package/dist/react.js

@@ -1,19 +1,66 @@
 import pluginEslintReact from "@eslint-react/eslint-plugin";
 import { defineConfig } from "eslint/config";
+import pluginI18next from "eslint-plugin-i18next";
+import pluginJestDom from "eslint-plugin-jest-dom";
+import pluginJsxA11y from "eslint-plugin-jsx-a11y";
 import pluginReact from "eslint-plugin-react";
 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";
+/**
+ * Any file matching this is a test file, whatever runner or naming
+ * convention is used to suffix it (`.test.`, `.spec.`, `.dom.test.`...) —
+ * `*` matches across dots, so `*.test.tsx` already covers `foo.dom.test.tsx`.
+ * @type {string[]}
+ */
+const TEST_FILE_GLOBS = ["**/*.{test,spec}.{ts,tsx,js,jsx}"];
+/**
+ * @typedef {object} ReactConfigOptions
+ * @property {boolean} [a11y=true] - Enable eslint-plugin-jsx-a11y's
+ *   recommended rules.
+ * @property {boolean} [i18n=false] - Enable eslint-plugin-i18next's
+ *   `no-literal-string` rule, forbidding any hardcoded string in JSX. Only
+ *   makes sense for a project fully committed to i18n (e.g. driven by
+ *   next-intl) — off by default since it flags every literal otherwise.
+ * @property {boolean} [testingLibrary=false] - Enable
+ *   eslint-plugin-testing-library's React rules and eslint-plugin-jest-dom's
+ *   recommended rules, scoped to test files only. Off by default:
+ *   `testing-library/no-manual-cleanup` in particular assumes
+ *   `@testing-library/*`'s automatic `afterEach(cleanup)` is active, which
+ *   only happens when `afterEach` is a real global (vitest's `test.globals:
+ *   true`, or Jest) — without that, a manual `cleanup()` call is genuinely
+ *   required and this rule would be a false positive.
+ */
 /**
  * A custom ESLint configuration for libraries that use React.
  *
- * @param {import("./base.js").BaseConfigOptions} [options]
+ * @param {import("./base.js").BaseConfigOptions & ReactConfigOptions} [options]
  * @returns {import("eslint").Linter.Config[]}
  */
-export function createReactConfig(options) {
+export function createReactConfig({ a11y = true, i18n = false, testingLibrary = false, ...options } = {}) {
     return defineConfig([
         ...createBaseConfig(options),
+        a11y ? pluginJsxA11y.flatConfigs.recommended : [],
+        i18n
+            ? {
+                plugins: { i18next: pluginI18next },
+                rules: { "i18next/no-literal-string": "error" },
+            }
+            : [],
+        testingLibrary
+            ? [
+                {
+                    ...pluginTestingLibrary.configs["flat/react"],
+                    files: TEST_FILE_GLOBS,
+                },
+                {
+                    ...pluginJestDom.configs["flat/recommended"],
+                    files: TEST_FILE_GLOBS,
+                },
+            ]
+            : [],
         pluginReact.configs.flat["jsx-runtime"],
         pluginEslintReact.configs["recommended-type-checked"],
         {

package/dist/storybook.d.ts

@@ -1,9 +1,9 @@
 /**
  * A custom ESLint configuration for libraries that use React and Storybook.
  *
- * @param {import("./base.js").BaseConfigOptions} [options]
+ * @param {import("./base.js").BaseConfigOptions & import("./react.js").ReactConfigOptions} [options]
  * @returns {import("eslint").Linter.Config[]} */
-export function createStorybookConfig(options?: import("./base.js").BaseConfigOptions): import("eslint").Linter.Config[];
+export function createStorybookConfig(options?: import("./base.js").BaseConfigOptions & import("./react.js").ReactConfigOptions): import("eslint").Linter.Config[];
 /**
  * A custom ESLint configuration for libraries that use React and Storybook,
  * with the default options. Use `createStorybookConfig(options)` instead to

package/dist/storybook.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storybook.d.ts","sourceRoot":"","sources":["../src/storybook.js"],"names":[],"mappings":"AAKA;;;;iDAIiD;AACjD,gDAFW,OAAO,WAAW,EAAE,iBAAiB,GACnC,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAiB5C;AAED;;;;;8CAK8C;AAC9C,8BADU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CACa"}
+{"version":3,"file":"storybook.d.ts","sourceRoot":"","sources":["../src/storybook.js"],"names":[],"mappings":"AAKA;;;;iDAIiD;AACjD,gDAFW,OAAO,WAAW,EAAE,iBAAiB,GAAG,OAAO,YAAY,EAAE,kBAAkB,GAC7E,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CAiB5C;AAED;;;;;8CAK8C;AAC9C,8BADU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CACa"}

package/dist/storybook.js

@@ -4,7 +4,7 @@ import { createReactConfig } from "./react.js";
 /**
  * A custom ESLint configuration for libraries that use React and Storybook.
  *
- * @param {import("./base.js").BaseConfigOptions} [options]
+ * @param {import("./base.js").BaseConfigOptions & import("./react.js").ReactConfigOptions} [options]
  * @returns {import("eslint").Linter.Config[]} */
 export function createStorybookConfig(options) {
     return defineConfig([

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forthtilliath/eslint-config",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
@@ -26,11 +26,15 @@
     "@next/eslint-plugin-next": "^16.3.0",
     "angular-eslint": "^21.4.0",
     "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-i18next": "^6.1.5",
+    "eslint-plugin-jest-dom": "^5.10.1",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
     "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-testing-library": "^7.16.2",
     "eslint-plugin-turbo": "^2.10.9",
     "globals": "^17.9.0",
     "typescript-eslint": "^8.67.0"