eslint-config-gristow 2.0.20 → 3.0.0-alpha.2

package/CHANGELOG.md

@@ -0,0 +1,75 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [3.0.0] - 2025-12-24
+
+### Breaking Changes
+
+- **ESLint 9 Required**: This version requires ESLint 9.x and uses the new flat config format
+- **Flat Config Only**: The legacy `.eslintrc.*` format is no longer supported
+- **Node.js 18+**: Minimum Node.js version is now 18.0.0
+- **ES Modules**: Package is now ESM-only (`"type": "module"`)
+- **Svelte Removed**: Svelte configuration has been removed; use `sv create` or `npx sv add eslint` for Svelte projects
+
+### Added
+
+- ESLint 9 flat config with `defineConfig()` support
+- Custom Airbnb-style rule sets (replacing `eslint-config-airbnb-base` which hasn't updated for ESLint 9):
+  - `airbnb-best-practices.js` - ~65 best practice rules
+  - `airbnb-errors.js` - ~45 error prevention rules
+  - `airbnb-es6.js` - ~25 ES6+ rules
+  - `airbnb-style.js` - Style rules (formatting rules disabled for Prettier compatibility)
+  - `airbnb-variables.js` - ~12 variable-related rules
+  - `airbnb-imports.js` - ~45 import plugin rules
+- `typescript-eslint` v8 integration (combines parser and plugin)
+- `@eslint/js` for ESLint recommended rules
+- `globals` package for environment global definitions
+- Proper `exports` field in package.json
+- Automated test suite with comprehensive rule detection tests
+- `curly` rule re-enabled after Prettier config (enforces braces for all control statements)
+
+### Changed
+
+- All rule files converted from CommonJS to ES Modules
+- Configuration now uses `languageOptions` instead of `parser`/`parserOptions`/`env`
+- TypeScript project service enabled by default (`projectService: true`)
+
+### Removed
+
+- Legacy `.eslintrc.cjs` configuration
+- Svelte support (use `sv create` instead)
+- `eslint-config-airbnb-base` dependency
+- `eslint-config-airbnb-typescript` dependency
+- `@typescript-eslint/parser` (replaced by `typescript-eslint`)
+- `@typescript-eslint/eslint-plugin` (replaced by `typescript-eslint`)
+
+### Migration Guide
+
+1. Update your ESLint config file from `.eslintrc.*` to `eslint.config.js`:
+
+```javascript
+import { defineConfig } from 'eslint/config';
+import gristowConfig from 'eslint-config-gristow';
+
+export default defineConfig(
+  gristowConfig,
+  // Add your project-specific overrides here
+);
+```
+
+2. Update your `package.json` scripts:
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+3. For Svelte projects, use the ESLint setup from `sv create` or `npx sv add eslint` instead.
+
+## [2.x] - Previous Versions
+
+See git history for changes in version 2.x and earlier.

package/eslint.config.js

@@ -0,0 +1,33 @@
+// @ts-check
+/**
+ * ESLint config for the eslint-config-gristow project itself.
+ * Extends the base config and adds allowDefaultProject for test files.
+ */
+import { defineConfig } from 'eslint/config';
+import baseConfig from './index.js';
+
+export default defineConfig(
+  // Use our own base config
+  baseConfig,
+
+  // Override to allow test files that aren't in tsconfig
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: {
+          allowDefaultProject: [
+            '*.config.js',
+            '*.config.cjs',
+            '*.config.mjs',
+            '*.config.ts',
+            '.*.js',
+            '.*.cjs',
+            '.*.mjs',
+            'test/sample.js',
+            'test/fixtures/*.js',
+          ],
+        },
+      },
+    },
+  },
+);

package/index.js

@@ -1,3 +1,122 @@
-const eslintrc = require('./.eslintrc.cjs');
+// @ts-check
+/**
+ * eslint-config-gristow
+ *
+ * ESLint 9 flat config for JavaScript and TypeScript projects.
+ *
+ * Usage in your eslint.config.js:
+ *
+ * ```javascript
+ * import { defineConfig } from 'eslint/config';
+ * import gristowConfig from 'eslint-config-gristow';
+ *
+ * export default defineConfig(
+ *   gristowConfig,
+ *   // your additional config...
+ * );
+ * ```
+ */
+import { defineConfig } from 'eslint/config';
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import importPlugin from 'eslint-plugin-import';
+import globals from 'globals';
 
-module.exports = eslintrc;
+// Import our custom rule sets
+import airbnbBaseRules from './rules/airbnb-base-rules.js';
+import sharedRules from './rules/shared-rules.js';
+import importRules from './rules/import-rules.js';
+import typescriptOnlyRules from './rules/typescript-only-rules.js';
+
+/**
+ * ESLint flat config for eslint-config-gristow
+ *
+ * This configuration provides:
+ * - ESLint recommended rules
+ * - TypeScript-ESLint recommended rules
+ * - Airbnb-style rules (custom implementation for ESLint 9)
+ * - Prettier compatibility
+ * - Import plugin rules
+ */
+export default defineConfig(
+  // Global ignores
+  {
+    ignores: [
+      '**/node_modules/**',
+      '**/dist/**',
+      '**/build/**',
+      '**/.svelte-kit/**',
+    ],
+  },
+
+  // Base ESLint recommended
+  eslint.configs.recommended,
+
+  // TypeScript recommended
+  tseslint.configs.recommended,
+
+  // Main configuration
+  {
+    plugins: {
+      '@typescript-eslint': tseslint.plugin,
+      'import': importPlugin,
+    },
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        sourceType: 'module',
+        ecmaVersion: 2020,
+        projectService: {
+          // Allow common config files to be linted without being in tsconfig
+          allowDefaultProject: [
+            '*.config.js',
+            '*.config.cjs',
+            '*.config.mjs',
+            '*.config.ts',
+            '.*.js',
+            '.*.cjs',
+            '.*.mjs',
+          ],
+        },
+      },
+      globals: {
+        ...globals.browser,
+        ...globals.es2017,
+        ...globals.node,
+      },
+    },
+    settings: {
+      'import/parsers': {
+        '@typescript-eslint/parser': ['.ts', '.tsx'],
+      },
+      'import/resolver': {
+        typescript: true,
+      },
+    },
+    rules: {
+      // Apply Airbnb base rules first
+      ...airbnbBaseRules,
+      // Then our shared rules (which override some Airbnb rules)
+      ...sharedRules,
+      // Then import-specific rules
+      ...importRules,
+    },
+  },
+
+  // TypeScript-specific overrides
+  {
+    files: ['**/*.ts', '**/*.tsx'],
+    rules: typescriptOnlyRules,
+  },
+
+  // Prettier must be last to override formatting rules
+  eslintConfigPrettier,
+
+  // Re-enable curly after Prettier (we want this enforced for code safety)
+  {
+    rules: {
+      curly: ['error', 'all'],
+    },
+  },
+);

package/package.json

@@ -1,58 +1,56 @@
 {
   "name": "eslint-config-gristow",
-  "version": "2.0.20",
-  "description": "Eslint settings for Greg Ristow",
+  "version": "3.0.0-alpha.2",
+  "description": "ESLint 9 flat config for JavaScript and TypeScript projects",
+  "type": "module",
   "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./eslint.config.js": "./eslint.config.js"
+  },
   "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
+    "lint": "eslint . --ignore-pattern test/fixtures/",
+    "lint:fix": "eslint . --fix --ignore-pattern test/fixtures/",
+    "test": "node --test test/rules.test.js",
+    "test:validate": "node test/validate-config.js"
   },
-  "author": "",
+  "author": "Greg Ristow",
   "license": "ISC",
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "eslint-config",
+    "typescript",
+    "flat-config"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gristow/eslint-config-gristow"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "index.js",
+    "eslint.config.js",
+    "rules/",
+    "README.md",
+    "CHANGELOG.md"
+  ],
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.59.5",
-    "@typescript-eslint/parser": "^5.59.5",
-    "eslint": "^8.41.0",
-    "eslint-config-airbnb": "^19.0.4",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-airbnb-typescript": "^17.0.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-import-resolver-typescript": "^3.5.5",
-    "eslint-plugin-html": "^7.1.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^44.2.3",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-react": "^7.24.0",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "eslint-plugin-svelte": "^2.29.0",
-    "eslint-plugin-tsdoc": "^0.2.14",
-    "prettier": "^2.8.8"
+    "@eslint/js": "^9.0.0",
+    "eslint-config-prettier": "^10.0.0",
+    "eslint-import-resolver-typescript": "^3.6.0",
+    "eslint-plugin-import": "^2.31.0",
+    "globals": "^16.0.0",
+    "typescript-eslint": "^8.0.0"
   },
   "peerDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.59.5",
-    "@typescript-eslint/parser": "^5.59.5",
-    "eslint": ">=8.40.0",
-    "eslint-config-airbnb": "^18.2.1",
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-airbnb-typescript": "^17.0.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-import-resolver-typescript": "^3.5.5",
-    "eslint-plugin-html": "^7.1.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jsdoc": "^44.2.3",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-react": "^7.24.0",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "eslint-plugin-svelte": "^2.28.0",
-    "eslint-plugin-tsdoc": "^0.2.14",
-    "prettier": "^2.8.6",
-    "typescript": "^5.0.4"
+    "eslint": "^9.0.0",
+    "typescript": "^5.0.0"
   },
   "devDependencies": {
-    "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-tsdoc": "^0.2.14",
-    "typescript": ">=5.0.4"
+    "eslint": "^9.0.0",
+    "typescript": "^5.0.0"
   }
 }

package/readme.md

@@ -1,91 +1,101 @@
 # eslint-config-gristow
 
-A somewhat opinonated eslint configuration for js, ts and svelte.
+An opinionated ESLint configuration for JavaScript and TypeScript projects.
 
-npm install --dev eslint-config-gristow
+**Version 3.x** - ESLint 9 flat config. For ESLint 8, use version 2.x.
 
-## Local / Per Project Install
+## Installation
 
-1. `yarn add -D eslint-config-gristow`;
-2. Then we need to install everything needed by the config:
-
-```
-npx install-peerdeps --dev eslint-config-gristow
+```bash
+npm install --save-dev eslint-config-gristow eslint
 ```
 
-3. You can see in your package.json there are now a big list of devDependencies.
+## Usage
 
-4. Create a `.eslintrc` file in the root of your project's directory (it should live where package.json does). Your `.eslintrc.js` file should look like this:
+Create an `eslint.config.js` (or `eslint.config.mjs`) in your project root:
 
-```js
-  module.exports = {
-    extends: ['gristow'],
-    // This is critical for allowing the import parser to be aware
-    // of any paths configured in .tsconfig.json
-    settings: {
-      'import/resolver/typescript': {
-        project: './tsconfig.json',
-      },
-    },
-  };
+```javascript
+import { defineConfig } from 'eslint/config';
+import gristowConfig from 'eslint-config-gristow';
+
+export default defineConfig(
+  gristowConfig,
+  // Add your project-specific overrides here
+);
 ```
 
-5. If your project uses, svelte, instead extend gristow/svelte:
-```js
-  module.exports = {
-    extends: ['gristow/svelte'],
-    // This is critical for allowing the import parser to be aware
-    // of any paths configured in .tsconfig.json
+### With TypeScript Path Aliases
+
+If your project uses TypeScript path aliases, configure the import resolver:
+
+```javascript
+import { defineConfig } from 'eslint/config';
+import gristowConfig from 'eslint-config-gristow';
+
+export default defineConfig(
+  gristowConfig,
+  {
     settings: {
-      'import/resolver/typescript': {
-        project: './tsconfig.json',
+      'import/resolver': {
+        typescript: {
+          project: './tsconfig.json',
+        },
       },
     },
-  };
+  },
+);
 ```
 
-6. You can add two scripts to your package.json to lint and/or fix:
+## Scripts
+
+Add these scripts to your `package.json`:
 
 ```json
-"scripts": {
-  "lint": "eslint .",
-  "lint:fix": "eslint . --fix"
-},
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
 ```
 
-7. Now you can manually lint your code by running `npm run lint` and fix all fixable issues with `npm run lint:fix`. You probably want your editor to do this though.
-
-## With VS Code
-
-Once you have the above installed, you probably want your editor to lint and fix for you. Here are the instructions for VS Code:
+## VS Code Setup
 
-1. Install the [ESLint package](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+1. Install the [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
 
-2. Now we need to setup some VS Code settings via `Code/File` → `Preferences` → `Settings`. It's easier to enter these settings while editing the `settings.json` file, so click the `{}` icon in the top right corner:
+2. Add to your VS Code settings (`.vscode/settings.json`):
 
 ```json
-{  
+{
   "[javascript]": {
     "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": true
+      "source.fixAll.eslint": "explicit"
     }
-  },  
+  },
   "[typescript]": {
     "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": true
+      "source.fixAll.eslint": "explicit"
     }
-  },  
-  "[svelte]": {
-		"editor.defaultFormatter": "svelte.svelte-vscode",
-    "editor.formatOnSave": true,
-    "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": true
-    }    
   },
-  // This line is CRITICAL for enabling eslint checking of svelte files,
-  // otherwise they are ignored by default (despite the above!)
-  "eslint.validate": ["javascript", "typescript", "svelte"],
+  "eslint.validate": ["javascript", "typescript"],
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true
 }
 ```
+
+## What's Included
+
+This config extends:
+- ESLint recommended rules
+- TypeScript-ESLint recommended rules
+- Airbnb-style rules (custom ESLint 9 implementation)
+- Prettier compatibility
+
+## Svelte Projects
+
+For Svelte/SvelteKit projects, use the ESLint configuration provided by `sv create`
+or `npx sv add eslint`, which provides better integration with Svelte 5 and SvelteKit.
+
+## License
+
+ISC

package/rules/airbnb-base-rules.js

@@ -0,0 +1,34 @@
+/**
+ * Airbnb Base Rules Aggregator
+ * Combines all Airbnb ESLint rules for ESLint 9 compatibility
+ *
+ * This replaces the eslint-config-airbnb-base package which has not been
+ * updated for ESLint 9's flat config format.
+ *
+ * @see https://github.com/airbnb/javascript
+ */
+import bestPractices from './airbnb-best-practices.js';
+import errors from './airbnb-errors.js';
+import es6 from './airbnb-es6.js';
+import style from './airbnb-style.js';
+import variables from './airbnb-variables.js';
+import imports from './airbnb-imports.js';
+
+export default {
+  ...bestPractices,
+  ...errors,
+  ...es6,
+  ...style,
+  ...variables,
+  ...imports,
+};
+
+// Also export individual rule sets for selective use
+export {
+  bestPractices,
+  errors,
+  es6,
+  style,
+  variables,
+  imports,
+};