@newhighsco/eslint-config 4.2.9 → 5.0.1

package/README.md

@@ -12,22 +12,24 @@ npm install --save-dev eslint @newhighsco/eslint-config
 
 ### Prettier
 
-`@newhighsco/eslint-config` should be used in conjunction with [Prettier](https://prettier.io/). See the [`@newhighsco/prettier-config` installation guide](https://github.com/newhighsco/prettier-config#installation) for more details.
+`@newhighsco/eslint-config` should be used in conjunction with [Prettier](https://prettier.io/). See the [`@newhighsco/prettier-config` installation guide](../prettier-config#installation) for more details.
 
 ## Usage
-New High Score ESLint rules come bundled in `@newhighsco/eslint-config`. To enable these rules, add an `eslintConfig` property in your `package.json`. See the [ESLint configuration docs](https://eslint.org/docs/user-guide/configuring) for more details.
+New High Score ESLint rules come bundled in `@newhighsco/eslint-config`. To enable these rules, add an `eslint.config.js` at the root of your project. See the [ESLint configuration docs](https://eslint.org/docs/user-guide/configuring) for more details.
 
-```json
-"eslintConfig": {
-  "extends": ["@newhighsco"]
-}
+```javascript
+// `eslint.config.js`
+import config from '@newhighsco/eslint-config'
+import { defineConfig } from 'eslint/config'
+
+export default defineConfig([{ extends: [config] }])
 ```
 
 Now you can run ESLint by adding the following scripts to your `package.json`. See the [ESLint CLI docs](https://eslint.org/docs/user-guide/command-line-interface) for more details.
 
 ```json
 "scripts": {
-  "lint:js": "eslint --cache --ignore-path .gitignore .",
+  "lint:js": "eslint --cache .",
   "format:js": "yarn lint:js --fix"
 }
 ```

package/eslint.config.js

@@ -0,0 +1,98 @@
+import { existsSync } from 'node:fs'
+import { join } from 'node:path'
+
+import { includeIgnoreFile } from '@eslint/compat'
+import { FlatCompat } from '@eslint/eslintrc'
+import { defineConfig } from 'eslint/config'
+
+const gitignore = join(process.cwd(), '.gitignore')
+const compat = new FlatCompat()
+const ignore = existsSync(gitignore)
+const typescript = await import('typescript')
+  .then(() => true)
+  .catch(() => false)
+
+export default defineConfig(
+  [
+    ...compat.config({
+      parserOptions: { requireConfigFile: false },
+      env: { jest: true },
+      extends: ['standard', 'plugin:prettier/recommended'],
+      ignorePatterns: ['!.github', '!.storybook'],
+      plugins: ['simple-import-sort'],
+      rules: {
+        'simple-import-sort/imports': 'error',
+        'simple-import-sort/exports': 'error'
+      },
+      overrides: [
+        // JSON
+        {
+          files: ['**/*.json'],
+          extends: [
+            'plugin:json/recommended-legacy',
+            'plugin:prettier/recommended'
+          ]
+        },
+        // Typescript
+        typescript && {
+          files: ['*.ts?(x)'],
+          extends: ['love', 'plugin:prettier/recommended'],
+          parserOptions: {
+            project: './tsconfig.json',
+            warnOnUnsupportedTypeScriptVersion: false
+          },
+          plugins: ['tsc'],
+          rules: {
+            'tsc/config': ['error', { configFile: './tsconfig.json' }],
+            '@typescript-eslint/consistent-type-assertions': [
+              'error',
+              { assertionStyle: 'as', objectLiteralTypeAssertions: 'allow' }
+            ],
+            '@typescript-eslint/no-unsafe-argument': 'off',
+            '@typescript-eslint/prefer-nullish-coalescing': 'off',
+            '@typescript-eslint/strict-boolean-expressions': 'off'
+          }
+        },
+        // React
+        {
+          files: ['*.{js,ts,md}x'],
+          env: { browser: true },
+          extends: [
+            'standard-react',
+            'standard-jsx',
+            'plugin:prettier/recommended',
+            'plugin:jsx-a11y/recommended',
+            'plugin:mdx/recommended'
+          ],
+          rules: {
+            // Overrides standard-react
+            'jsx-quotes': ['error', 'prefer-double']
+          }
+        },
+        // Storybook
+        {
+          files: ['*.stories.*'],
+          extends: [
+            'plugin:storybook/recommended',
+            'plugin:storybook/csf-strict'
+          ],
+          rules: { 'storybook/meta-inline-properties': 'error' }
+        },
+        // Testing Library
+        {
+          files: ['*.spec.*'],
+          extends: ['plugin:testing-library/react'],
+          rules: {
+            'testing-library/no-node-access': [
+              'error',
+              { allowContainerFirstChild: true }
+            ]
+          }
+        },
+        // Cypress
+        { files: ['*.cy.*'], extends: ['plugin:cypress/recommended'] }
+      ]
+    }),
+    ignore && includeIgnoreFile(gitignore)
+  ].filter(Boolean)
+)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@newhighsco/eslint-config",
   "description": "New High Score shareable config for ESLint",
-  "version": "4.2.9",
+  "version": "5.0.1",
   "author": "New High Score",
   "license": "ISC",
   "private": false,
@@ -14,12 +14,15 @@
   "bugs": {
     "url": "https://github.com/newhighsco/config/issues"
   },
-  "main": "index.js",
+  "type": "module",
+  "main": "eslint.config.js",
   "scripts": {
     "test": "eslint --format junit --output-file ../../reports/eslint-config.xml __tests__"
   },
   "files": [],
   "dependencies": {
+    "@eslint/compat": "1.4.0",
+    "@eslint/eslintrc": "3.3.1",
     "@typescript-eslint/eslint-plugin": "7.18.0",
     "@typescript-eslint/parser": "7.18.0",
     "eslint-config-prettier": "10.1.8",
@@ -27,9 +30,10 @@
     "eslint-config-standard-jsx": "11.0.0",
     "eslint-config-standard-react": "13.0.0",
     "eslint-config-love": "44.0.0",
+    "eslint-formatter-junit": "8.40.0",
     "eslint-plugin-cypress": "3.6.0",
     "eslint-plugin-import": "2.32.0",
-    "eslint-plugin-json-format": "2.0.1",
+    "eslint-plugin-json": "4.0.1",
     "eslint-plugin-jsx-a11y": "6.10.2",
     "eslint-plugin-mdx": "3.6.2",
     "eslint-plugin-n": "17.15.1",
@@ -44,14 +48,16 @@
   },
   "devDependencies": {
     "@types/react": "19.2.2",
-    "eslint": "8.57.1"
+    "eslint": "9.38.0"
   },
   "peerDependencies": {
-    "eslint": "8.57.1",
-    "prettier": "3.6.2"
+    "eslint": "9.38.0",
+    "prettier": "3.6.2",
+    "typescript": "5.9.3"
   },
-  "eslintConfig": {
-    "root": true,
-    "extends": "."
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
   }
 }

package/index.js

@@ -1,96 +0,0 @@
-module.exports = {
-  parserOptions: {
-    requireConfigFile: false
-  },
-  env: {
-    jest: true
-  },
-  extends: ['standard', 'plugin:prettier/recommended'],
-  ignorePatterns: ['!.github', '!.storybook'],
-  plugins: ['simple-import-sort'],
-  rules: {
-    'simple-import-sort/imports': 'error',
-    'simple-import-sort/exports': 'error'
-  },
-  overrides: [
-    // JSON
-    {
-      files: ['*.json'],
-      plugins: ['json-format'],
-      settings: {
-        'json/json-with-comments-files': [],
-        'json/sort-package-json': false
-      }
-    },
-    // Typescript
-    {
-      files: ['*.ts?(x)'],
-      extends: ['love', 'plugin:prettier/recommended'],
-      parserOptions: {
-        project: './tsconfig.json',
-        warnOnUnsupportedTypeScriptVersion: false
-      },
-      plugins: ['tsc'],
-      rules: {
-        'tsc/config': [
-          'error',
-          {
-            configFile: './tsconfig.json'
-          }
-        ],
-        '@typescript-eslint/consistent-type-assertions': [
-          'error',
-          {
-            assertionStyle: 'as',
-            objectLiteralTypeAssertions: 'allow'
-          }
-        ],
-        '@typescript-eslint/no-unsafe-argument': 'off',
-        '@typescript-eslint/prefer-nullish-coalescing': 'off',
-        '@typescript-eslint/strict-boolean-expressions': 'off'
-      }
-    },
-    // React
-    {
-      files: ['*.{js,ts,md}x'],
-      env: {
-        browser: true
-      },
-      extends: [
-        'standard-react',
-        'standard-jsx',
-        'plugin:prettier/recommended',
-        'plugin:jsx-a11y/recommended',
-        'plugin:mdx/recommended'
-      ],
-      rules: {
-        // Overrides standard-react
-        'jsx-quotes': ['error', 'prefer-double']
-      }
-    },
-    // Storybook
-    {
-      files: ['**/*.stories.*'],
-      extends: ['plugin:storybook/recommended', 'plugin:storybook/csf-strict'],
-      rules: {
-        'storybook/meta-inline-properties': 'error'
-      }
-    },
-    // Testing Library
-    {
-      files: ['**/*.spec.*'],
-      extends: ['plugin:testing-library/react'],
-      rules: {
-        'testing-library/no-node-access': [
-          'error',
-          { allowContainerFirstChild: true }
-        ]
-      }
-    },
-    // Cypress
-    {
-      files: ['**/*.cy.*'],
-      extends: ['plugin:cypress/recommended']
-    }
-  ]
-}