@byscott-io/eslint-config 0.1.0

package/README.md

@@ -0,0 +1,62 @@
+# @byscott-io/eslint-config
+
+Shared ESLint **flat-config** preset for the byscott-io fleet (React + hooks).
+
+One source of truth for eslint + plugin versions and house rules, so upgrades are
+a single-package bump instead of every repo drifting on its own config. Requires
+ESLint v9+ (flat config).
+
+## Install
+
+```bash
+yarn add -D eslint @byscott-io/eslint-config
+```
+
+The preset brings its own plugins (`eslint-plugin-react`, `eslint-plugin-react-hooks`,
+`@eslint/js`, `globals`) — you only need `eslint` itself.
+
+## Use
+
+Create `eslint.config.js` at the repo root:
+
+```js
+import byscott from "@byscott-io/eslint-config";
+
+export default byscott();
+```
+
+- Default globs: `src/**/*.{js,jsx}` and `app/javascript/**/*.{js,jsx}`.
+- Override the source globs:
+
+  ```js
+  export default byscott({ files: ["app/javascript/**/*.{js,jsx}"] });
+  ```
+
+- Add repo-specific ignores (appended to the fleet defaults):
+
+  ```js
+  export default byscott({ ignores: ["app/javascript/legacy/**"] });
+  ```
+
+- Mark Node/server files so `process` / `require` / `__dirname` aren't reported
+  as undefined (globs must be a subset of the linted files):
+
+  ```js
+  export default byscott({ node: ["**/server.js", "packages/**/src/store.js"] });
+  ```
+
+- Extend or override — the return value is a plain flat-config array:
+
+  ```js
+  export default [
+    ...byscott(),
+    { rules: { "no-console": "off" } }
+  ];
+  ```
+
+## What it enforces
+
+`@eslint/js` recommended + house style (`no-var`, `prefer-const`, `no-unused-vars`
+with `^_` escape, `no-console` as a warning) + React and React-Hooks rules
+(`rules-of-hooks` error, `exhaustive-deps` warn; `prop-types` and
+`react-in-jsx-scope` off for the modern JSX runtime).

package/index.js

@@ -0,0 +1,92 @@
+import js from "@eslint/js";
+import globals from "globals";
+import reactPlugin from "eslint-plugin-react";
+import reactHooks from "eslint-plugin-react-hooks";
+
+// Fleet-wide ESLint flat-config preset (React + hooks). One source of truth so
+// eslint + plugin versions and house rules are a single-package bump, not ~15
+// repos drifting. Extracted from corebyscott's proven v10 + flat-config setup.
+//
+// Usage in a consuming repo's eslint.config.js:
+//
+//   import byscott from "@byscott-io/eslint-config";
+//   export default byscott();                                   // default globs
+//   export default byscott({ files: ["app/javascript/**/*.{js,jsx}"] });
+//   export default byscott({ ignores: ["app/javascript/legacy/**"] });
+//   export default byscott({ node: ["**/server.js", "packages/**/src/*.js"] }); // node/server files
+
+// Source globs most fleet repos use: `src/` (packages) or `app/javascript/`
+// (Rails apps). Override per repo when the layout differs.
+export const DEFAULT_FILES = ["src/**/*.{js,jsx}", "app/javascript/**/*.{js,jsx}"];
+
+export const DEFAULT_IGNORES = [
+  "node_modules/**",
+  "dist/**",
+  "app/assets/builds/**",
+  "public/**",
+  "vendor/**",
+  "coverage/**",
+  "cypress/videos/**",
+  "cypress/screenshots/**"
+];
+
+// Returns a flat-config array. `files` scopes every rule set (including the JS
+// recommended base) so stray root scripts / config files aren't linted; `ignores`
+// is appended to the fleet defaults; `node` is a list of globs (a subset of the
+// linted files, e.g. server/build scripts) that also get Node globals so
+// `process`/`require`/`__dirname` aren't reported as undefined.
+export default function byscottReact({ files = DEFAULT_FILES, ignores = [], node = [] } = {}) {
+  const config = [
+    { ...js.configs.recommended, files },
+    {
+      files,
+      languageOptions: {
+        ecmaVersion: 2022,
+        sourceType: "module",
+        globals: {
+          ...globals.browser,
+          ...globals.es2021
+        },
+        parserOptions: {
+          ecmaFeatures: { jsx: true }
+        }
+      },
+      plugins: {
+        react: reactPlugin,
+        "react-hooks": reactHooks
+      },
+      rules: {
+        // House style
+        "no-unused-vars": ["error", { argsIgnorePattern: "^_", varsIgnorePattern: "^_", caughtErrorsIgnorePattern: "^_" }],
+        "no-console": "warn",
+        "prefer-const": "error",
+        "no-var": "error",
+
+        // React
+        "react/jsx-uses-react": "error",
+        "react/jsx-uses-vars": "error",
+        "react/prop-types": "off",
+        "react/react-in-jsx-scope": "off",
+
+        // React Hooks
+        "react-hooks/rules-of-hooks": "error",
+        "react-hooks/exhaustive-deps": "warn"
+      },
+      settings: {
+        react: { version: "detect" }
+      }
+    }
+  ];
+
+  // Node/server files: add Node globals on top so process/require/__dirname etc.
+  // aren't flagged as undefined.
+  if (node.length > 0) {
+    config.push({
+      files: node,
+      languageOptions: { globals: { ...globals.node } }
+    });
+  }
+
+  config.push({ ignores: [ ...DEFAULT_IGNORES, ...ignores ] });
+  return config;
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@byscott-io/eslint-config",
+  "version": "0.1.0",
+  "description": "Shared ESLint flat-config preset for the byscott-io fleet (React + hooks).",
+  "type": "module",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js"
+  },
+  "files": [
+    "index.js",
+    "README.md"
+  ],
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
+  },
+  "peerDependencies": {
+    "eslint": ">=9"
+  },
+  "dependencies": {
+    "@eslint/js": "^9.39.2",
+    "eslint-plugin-react": "^7.34.0",
+    "eslint-plugin-react-hooks": "^7.1.1",
+    "globals": "^17.10.0"
+  }
+}