@etchteam/eslint-config 2.2.64 → 2.2.66

package/.github/workflows/ci.yml

@@ -18,4 +18,17 @@ jobs:
           node-version: ${{ matrix.version }}
           cache: npm
       - run: npm ci --no-audit --no-fund --prefer-offline
-      - run: npx --no-install eslint .
+      - run: npx --no-install eslint src
+      - name: Test ESLint config against test files (expects failures)
+        run: |
+          set +e  # Don't exit on failure
+          npx eslint test-files/ --format=compact
+          exit_code=$?
+          echo "ESLint exit code: $exit_code"
+          if [ $exit_code -eq 0 ]; then
+            echo "❌ Test files should have ESLint violations but none were found"
+            exit 1
+          else
+            echo "✅ Test files correctly show ESLint violations"
+            exit 0
+          fi

package/.husky/commit-msg

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 npx --no -- commitlint --edit ${1}

package/.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 npx --no -- lint-staged

package/CHANGELOG.md

@@ -1,6 +1,7 @@
-## [2.2.64](https://github.com/etchteam/eslint/compare/v2.2.63...v2.2.64) (2025-06-23)
+## [2.2.66](https://github.com/etchteam/eslint/compare/v2.2.65...v2.2.66) (2025-06-25)
 
 
 ### Bug Fixes
 
-* bump eslint-plugin-import from 2.31.0 to 2.32.0 ([b36eaef](https://github.com/etchteam/eslint/commit/b36eaefb59ce644899f169027157bf3200e7296d))
+* bump brace-expansion in the npm_and_yarn group ([218251f](https://github.com/etchteam/eslint/commit/218251ffa71da214d526b5abf49f8eb0ecaed06c))
+* use module syntax for release config ([563f620](https://github.com/etchteam/eslint/commit/563f620abfdd057c0bd045b3f112b87d9c4e4617))

package/README.md

@@ -2,16 +2,22 @@
 
 The eslint config that we use at [Etch](https://etch.co)
 
+**⚠️ Version 1.0.0+ requires ESLint 9** - See [migration guide](#migrating-from-eslint-8) below for upgrading.
+
 ## Install
 
 ```bash
-npm i -D eslint prettier @etchteam/eslint-config
+npm i -D eslint@^9.0.0 prettier @etchteam/eslint-config
 ```
 
 ## Usage
 
-```bash
-echo "module.exports = { extends: ['@etchteam'] };" > .eslintrc.cjs
+Create an `eslint.config.js` file in your project root:
+
+```javascript
+import etchConfig from '@etchteam/eslint-config';
+
+export default etchConfig;
 ```
 
 ### With lint-staged
@@ -50,7 +56,7 @@ echo "{ \"editor.formatOnSave\": false, \"editor.codeActionsOnSave\": { \"source
 
 # The VSCode prettier extension doesn't read the eslint config, so specific
 # prettier overrides need to go in a prettier config for format on save
-echo "module.exports = { singleQuote: true };" > prettier.config.cjs
+echo "export default { singleQuote: true };" > prettier.config.js
 
 ```
 
@@ -70,5 +76,36 @@ Run the following:
 ```bash
 # The VSCode prettier extension doesn't read the eslint config, so specific
 # prettier overrides need to go in a prettier config for format on save
-echo "module.exports = { singleQuote: true };" > prettier.config.cjs
+echo "export default { singleQuote: true };" > prettier.config.js
+```
+
+## Migrating from ESLint 8
+
+If you're upgrading from ESLint 8, follow these steps:
+
+### 1. Update Dependencies
+
+```bash
+npm install eslint@^9.0.0 @etchteam/eslint-config@^1.0.0
 ```
+
+### 2. Replace Configuration
+
+Remove your old `.eslintrc.*` files and create a new `eslint.config.js`:
+
+```javascript
+import etchConfig from '@etchteam/eslint-config';
+
+export default etchConfig;
+```
+
+### 3. Update Scripts (if needed)
+
+ESLint 9 uses flat config by default, so your existing npm scripts should work without changes.
+
+### What's Changed
+
+- **Flat config format** - More explicit and performant
+- **ESLint 9 compatibility** - Latest features and fixes
+- **Updated plugins** - All plugins updated to latest versions
+- **Reduced compatibility layer** - Only 3 plugins need compatibility wrappers

package/commitlint.config.js

@@ -1 +1 @@
-module.exports = { extends: ['@commitlint/config-conventional'] };
+export default { extends: ['@commitlint/config-conventional'] };

package/lint-staged.config.js

@@ -1,3 +1,3 @@
-module.exports = {
+export default {
   '*.{ts,tsx,js,jsx,yml,yaml,json}': 'eslint --fix',
 };

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@etchteam/eslint-config",
-  "version": "2.2.64",
+  "version": "2.2.66",
   "description": "Etch's standard eslint config",
-  "main": "src/index.js",
+  "type": "module",
+  "main": "eslint.config.mjs",
+  "exports": {
+    ".": "./eslint.config.mjs"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "release": "semantic-release"
@@ -30,25 +34,28 @@
     "lint-staged": "^16.0.0"
   },
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^7.10.0",
-    "@typescript-eslint/parser": "^7.10.0",
-    "eslint": ">=8.29.0",
-    "eslint-config-next": "^15.0.0",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-json": "^4.0.0",
-    "eslint-plugin-jsx-a11y": "^6.8.0",
-    "eslint-plugin-prettier": "^5.0.1",
-    "eslint-plugin-react": "^7.33.2",
-    "eslint-plugin-security": "^3.0.0",
-    "eslint-plugin-storybook": "^9.0.0",
+    "@eslint/compat": "^1.3.0",
+    "@eslint/js": "^9.29.0",
+    "@typescript-eslint/eslint-plugin": "^8.35.0",
+    "@typescript-eslint/parser": "^8.35.0",
+    "eslint": ">=9.0.0",
+    "eslint-config-next": "^15.3.4",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-json": "^4.0.1",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-prettier": "^5.5.0",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-security": "^3.0.1",
+    "eslint-plugin-storybook": "^9.0.13",
     "eslint-plugin-unused-imports": "^4.1.3",
-    "eslint-plugin-yml": "^1.10.0",
+    "eslint-plugin-yml": "^1.18.0",
     "eslint-plugin-you-dont-need-lodash-underscore": "^6.14.0",
-    "prettier": ">=3.0.0"
+    "prettier": ">=3.0.0",
+    "typescript-eslint": "^8.35.0"
   },
   "peerDependencies": {
-    "eslint": ">=8.29.0",
+    "eslint": ">=9.0.0",
     "prettier": ">=3.0.0"
   }
 }

package/prettier.config.js

@@ -1,3 +1,3 @@
-module.exports = {
+export default {
   singleQuote: true,
 };

package/release.config.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   branches: ['main'],
   plugins: [
     [

package/src/index.js

@@ -1,72 +1,101 @@
-module.exports = {
-  extends: [
-    'next/core-web-vitals',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:storybook/recommended',
-    'plugin:security/recommended-legacy',
-    'plugin:import/recommended',
-    'plugin:import/typescript',
-    'plugin:prettier/recommended',
-    'plugin:jsx-a11y/strict',
-    'plugin:json/recommended-legacy',
-    'plugin:you-dont-need-lodash-underscore/compatible',
-    'plugin:yml/standard',
-    'plugin:yml/prettier',
-  ],
-  plugins: ['unused-imports'],
-  parser: '@typescript-eslint/parser',
-  rules: {
-    'no-unused-vars': 'off',
-    '@typescript-eslint/no-unused-vars': 'error',
-    '@typescript-eslint/no-explicit-any': 'warn',
-    'unused-imports/no-unused-imports': 'error',
-    'unused-imports/no-unused-vars': 'off',
-    'import/order': [
-      'error',
-      {
-        'newlines-between': 'always',
-        alphabetize: {
-          order: 'asc',
-        },
-        pathGroups: [
-          {
-            pattern: '@/**',
-            group: 'parent',
+import { fixupPluginRules } from '@eslint/compat';
+import js from '@eslint/js';
+import importPlugin from 'eslint-plugin-import';
+import json from 'eslint-plugin-json';
+import jsxA11y from 'eslint-plugin-jsx-a11y';
+import prettier from 'eslint-plugin-prettier/recommended';
+import react from 'eslint-plugin-react';
+import security from 'eslint-plugin-security';
+import storybook from 'eslint-plugin-storybook';
+import unusedImports from 'eslint-plugin-unused-imports';
+import yml from 'eslint-plugin-yml';
+import youDontNeedLodash from 'eslint-plugin-you-dont-need-lodash-underscore';
+import tseslint from 'typescript-eslint';
+
+export default [
+  js.configs.recommended,
+  ...tseslint.configs.recommended,
+  security.configs.recommended,
+  ...yml.configs['flat/recommended'],
+  ...storybook.configs['flat/recommended'],
+  {
+    files: ['**/*.json'],
+    ...json.configs.recommended,
+  },
+  {
+    plugins: {
+      // Plugins with native flat config support
+      'unused-imports': unusedImports,
+
+      // Plugins requiring compatibility layer
+      import: fixupPluginRules(importPlugin),
+      'jsx-a11y': fixupPluginRules(jsxA11y),
+      'you-dont-need-lodash-underscore': fixupPluginRules(youDontNeedLodash),
+      react: fixupPluginRules(react),
+    },
+    languageOptions: {
+      parser: tseslint.parser,
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+    },
+    rules: {
+      // Migrate existing rules from src/index.js
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': 'error',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      'unused-imports/no-unused-imports': 'error',
+      'unused-imports/no-unused-vars': 'off',
+      'import/order': [
+        'error',
+        {
+          'newlines-between': 'always',
+          alphabetize: {
+            order: 'asc',
           },
-        ],
-      },
-    ],
-    'prettier/prettier': [
-      'error',
-      {
-        singleQuote: true,
-      },
-    ],
-    'jsx-a11y/anchor-ambiguous-text': 'error',
-    'jsx-a11y/no-aria-hidden-on-focusable': 'error',
-    'security/detect-object-injection': 'off',
-    'react/forbid-elements': [
-      'error',
-      {
-        forbid: [
-          { element: 'b', message: 'Do not use HTML for styling' },
-          { element: 'i', message: 'Do not use HTML for styling' },
-        ],
+          pathGroups: [
+            {
+              pattern: '@/**',
+              group: 'parent',
+            },
+          ],
+        },
+      ],
+      'prettier/prettier': [
+        'error',
+        {
+          singleQuote: true,
+        },
+      ],
+      'jsx-a11y/anchor-ambiguous-text': 'error',
+      'jsx-a11y/no-aria-hidden-on-focusable': 'error',
+      'security/detect-object-injection': 'off',
+      'react/forbid-elements': [
+        'error',
+        {
+          forbid: [
+            { element: 'b', message: 'Do not use HTML for styling' },
+            { element: 'i', message: 'Do not use HTML for styling' },
+          ],
+        },
+      ],
+      'react/jsx-no-useless-fragment': [
+        'error',
+        {
+          allowExpressions: true,
+        },
+      ],
+      'react/prefer-read-only-props': 'error',
+      'spaced-comment': 'error',
+    },
+    settings: {
+      'import/resolver': {
+        typescript: true,
+        node: true,
       },
-    ],
-    'react/jsx-no-useless-fragment': [
-      'error',
-      {
-        allowExpressions: true,
+      react: {
+        version: 'detect',
       },
-    ],
-    'react/prefer-read-only-props': 'error',
-    'spaced-comment': 'error',
-  },
-  settings: {
-    'import/resolver': {
-      typescript: true,
-      node: true,
     },
   },
-};
+  prettier, // Prettier recommended config
+];

package/test-files/test.js

@@ -0,0 +1,31 @@
+// Test file to validate ESLint configuration
+import React from 'react';
+import { useState } from 'react';
+
+// Test unused imports (should be caught)
+
+// Test unused variables
+const unusedVar = 'test';
+
+// Test React component with accessibility and other rules
+const TestComponent = () => {
+  const [count, setCount] = useState(0);
+
+  return (
+    <div>
+      {/* Test anchor without proper text */}
+      <a href="/test">click here</a>
+
+      {/* Test useless fragment */}
+      <span>text</span>
+
+      {/* Test HTML styling elements */}
+      <b>Bold text</b>
+      <i>Italic text</i>
+
+      <button onClick={() => setCount(count + 1)}>Count: {count}</button>
+    </div>
+  );
+};
+
+export default TestComponent;

package/test-files/test.json

@@ -0,0 +1,8 @@
+{
+  "name": "test",
+  "version": "1.0.0",
+  "description": "Test JSON file",
+  "scripts": {
+    "test": "echo test"
+  }
+}

package/test-files/test.yml

@@ -0,0 +1,7 @@
+name: test-config
+version: 1.0.0
+# Fixed indentation
+description: Test YAML file
+scripts:
+  test: echo test
+  build: echo build