apic-eslint-config 1.0.0

package/base.js

@@ -0,0 +1,216 @@
+import js from '@eslint/js';
+import stylistic from '@stylistic/eslint-plugin';
+import { defineConfig } from 'eslint/config';
+import importPlugin from 'eslint-plugin-import';
+import perfectionist from 'eslint-plugin-perfectionist';
+import simpleImportSort from 'eslint-plugin-simple-import-sort';
+// import eslintConfigPrettier from 'eslint-config-prettier';
+import sonarjs from 'eslint-plugin-sonarjs';
+import unicorn from 'eslint-plugin-unicorn';
+import tseslint from 'typescript-eslint';
+
+/**
+ * A shared ESLint configuration for the repository.
+ *
+ * @type {import('eslint').Linter.Config[]}
+ * */
+export const config = defineConfig(
+	js.configs.recommended,
+	tseslint.configs.recommended,
+	// eslintConfigPrettier,
+	sonarjs.configs.recommended,
+	unicorn.configs.recommended,
+	importPlugin.flatConfigs.recommended,
+	importPlugin.flatConfigs.typescript,
+	{
+		languageOptions: {
+			parserOptions: {
+				projectService: {
+					allowDefaultProject: ['*.ts'],
+				},
+			},
+		},
+		ignores: ['dist/**', 'node_modules/**', 'coverage/**', '**/*.d.ts'],
+		plugins: {
+			'@stylistic': stylistic,
+			'simple-import-sort': simpleImportSort,
+			perfectionist,
+		},
+		rules: {
+			// ESLint Possible Problems
+			'array-callback-return': 'error',
+			'no-constant-binary-expression': 'error',
+			'no-promise-executor-return': 'error',
+			'no-self-compare': 'error',
+			'no-template-curly-in-string': 'error',
+			'no-unreachable-loop': 'error',
+			'no-unused-vars': 'off',
+
+			// ESLint Suggestions
+			'arrow-body-style': ['error', 'as-needed'],
+			'block-scoped-var': 'error',
+			camelcase: [
+				'error',
+				{
+					ignoreDestructuring: true,
+					ignoreImports: true,
+					ignoreGlobals: true,
+				},
+			],
+			'no-param-reassign': [
+				'error',
+				{
+					props: true,
+				},
+			],
+			'no-restricted-syntax': ['error', 'ForInStatement', 'LabeledStatement', 'WithStatement'],
+			'no-implicit-coercion': 'error',
+			'no-console': ['error', { allow: ['error'] }],
+			'default-case': 'error',
+			'default-case-last': 'error',
+			'dot-notation': 'off',
+			eqeqeq: [
+				'error',
+				'always',
+				{
+					null: 'ignore',
+				},
+			],
+			'func-style': [
+				'error',
+				'declaration',
+				{
+					allowArrowFunctions: true,
+				},
+			],
+			'no-else-return': [
+				'error',
+				{
+					allowElseIf: false,
+				},
+			],
+			'no-alert': 'error',
+			'no-eval': 'error',
+			'no-implied-eval': 'error',
+			'no-shadow': 'off',
+			'no-empty-function': 'off',
+			'no-restricted-imports': 'off',
+			'no-lonely-if': 'error',
+			'no-loop-func': 'error',
+			'no-negated-condition': 'error',
+			'no-plusplus': 'error',
+			'object-shorthand': ['error', 'properties'],
+			'perfectionist/sort-object-types': ['error', { partitionByNewLine: true, partitionByComment: true }],
+			'perfectionist/sort-objects': ['error', { partitionByNewLine: true, partitionByComment: true }],
+			'perfectionist/sort-sets': 'error',
+			'perfectionist/sort-switch-case': 'error',
+			'perfectionist/sort-union-types': 'error',
+			'sort-keys': 'off',
+
+			// Stylistic
+			'@stylistic/padding-line-between-statements': [
+				'error',
+				{
+					blankLine: 'always',
+					prev: '*',
+					next: [
+						'return',
+						'block',
+						'multiline-block-like',
+						'multiline-expression',
+						'interface',
+						'type',
+						'function-overload',
+					],
+				},
+			],
+
+			// Typescript
+			'@typescript-eslint/consistent-generic-constructors': 'error',
+			'@typescript-eslint/consistent-type-definitions': ['error', 'type'],
+			'@typescript-eslint/consistent-type-imports': [
+				'error',
+				{
+					prefer: 'no-type-imports',
+				},
+			],
+			'@typescript-eslint/dot-notation': 'error',
+			'@typescript-eslint/no-array-delete': 'error',
+			'@typescript-eslint/no-unused-vars': [
+				'error',
+				{
+					argsIgnorePattern: '^_',
+					varsIgnorePattern: '^_',
+				},
+			],
+			'@typescript-eslint/no-empty-function': 'error',
+			'@typescript-eslint/no-restricted-imports': 'error',
+			'@typescript-eslint/no-shadow': 'error',
+			'@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
+			'@typescript-eslint/no-unnecessary-condition': 'error',
+			'@typescript-eslint/no-unnecessary-type-arguments': 'error',
+			'@typescript-eslint/prefer-reduce-type-parameter': 'error',
+			'@typescript-eslint/require-array-sort-compare': 'error',
+			'@typescript-eslint/naming-convention': [
+				'error',
+				{
+					selector: 'typeLike',
+					format: ['StrictPascalCase'],
+				},
+				{
+					selector: 'interface',
+					format: ['StrictPascalCase'],
+					custom: {
+						regex: '^I[A-Z]',
+						match: false,
+					},
+				},
+				{
+					selector: 'typeParameter',
+					format: ['PascalCase'],
+				},
+			],
+
+			// Import
+			'import/no-unresolved': 'error',
+			'import/order': 'off',
+			'import/no-named-as-default-member': 'off',
+			'import/namespace': 'off',
+			'import/no-cycle': 'error',
+
+			// Simple import
+			'simple-import-sort/exports': 'error',
+
+			// Unicorn
+			'unicorn/no-null': 'off',
+			'unicorn/prefer-ternary': 'off',
+			'unicorn/filename-case': [
+				'error',
+				{
+					cases: {
+						pascalCase: true,
+						camelCase: true,
+					},
+				},
+			],
+			'unicorn/prevent-abbreviations': [
+				'error',
+				{
+					replacements: {
+						arg: false,
+						args: false,
+						env: false,
+						envs: false,
+						fn: false,
+						param: false,
+						params: false,
+						prop: false,
+						props: false,
+						ref: false,
+						refs: false,
+					},
+				},
+			],
+		},
+	},
+);

package/package.json

@@ -0,0 +1,26 @@
+{
+	"name": "apic-eslint-config",
+	"version": "1.0.0",
+	"files": [
+		"base.js",
+		"react.js"
+	],
+	"devDependencies": {
+		"@eslint/js": "^9.39.2",
+		"@stylistic/eslint-plugin": "^5.6.1",
+		"@types/eslint-plugin-jsx-a11y": "^6.10.1",
+		"eslint-config-prettier": "^10.1.8",
+		"eslint-plugin-import": "^2.32.0",
+		"eslint-plugin-jsx-a11y": "^6.10.2",
+		"eslint-plugin-perfectionist": "^5.1.0",
+		"eslint-plugin-react": "^7.37.5",
+		"eslint-plugin-react-hooks": "^7.0.1",
+		"eslint-plugin-simple-import-sort": "^12.1.1",
+		"eslint-plugin-sonarjs": "^3.0.5",
+		"eslint-plugin-unicorn": "^62.0.0",
+		"typescript-eslint": "^8.50.1"
+	},
+	"peerDependencies": {
+		"eslint": ">= 9"
+	}
+}

package/react.js

@@ -0,0 +1,126 @@
+import { defineConfig } from 'eslint/config';
+import pluginJsxA11y from 'eslint-plugin-jsx-a11y';
+import pluginReact from 'eslint-plugin-react';
+import pluginReactHooks from 'eslint-plugin-react-hooks';
+
+import * as base from './base';
+
+/**
+ * A custom ESLint configuration for libraries that use React.
+ *
+ * @type {import('eslint').Linter.Config[]} */
+export const config = defineConfig(
+  base.config,
+  pluginReact.configs.flat.recommended,
+  pluginReact.configs.flat['jsx-runtime'],
+  pluginReactHooks.configs.flat.recommended,
+  pluginJsxA11y.flatConfigs.recommended,
+  {
+    rules: {
+      // React
+      // 'react/boolean-prop-naming': ['error', {
+      //     rule: '^(is|has)[A-Z]([A-Za-z0-9]?)+',
+      //     message: 'Property \'{{ propName }}\' should start with 'is' or 'has'.'
+      // }],
+      'react/button-has-type': 'error',
+      'react/display-name': ['off', { ignoreTranspilerName: false }],
+      'react/forbid-component-props': ['off', { forbid: [] }],
+      'react/forbid-elements': ['off', { forbid: [] }],
+      'react/function-component-definition': [
+        'error',
+        {
+          namedComponents: 'function-declaration',
+          unnamedComponents: 'arrow-function',
+        },
+      ],
+      'react/hook-use-state': [
+        'error',
+        {
+          allowDestructuredState: true,
+        },
+      ],
+      'react/jsx-boolean-value': ['error', 'never', { always: [] }],
+      'react/jsx-curly-brace-presence': ['error', { props: 'never', children: 'never' }],
+      'react/jsx-fragments': ['error', 'syntax'],
+      // 'react/jsx-handler-names': [
+      //     'error',
+      //     {
+      //         eventHandlerPrefix: 'handle',
+      //         eventHandlerPropPrefix: 'on',
+      //         checkLocalVariables: true,
+      //     },
+      // ],
+      'react/jsx-key': [
+        'error',
+        {
+          warnOnDuplicates: true,
+        },
+      ],
+      'react/jsx-newline': [
+        'error',
+        {
+          prevent: true,
+          allowMultilines: true,
+        },
+      ],
+      'react/jsx-no-constructed-context-values': 'error',
+      'react/jsx-no-leaked-render': [
+        'error',
+        {
+          validStrategies: ['coerce', 'ternary'],
+        },
+      ],
+      'react/jsx-no-script-url': [
+        'error',
+        [
+          {
+            name: 'Link',
+            props: ['to'],
+          },
+        ],
+      ],
+      'react/jsx-no-useless-fragment': 'error',
+      'react/jsx-pascal-case': [
+        'error',
+        {
+          allowAllCaps: true,
+          ignore: [],
+        },
+      ],
+
+      'react/no-array-index-key': 'error',
+      'react/no-namespace': 'error',
+      'react/no-object-type-as-default-prop': 'error',
+      'react/no-this-in-sfc': 'error',
+      'react/no-unstable-nested-components': 'error',
+      'react/no-unused-prop-types': 'error',
+      'react/self-closing-comp': 'error',
+      'react/void-dom-elements-no-children': 'error',
+
+      // React Hooks
+      'react-hooks/rules-of-hooks': 'error',
+      'react-hooks/exhaustive-deps': 'error',
+
+      //#region Props sorting
+      // Using react/jsx-sort-props for now is enough.
+      // It provides conventional sorting of JSX props.
+      //
+      // If we later need more advanced ordering (grouping, placing styles/className first, etc.),
+      // we can switch to perfectionist/sort-jsx-props.
+      //
+      // ⚠️ Never enable perfectionist/sort-jsx-props without first configuring its groups and options;
+      // by default it only sorts props alphabetically.
+      'react/jsx-sort-props': [
+        'error',
+        {
+          reservedFirst: true,
+          ignoreCase: true,
+          callbacksLast: true,
+          shorthandFirst: true,
+          multiline: 'last',
+        },
+      ],
+      // 'perfectionist/sort-jsx-props': 'error',
+    },
+  },
+);