@autoguru/eslint-plugin 1.6.0 → 2.0.0

package/CHANGELOG.md

@@ -1,40 +1,49 @@
 # @autoguru/eslint-plugin
 
+## 2.0.0
+
+### Major Changes
+
+- 0f9d788: Migrates to Eslint 9, maintaining the commonly needed rules in config
+  and extracting project-specific rules. The plugin continues to export the
+  legacy configs in common-js, the modern configs are exported from
+  `@autoguru/eslint-plugin/config`.
+
 ## 1.6.0
 
 ### Minor Changes
 
--   8297630: Dependency upgrades
+- 8297630: Dependency upgrades
 
 ## 1.5.0
 
 ### Minor Changes
 
--   05747b1: Added nx workspaces
+- 05747b1: Added nx workspaces
 
 ## 1.4.0
 
 ### Minor Changes
 
--   de55945: Adds sonarjs eslint rules to AutoGuru typescript eslint
+- de55945: Adds sonarjs eslint rules to AutoGuru typescript eslint
 
 ## 1.3.2
 
 ### Patch Changes
 
--   ae9cd96: Removes next eslint
+- ae9cd96: Removes next eslint
 
 ## 1.3.1
 
 ### Patch Changes
 
--   ebee6d4: GDU: Adds CSP rules @autoguru/eslint-plugin: Adds nextjs defaults
+- ebee6d4: GDU: Adds CSP rules @autoguru/eslint-plugin: Adds nextjs defaults
 
 ## 1.3.0
 
 ### Minor Changes
 
--   d80a10b: Unicorn eslint rules: Upgraded to v33
+- d80a10b: Unicorn eslint rules: Upgraded to v33
 
     Prettier: Upgrades to v2.3
 
@@ -42,47 +51,47 @@
 
 ### Minor Changes
 
--   df57e1a: Upgrades eslint packages
+- df57e1a: Upgrades eslint packages
 
 ## 1.1.5
 
 ### Patch Changes
 
--   3827266: Prettier just has itself (no more /react)
+- 3827266: Prettier just has itself (no more /react)
 
 ## 1.1.4
 
 ### Patch Changes
 
--   919e4a0: Upgraded all dev and prod deps
+- 919e4a0: Upgraded all dev and prod deps
 
 ## 1.1.3
 
 ### Patch Changes
 
--   f1dd447: The react-in-scope rule is now mute
+- f1dd447: The react-in-scope rule is now mute
 
 ## 1.1.2
 
 ### Patch Changes
 
--   4260eb3: Bumps all deps
+- 4260eb3: Bumps all deps
 
 ## 1.1.1
 
 ### Patch Changes
 
--   5567db1: Fixes some eslint rules breaking our things
+- 5567db1: Fixes some eslint rules breaking our things
 
 ## 1.1.0
 
 ### Minor Changes
 
--   bf0d849: Smaller more simple eslint config. Using less plugins, to help
-    improve eslint runs and also more granular control.
+- bf0d849: Smaller more simple eslint config. Using less plugins, to help
+  improve eslint runs and also more granular control.
 
 ## 1.0.85
 
 ### Patch Changes
 
--   b0d77f1: Mass upgrade of dependencies
+- b0d77f1: Mass upgrade of dependencies

package/configs/base/import.js

@@ -1,4 +1,3 @@
-// eslint-disable-next-line unicorn/prefer-module
 module.exports = {
 	extends: ['plugin:import/errors'],
 

package/configs/base/index.js

@@ -1,4 +1,3 @@
-/* eslint-disable unicorn/prefer-module */
 module.exports = {
 	parserOptions: {
 		sourceType: 'module',

package/configs/jest.js

@@ -1,4 +1,3 @@
-// eslint-disable-next-line unicorn/prefer-module
 module.exports = {
 	extends: ['plugin:jest/recommended'],
 

package/configs/react.js

@@ -1,4 +1,3 @@
-// eslint-disable-next-line unicorn/prefer-module
 module.exports = {
 	extends: ['plugin:react/recommended'],
 

package/configs/typescript.js

@@ -1,4 +1,3 @@
-// eslint-disable-next-line unicorn/prefer-module
 module.exports = {
 	extends: [
 		'plugin:@typescript-eslint/eslint-recommended',

package/flat-config.mjs

@@ -0,0 +1,177 @@
+import { fixupConfigRules, fixupPluginRules } from '@eslint/compat';
+import { FlatCompat } from '@eslint/eslintrc';
+import js from '@eslint/js';
+import tsParser from '@typescript-eslint/parser';
+import reactEslint from 'eslint-plugin-react';
+import reactHooks from 'eslint-plugin-react-hooks';
+import jsxA11Y from 'eslint-plugin-jsx-a11y';
+import sonarjs from 'eslint-plugin-sonarjs';
+import tseslint from 'typescript-eslint';
+import globals from 'globals';
+
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+	baseDirectory: __dirname,
+	recommendedConfig: js.configs.recommended,
+	allConfig: js.configs.all,
+});
+
+// Eslint configs for import statements
+/** @type {import('eslint').Linter.Config[]} */
+export const imports = [
+	...fixupConfigRules(compat.extends('plugin:import/errors')),
+	{
+		rules: {
+			'import/order': [
+				'error',
+				{
+					'newlines-between': 'always',
+					alphabetize: { order: 'asc' },
+					groups: [
+						'builtin',
+						'external',
+						'internal',
+						'parent',
+						'sibling',
+						'index',
+					],
+					pathGroups: [
+						{
+							pattern: '*.+(treat)',
+							group: 'index',
+							position: 'after',
+							patternOptions: { matchBase: true },
+						},
+					],
+				},
+			],
+			'import/no-unresolved': 'off', // Just too many problems...
+			'import/default': 'off',
+			'import/extensions': [
+				'error',
+				'never',
+				{
+					graphql: 'always',
+				},
+			],
+			'import/no-duplicates': 'error',
+		},
+	},
+];
+
+// Eslint base config including import
+/** @type {import('eslint').Linter.Config[]} */
+export const base = [
+	js.configs.recommended,
+	...imports,
+	...fixupConfigRules(
+		compat.extends(
+			'plugin:unicorn/recommended',
+			'plugin:promise/recommended',
+			'prettier',
+		),
+	),
+	{
+		languageOptions: {
+			globals: globals.browser,
+		},
+		rules: {
+			'no-sparse-arrays': 'warn',
+			'unicorn/filename-case': 'off',
+			'unicorn/prevent-abbreviations': 'off',
+			'unicorn/no-null': 'off',
+			'unicorn/no-reduce': 'off',
+			'unicorn/no-array-reduce': 'off',
+			'unicorn/no-array-for-each': 'off',
+			'unicorn/no-array-push-push': 'off',
+			'unicorn/prefer-global-this': 'off',
+			'unicorn/prefer-spread': 'warn',
+		},
+	},
+];
+
+// Eslint react plugins, settings and rules
+/** @type {import('eslint').Linter.Config[]} */
+export const react = [
+	...fixupConfigRules(
+		compat.extends(
+			'plugin:react/recommended',
+			'plugin:react-hooks/recommended',
+		),
+	),
+	{
+		plugins: {
+			react: fixupPluginRules(reactEslint),
+			'react-hooks': fixupPluginRules(reactHooks),
+			'jsx-a11y': jsxA11Y,
+		},
+		settings: {
+			react: {
+				version: 'detect',
+			},
+		},
+		rules: {
+			'react/no-array-index-key': 'warn',
+			'react/prop-types': 'off',
+			'react/display-name': 'off',
+		},
+	},
+];
+
+// TypeScript plugins, and SonarJS plugin settings and rules
+/** @type {import('eslint').Linter.Config[]} */
+export const typescript = [
+	...tseslint.configs.recommended,
+	...fixupConfigRules(
+		compat.extends(
+			'plugin:import/typescript',
+			'plugin:sonarjs/recommended-legacy',
+		),
+	),
+	{
+		plugins: {
+			sonarjs: fixupPluginRules(sonarjs),
+		},
+		languageOptions: {
+			parser: tsParser,
+			ecmaVersion: 2020,
+			sourceType: 'module',
+			parserOptions: {
+				ecmaFeatures: {
+					jsx: true,
+				},
+			},
+		},
+		settings: {
+			'import/resolver': {
+				typescript: {},
+			},
+		},
+		rules: {
+			'sonarjs/no-duplicate-string': 'warn',
+			'sonarjs/no-nested-template-literals': 'warn',
+			'sonarjs/slow-regex': 'warn',
+			'sonarjs/todo-tag': 'off',
+		},
+	},
+];
+
+/** @type {import('eslint').Linter.Config[]} */
+export const jest = [
+	...fixupConfigRules(
+		compat.extends('plugin:jest/recommended').map((config) => ({
+			...config,
+			files: ['**/jest.*js', '**/*.spec.{js,jsx}'],
+			languageOptions: {
+				globals: {
+					...globals.jest,
+					...globals.node,
+				},
+			},
+		})),
+	),
+];

package/index.js

@@ -1,4 +1,3 @@
-/* eslint-disable unicorn/prefer-module */
 module.exports = {
 	configs: {
 		base: require('./configs/base'),

package/jest.config.js

@@ -1,5 +1,3 @@
-/* eslint-disable unicorn/prefer-module */
 module.exports = {
-	// eslint-disable-next-line import/extensions
 	displayName: require('./package.json').name,
 };

package/package.json

@@ -1,37 +1,45 @@
 {
 	"name": "@autoguru/eslint-plugin",
-	"version": "1.6.0",
+	"version": "2.0.0",
 	"description": "AutoGuru's shareable eslint config and custom plugins",
 	"homepage": "https://github.com/autoguru-au/octane/tree/master/packages/eslint-plugin#readme",
 	"repository": "https://github.com/autoguru-au/octane/tree/master/packages/eslint-plugin",
 	"license": "MIT",
 	"main": "index.js",
+	"exports": {
+		"./config": {
+			"import": "./flat-config.mjs"
+		}
+	},
 	"scripts": {
 		"build": "echo \"no op\""
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "^7.8.0",
-		"@typescript-eslint/parser": "^7.8.0",
-		"eslint-config-prettier": "^8.3.0",
-		"eslint-import-resolver-typescript": "^2.4.0",
-		"eslint-plugin-import": "^2.23.4",
-		"eslint-plugin-jsx-a11y": "^6.4.1",
-		"eslint-plugin-promise": "^5.1.0",
-		"eslint-plugin-react": "^7.24.0",
-		"eslint-plugin-react-hooks": "^4.2.0",
-		"eslint-plugin-sonarjs": "^0.19.0",
-		"eslint-plugin-unicorn": "^33.0.1"
+		"@eslint/compat": "^1.2.6",
+		"@eslint/eslintrc": "^3.2.0",
+		"@eslint/js": "^9.20.0",
+		"@typescript-eslint/parser": "^8.24.1",
+		"eslint-config-prettier": "^10.0.1",
+		"eslint-import-resolver-typescript": "^3.8.2",
+		"eslint-plugin-import": "^2.31.0",
+		"eslint-plugin-jest": "^26.9.0",
+		"eslint-plugin-jsx-a11y": "^6.10.2",
+		"eslint-plugin-promise": "^7.2.1",
+		"eslint-plugin-react": "^7.37.4",
+		"eslint-plugin-react-hooks": "^5.1.0",
+		"eslint-plugin-sonarjs": "^3.0.2",
+		"eslint-plugin-unicorn": "^56.0.0",
+		"globals": "^15.15.0",
+		"typescript-eslint": "^8.24.1"
 	},
 	"peerDependencies": {
-		"eslint": ">=7",
-		"eslint-plugin-jest": ">=24"
+		"eslint": ">=7"
 	},
 	"publishConfig": {
 		"access": "public"
 	},
 	"devDependencies": {
-		"@types/eslint": "^7.2.13",
-		"eslint": "^7.28.0",
-		"eslint-plugin-jest": "^24.3.6"
+		"@types/eslint": "^9.6.1",
+		"eslint": "^9.20.1"
 	}
 }

package/readme.md

@@ -7,7 +7,29 @@ yarn add --dev @autoguru/eslint-plugin \
 	eslint
 ```
 
-then in your `package.json` or `.eslintrc.yml` file:
+Modern eslint requires the flat config format and the package exports config for
+use with eslint.config.m/js.
+
+```js
+import { base, react, typescript } from '@autoguru/eslint-plugin/config';
+
+/** @type {import('eslint').Linter.Config[]} */
+export default [
+	...base,
+	...typescript,
+	...react,
+	{
+		rules: {
+			// custom rules as normal
+		},
+	},
+];
+```
+
+### Legacy eslint
+
+For versions prior to 9, configure it by extending your `package.json` or
+`.eslintrc.yml` file:
 
 ```yml
 extends:
@@ -16,3 +38,7 @@ extends:
     - 'plugin:@autoguru/react' // react and react hook checks
     - 'plugin:@autoguru/jest' // jest, so we test better
 ```
+
+If there are incompabitiblities with a version of eslint plugin coming from the
+@autoguru/eslint-plugin, you may need to pin an older version by using package
+file resolutions.