@leyman/eslint-config 0.0.0-stage → 0.0.1

package/dist/lib/internal-regex.d.ts

@@ -0,0 +1,3 @@
+import type { PackageJson } from './package-json-schema.js';
+export declare const getInternalRegex: (packageJson: PackageJson) => RegExp;
+//# sourceMappingURL=internal-regex.d.ts.map

package/dist/lib/internal-regex.js

@@ -0,0 +1,30 @@
+const packageRegex = (packageName)=>{
+    const escaped = RegExp.escape(packageName);
+    return `${escaped}(?:$|/)`;
+};
+export const getInternalRegex = (packageJson)=>{
+    const internalPackages = new Set([
+        packageJson.name
+    ]);
+    for (const dependencies of [
+        packageJson.dependencies,
+        packageJson.devDependencies,
+        packageJson.optionalDependencies,
+        packageJson.peerDependencies
+    ]){
+        if (!dependencies) {
+            continue;
+        }
+        for (const [packageName, versionSpecifier] of Object.entries(dependencies)){
+            if (versionSpecifier.startsWith('workspace:')) {
+                internalPackages.add(packageName);
+            }
+        }
+    }
+    const packageRegexUnion = [
+        ...internalPackages
+    ].toSorted((a, b)=>a.localeCompare(b, 'en')).map((packageName)=>packageRegex(packageName)).join('|');
+    return new RegExp(`^(?:${packageRegexUnion})`, 'u');
+};
+
+//# sourceMappingURL=internal-regex.js.map

package/dist/lib/legacy-rule-context.d.ts

@@ -0,0 +1,12 @@
+import type { ESLint } from 'eslint';
+/**
+ * Restore the rule context members that ESLint 10 removed, for a plugin that still calls them.
+ *
+ * `eslint-plugin-react` has no release supporting ESLint 10 yet (jsx-eslint/eslint-plugin-react#4022),
+ * and some of its rules (e.g. `jsx-filename-extension`, `forward-ref-uses-ref`) throw without these.
+ *
+ * @param plugin - plugin whose rules call the removed members
+ * @returns copy of the plugin, with each rule given a context that has them
+ */
+export declare const withLegacyRuleContext: (plugin: ESLint.Plugin) => ESLint.Plugin;
+//# sourceMappingURL=legacy-rule-context.d.ts.map

package/dist/lib/legacy-rule-context.js

@@ -0,0 +1,26 @@
+const withLegacyMembers = (context)=>Object.freeze(Object.create(context, {
+        getCwd: {
+            value: ()=>context.cwd
+        },
+        getFilename: {
+            value: ()=>context.filename
+        },
+        getPhysicalFilename: {
+            value: ()=>context.physicalFilename
+        },
+        getSourceCode: {
+            value: ()=>context.sourceCode
+        }
+    }));
+export const withLegacyRuleContext = (plugin)=>({
+        ...plugin,
+        rules: Object.fromEntries(Object.entries(plugin.rules).map(([name, rule])=>[
+                name,
+                {
+                    ...rule,
+                    create: (context)=>rule.create(withLegacyMembers(context))
+                }
+            ]))
+    });
+
+//# sourceMappingURL=legacy-rule-context.js.map

package/dist/lib/node-floor.d.ts

@@ -0,0 +1,19 @@
+import type { Linter } from 'eslint';
+import type { PackageJson } from './package-json-schema.js';
+/**
+ * The oldest Node.js major version a package supports: the major version of `engines.node` (`>=22`, `>=24.1.0`...),
+ * or the running version's when there is none, as private packages run on the toolchain only.
+ *
+ * @param packageJson - Loaded `package.json` file
+ * @returns Node.js major version
+ * @throws {Error} when `engines.node` doesn't start with `>=`
+ */
+export declare const getNodeFloor: (packageJson: PackageJson) => number;
+/**
+ * Turns off each rule that suggests an API the package's oldest supported Node.js doesn't have.
+ *
+ * @param packageJson - Loaded `package.json` file
+ * @returns The rules to turn off
+ */
+export declare const nodeFloorRules: (packageJson: PackageJson) => Linter.RulesRecord;
+//# sourceMappingURL=node-floor.d.ts.map

package/dist/lib/node-floor.js

@@ -0,0 +1,32 @@
+const apiRules = {
+    'unicorn/prefer-error-is-error': 24,
+    'unicorn/prefer-iterator-concat': 26,
+    'unicorn/prefer-iterator-zip': null,
+    'unicorn/prefer-promise-try': 23,
+    'unicorn/prefer-regexp-escape': 24,
+    'unicorn/prefer-uint8array-base64': 25,
+    'unicorn/prefer-uint8array-hex': 25
+};
+export const getNodeFloor = (packageJson)=>{
+    const range = packageJson.engines?.node;
+    if (range === undefined) {
+        return Number(process.versions.node.split('.', 1)[0]);
+    }
+    const major = /^>=\s*(?<major>\d+)/v.exec(range)?.groups?.major;
+    if (major === undefined) {
+        throw new Error(`engines.node must be ">=<version>" to name a floor, not "${range}"`);
+    }
+    return Number(major);
+};
+export const nodeFloorRules = (packageJson)=>{
+    const floor = getNodeFloor(packageJson);
+    const rules = {};
+    for (const [rule, since] of Object.entries(apiRules)){
+        if (since === null || since > floor) {
+            rules[rule] = 'off';
+        }
+    }
+    return rules;
+};
+
+//# sourceMappingURL=node-floor.js.map

package/dist/lib/package-json-schema.d.ts

@@ -0,0 +1,56 @@
+type Dependencies = Record<string, string>;
+export interface PackageJson {
+    name: string;
+    engines?: {
+        node?: string;
+    };
+    dependencies?: Dependencies;
+    devDependencies?: Dependencies;
+    optionalDependencies?: Dependencies;
+    peerDependencies?: Dependencies;
+}
+export declare const packageJsonSchema: {
+    type: string;
+    properties: {
+        name: {
+            type: string;
+        };
+        engines: {
+            type: string;
+            properties: {
+                node: {
+                    type: string;
+                };
+            };
+        };
+        dependencies: {
+            type: string;
+            additionalProperties: {
+                type: string;
+            };
+        };
+        devDependencies: {
+            type: string;
+            additionalProperties: {
+                type: string;
+            };
+        };
+        optionalDependencies: {
+            type: string;
+            additionalProperties: {
+                type: string;
+            };
+        };
+        peerDependencies: {
+            type: string;
+            additionalProperties: {
+                type: string;
+            };
+        };
+    };
+    required: string[];
+};
+type PackageJsonAsserter = (packageJson: unknown) => asserts packageJson is PackageJson;
+export declare const assertIsPackageJson: PackageJsonAsserter;
+export {};
+//# sourceMappingURL=package-json-schema.d.ts.map

package/dist/lib/package-json-schema.js

@@ -0,0 +1,42 @@
+import { Ajv2020 } from 'ajv/dist/2020.js';
+const dependenciesSchema = {
+    type: 'object',
+    additionalProperties: {
+        type: 'string'
+    }
+};
+export const packageJsonSchema = {
+    type: 'object',
+    properties: {
+        name: {
+            type: 'string'
+        },
+        engines: {
+            type: 'object',
+            properties: {
+                node: {
+                    type: 'string'
+                }
+            }
+        },
+        dependencies: dependenciesSchema,
+        devDependencies: dependenciesSchema,
+        optionalDependencies: dependenciesSchema,
+        peerDependencies: dependenciesSchema
+    },
+    required: [
+        'name'
+    ]
+};
+const ajv = new Ajv2020({
+    strict: true
+});
+const validator = ajv.compile(packageJsonSchema);
+export const assertIsPackageJson = (packageJson)=>{
+    validator(packageJson);
+    if (validator.errors) {
+        throw new Error(`Not a valid package.json file: ${JSON.stringify(validator.errors, null, 2)}`);
+    }
+};
+
+//# sourceMappingURL=package-json-schema.js.map

package/dist/lib/package-plugins.d.ts

@@ -0,0 +1,15 @@
+import type { ESLint, Linter } from 'eslint';
+/**
+ * Turn on a package's ESLint plugin (e.g. `generated-signature/eslint`) with its recommended rules.
+ *
+ * Plugins are passed in by each project's `eslint.config.js` rather than imported here: every
+ * package devDepends on this config, so depending on a package's plugin would be circular.
+ *
+ * @param plugin - plugin with `meta.namespace` and a flat `configs.recommended`
+ * @param files - file patterns to apply the rules to
+ * @param [ignores] - file patterns to leave out, e.g. tests
+ * @returns flat config entry
+ * @throws {TypeError} if the plugin lacks a namespace or a flat recommended config
+ */
+export declare const packagePluginConfig: (plugin: ESLint.Plugin, files: readonly string[], ignores?: readonly string[]) => Linter.Config;
+//# sourceMappingURL=package-plugins.d.ts.map

package/dist/lib/package-plugins.js

@@ -0,0 +1,24 @@
+export const packagePluginConfig = (plugin, files, ignores = [])=>{
+    const namespace = plugin.meta?.namespace ?? '';
+    if (namespace === '') {
+        throw new TypeError(`ESLint plugin ${plugin.meta?.name ?? '<unnamed>'} has no meta.namespace`);
+    }
+    const recommended = plugin.configs?.recommended;
+    if (!recommended || Array.isArray(recommended) || 'extends' in recommended) {
+        throw new TypeError(`ESLint plugin ${namespace} has no flat configs.recommended object`);
+    }
+    return {
+        files: [
+            ...files
+        ],
+        ignores: [
+            ...ignores
+        ],
+        plugins: {
+            [namespace]: plugin
+        },
+        rules: recommended.rules
+    };
+};
+
+//# sourceMappingURL=package-plugins.js.map

package/dist/lib/plugins.d.ts

@@ -0,0 +1,14 @@
+import type { ESLint } from 'eslint';
+export { default as eslintConfig } from '@eslint/js';
+export declare const commentsPlugin: ESLint.Plugin;
+export declare const prettierConfig: ESLint.Plugin;
+export declare const importPlugin: ESLint.Plugin;
+export declare const jsDocPlugin: ESLint.Plugin;
+export declare const jsxA11yPlugin: ESLint.Plugin;
+export declare const nodePlugin: ESLint.Plugin;
+export declare const reactPlugin: ESLint.Plugin;
+export declare const reactHooksPlugin: ESLint.Plugin;
+export declare const regexpPlugin: ESLint.Plugin;
+export declare const sonarPlugin: ESLint.Plugin;
+export declare const unicornPlugin: ESLint.Plugin;
+//# sourceMappingURL=plugins.d.ts.map

package/dist/lib/plugins.js

@@ -0,0 +1,26 @@
+import rawCommentsPlugin from '@eslint-community/eslint-plugin-eslint-comments';
+import rawPrettierConfig from 'eslint-config-prettier';
+import rawImportPlugin from 'eslint-plugin-import-x';
+import rawJsDocPlugin from 'eslint-plugin-jsdoc';
+import rawJsxA11yPlugin from 'eslint-plugin-jsx-a11y';
+import rawNodePlugin from 'eslint-plugin-n';
+import rawReactPlugin from 'eslint-plugin-react';
+import rawReactHooksPlugin from 'eslint-plugin-react-hooks';
+import rawRegexpPlugin from 'eslint-plugin-regexp';
+import rawSonarPlugin from 'eslint-plugin-sonarjs';
+import rawUnicornPlugin from 'eslint-plugin-unicorn';
+import { withLegacyRuleContext } from './legacy-rule-context.js';
+export { default as eslintConfig } from '@eslint/js';
+export const commentsPlugin = rawCommentsPlugin;
+export const prettierConfig = rawPrettierConfig;
+export const importPlugin = rawImportPlugin;
+export const jsDocPlugin = rawJsDocPlugin;
+export const jsxA11yPlugin = rawJsxA11yPlugin;
+export const nodePlugin = rawNodePlugin;
+export const reactPlugin = withLegacyRuleContext(rawReactPlugin);
+export const reactHooksPlugin = rawReactHooksPlugin;
+export const regexpPlugin = rawRegexpPlugin;
+export const sonarPlugin = rawSonarPlugin;
+export const unicornPlugin = rawUnicornPlugin;
+
+//# sourceMappingURL=plugins.js.map

package/package.json

@@ -1,6 +1,84 @@
 {
   "name": "@leyman/eslint-config",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.1",
+  "description": "Strict, opinionated ESLint flat config for TypeScript ESM packages, generated from each package's package.json: nearly every rule on, every exception explained.",
+  "engines": {
+    "node": ">=24.15.0"
+  },
+  "type": "module",
+  "author": "JacobLey",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JacobLey/leyman.git",
+    "directory": "leyman/eslint-config"
+  },
+  "homepage": "https://github.com/JacobLey/leyman/tree/main/leyman/eslint-config#readme",
+  "bugs": {
+    "url": "https://github.com/JacobLey/leyman/issues"
+  },
+  "keywords": [
+    "eslint",
+    "eslint-config",
+    "eslintconfig",
+    "flat-config",
+    "typescript",
+    "typescript-eslint",
+    "esm",
+    "strict",
+    "opinionated",
+    "biome"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/eslint-config.js",
+    "./package-json-schema": "./dist/lib/package-json-schema.js"
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.map",
+    "!dist/tsconfig.tsbuildinfo"
+  ],
+  "dependencies": {
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.8.1",
+    "@eslint/js": "^10.0.1",
+    "@typescript-eslint/eslint-plugin": "^8.72.0",
+    "@typescript-eslint/parser": "^8.72.0",
+    "@typescript-eslint/utils": "^8.72.0",
+    "ajv": "^8.20.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-import-x": "^4.17.1",
+    "eslint-plugin-jsdoc": "^65.4.2",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-n": "^18.5.0",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.1.1",
+    "eslint-plugin-regexp": "^3.3.1",
+    "eslint-plugin-sonarjs": "^4.2.2",
+    "eslint-plugin-unicorn": "^79.0.0",
+    "globals": "^17.12.0"
+  },
+  "peerDependencies": {
+    "eslint": "^10.13.0",
+    "typescript": "*"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.6.4",
+    "@leyman/configs": "^0.0.1",
+    "@swc/cli": "^0.8.1",
+    "@swc/core": "^1.16.20",
+    "@types/chai": "^5.2.3",
+    "@types/eslint": "^9.6.1",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^24.19.2",
+    "@typescript/native": "npm:typescript@^7.0.2",
+    "c8": "^12.0.0",
+    "chai": "^6.2.2",
+    "eslint": "^10.13.0",
+    "mocha": "^12.0.3",
+    "typescript": "npm:@typescript/typescript6@^6.0.2"
+  },
+  "imports": {
+    "#internal/*": "./dist/*"
+  }
 }