@forthtilliath/eslint-config 0.3.0 → 0.4.0

package/README.md

@@ -63,19 +63,25 @@ import { angularConfig } from "@forthtilliath/eslint-config/angular";
 export default angularConfig;
 ```
 
-All five are **named** exports — a default import (`import config from "..."`)
+```ts
+// A React Native / Expo app
+import { reactNativeConfig } from "@forthtilliath/eslint-config/react-native";
+export default reactNativeConfig;
+```
+
+All six 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`.
+`nextJsConfig`/`storybookConfig`/`reactNativeConfig` extend `reactConfig`.
 
 ### Customizing a variant
 
 Each variant is also exported as a factory (`createBaseConfig`,
 `createReactConfig`, `createNextJsConfig`, `createStorybookConfig`,
-`createAngularConfig`) taking an options object — the plain `baseConfig`,
+`createAngularConfig`, `createReactNativeConfig`) taking an options object — the plain `baseConfig`,
 `reactConfig`, etc. exports above are just that factory called with no
 arguments. Pass options to opt out of a default:
 
@@ -93,18 +99,24 @@ 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.                                               |
-| `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. |
+| 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/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.                                                                                 |
 
 Options are forwarded down the chain, so `createNextJsConfig({ prettier: false })`
 also disables Prettier in the `reactConfig`/`baseConfig` layers it builds on.
 
+`createReactNativeConfig` also always adds `eslint-plugin-react-native`
+(`no-unused-styles`, `no-single-element-style-arrays`,
+`split-platform-components`, `no-raw-text`; `no-inline-styles` and
+`sort-styles` stay off — stylistic, not correctness) and the RN/Metro-injected
+`__DEV__` global — these aren't behind an option, unlike the toggles above.
+
 ```ts
 // Full i18n project (next-intl, react-intl...): forbid hardcoded JSX strings
 import { createNextJsConfig } from "@forthtilliath/eslint-config/nextjs";
@@ -112,9 +124,11 @@ 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 });
+// React Native / Expo, customized: same options as createReactConfig, plus
+// eslint-plugin-react-native's rules (a11y is off by default here, since
+// jsx-a11y targets DOM semantics and doesn't apply to RN)
+import { createReactNativeConfig } from "@forthtilliath/eslint-config/react-native";
+export default createReactNativeConfig({ testingLibrary: true });
 ```
 
 ### Typed linting and non-project files

package/dist/react-native.d.ts

@@ -0,0 +1,20 @@
+/**
+ * eslint-plugin-react-native only ships a legacy (eslintrc) `configs.all`
+ * export, no flat-config preset — so the plugin and its rules are wired by
+ * hand here instead of spreading a ready-made flat config like storybook.js
+ * does.
+ */
+/**
+ * A custom ESLint configuration for React Native / Expo apps.
+ *
+ * @param {import("./base.js").BaseConfigOptions & import("./react.js").ReactConfigOptions} [options]
+ * @returns {import("eslint").Linter.Config[]} */
+export function createReactNativeConfig({ a11y, ...options }?: import("./base.js").BaseConfigOptions & import("./react.js").ReactConfigOptions): import("eslint").Linter.Config[];
+/**
+ * A custom ESLint configuration for React Native / Expo apps, with the
+ * default options. Use `createReactNativeConfig(options)` instead to
+ * customize it.
+ *
+ * @type {import("eslint").Linter.Config[]} */
+export const reactNativeConfig: import("eslint").Linter.Config[];
+//# sourceMappingURL=react-native.d.ts.map

package/dist/react-native.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"react-native.d.ts","sourceRoot":"","sources":["../src/react-native.js"],"names":[],"mappings":"AAKA;;;;;GAKG;AAEH;;;;iDAIiD;AACjD,+DAFW,OAAO,WAAW,EAAE,iBAAiB,GAAG,OAAO,YAAY,EAAE,kBAAkB,GAC7E,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CA+B5C;AAED;;;;;8CAK8C;AAC9C,gCADU,OAAO,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,CACiB"}

package/dist/react-native.js

@@ -0,0 +1,52 @@
+import { defineConfig } from "eslint/config";
+import pluginReactNative from "eslint-plugin-react-native";
+import { createReactConfig } from "./react.js";
+/**
+ * eslint-plugin-react-native only ships a legacy (eslintrc) `configs.all`
+ * export, no flat-config preset — so the plugin and its rules are wired by
+ * hand here instead of spreading a ready-made flat config like storybook.js
+ * does.
+ */
+/**
+ * A custom ESLint configuration for React Native / Expo apps.
+ *
+ * @param {import("./base.js").BaseConfigOptions & import("./react.js").ReactConfigOptions} [options]
+ * @returns {import("eslint").Linter.Config[]} */
+export function createReactNativeConfig({ a11y = false, ...options } = {}) {
+    return defineConfig([
+        ...createReactConfig({ a11y, ...options }),
+        {
+            languageOptions: {
+                globals: {
+                    // Injected by Metro/React Native at build time, dead-code-eliminated
+                    // in release builds — not part of globals.node or globals.browser.
+                    __DEV__: "readonly",
+                },
+            },
+        },
+        {
+            plugins: {
+                "react-native": pluginReactNative,
+            },
+            rules: {
+                "react-native/no-unused-styles": "error",
+                "react-native/no-single-element-style-arrays": "error",
+                "react-native/split-platform-components": "error",
+                "react-native/no-raw-text": "error",
+                // Off by default: both are stylistic preferences rather than
+                // correctness checks, and inline styles in particular are a common,
+                // legitimate RN pattern (one-off layout tweaks) that Prettier already
+                // keeps readable.
+                "react-native/no-inline-styles": "off",
+                "react-native/sort-styles": "off",
+            },
+        },
+    ]);
+}
+/**
+ * A custom ESLint configuration for React Native / Expo apps, with the
+ * default options. Use `createReactNativeConfig(options)` instead to
+ * customize it.
+ *
+ * @type {import("eslint").Linter.Config[]} */
+export const reactNativeConfig = createReactNativeConfig();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forthtilliath/eslint-config",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "license": "MIT",
   "publishConfig": {
@@ -31,6 +31,7 @@
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^7.1.1",
+    "eslint-plugin-react-native": "^5.0.0",
     "eslint-plugin-react-refresh": "^0.5.4",
     "eslint-plugin-simple-import-sort": "^13.0.0",
     "eslint-plugin-storybook": "^9.1.20",