@jabworks/eslint-plugin 1.1.0 → 1.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025-present Vi Minh Hieu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -41,13 +41,7 @@ export default [
 ];
 ```
 
-Or, if using legacy config:
-
-```json
-{
-	"extends": ["plugin:@jabworks/base"]
-}
-```
+Legacy `.eslintrc` configs are not provided. Use flat config with ESLint v9+.
 
 ## Available Configs
 
@@ -71,6 +65,10 @@ import helper from './helper';
 import styles from './styles.css';
 ```
 
+## Compatibility
+
+- **ESLint**: >=9.39.2
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jabworks/eslint-plugin",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "private": false,
   "description": "Opinionated ESLint plugin and flat config for JS, TS, React, and Next.js",
   "keywords": [
@@ -12,6 +12,9 @@
     "typescript-eslint"
   ],
   "homepage": "https://github.com/jabworks/style-guide/tree/main/packages/eslint-plugin#readme",
+  "bugs": {
+    "url": "https://github.com/jabworks/style-guide/issues"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jabworks/style-guide.git",
@@ -28,6 +31,10 @@
   },
   "main": "./src/index.js",
   "types": "./src/types/index.d.ts",
+  "files": [
+    "src/index.js",
+    "src/types/index.d.ts"
+  ],
   "dependencies": {
     "globals": "^17.2.0"
   },
@@ -58,21 +65,25 @@
     "@jabworks/typescript-config": "0.0.0"
   },
   "peerDependencies": {
-    "@eslint-community/eslint-plugin-eslint-comments": ">=4.6.0",
-    "@next/eslint-plugin-next": ">=16.1.6",
-    "@vitest/eslint-plugin": ">=1.6.6",
-    "eslint": ">=9.39.2",
-    "eslint-plugin-import": ">=2.32.0",
-    "eslint-plugin-jest": ">=29.12.1",
-    "eslint-plugin-jsx-a11y": ">=6.10.2",
-    "eslint-plugin-playwright": ">=2.5.1",
-    "eslint-plugin-react": ">=7.37.5",
-    "eslint-plugin-react-hooks": ">=7.0.1",
-    "eslint-plugin-simple-import-sort": ">=12.1.1",
-    "eslint-plugin-testing-library": ">=7.13.5",
-    "eslint-plugin-turbo": ">=2.8.0",
-    "eslint-plugin-unicorn": ">=62.0.0",
-    "typescript": ">=5.9.3",
-    "typescript-eslint": ">=8.54.0"
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.6.0",
+    "@next/eslint-plugin-next": "^16.1.6",
+    "@stylistic/eslint-plugin": "^5.7.1",
+    "@vitest/eslint-plugin": "^1.6.6",
+    "eslint": "^9.39.2",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-jest": "^29.12.1",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-playwright": "^2.5.1",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-testing-library": "^7.13.5",
+    "eslint-plugin-turbo": "^2.8.0",
+    "eslint-plugin-unicorn": "^62.0.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }

package/CHANGELOG.md

@@ -1,50 +0,0 @@
-# @jabworks/eslint-plugin
-
-## 1.1.0
-
-### Minor Changes
-
-- Bump deps version
-- Update react rules in next config
-
-## 1.0.6
-
-### Patch Changes
-
-- Update dependencies to latest
-
-## 1.0.5
-
-### Patch Changes
-
-- Update README.md
-
-## 1.0.4
-
-### Patch Changes
-
-- Fix stylistic rule typo
-
-## 1.0.3
-
-### Patch Changes
-
-- Tweak stylistic rules
-
-## 1.0.2
-
-### Patch Changes
-
-- Move workspace dep to dev dep
-
-## 1.0.1
-
-### Patch Changes
-
-- Change dev deps to regular deps
-
-## 1.0.0
-
-### Major Changes
-
-- Initial release

package/src/configs/base.js

@@ -1,62 +0,0 @@
-import eslintjs from '@eslint/js';
-import stylisticPlugin from '@stylistic/eslint-plugin';
-import eslintConfigPrettier from 'eslint-config-prettier';
-import importPlugin from 'eslint-plugin-import';
-import simpleImportSort from 'eslint-plugin-simple-import-sort';
-import unicorn from 'eslint-plugin-unicorn';
-import tseslint from 'typescript-eslint';
-import bestPractice from '../rules/best-practice.js';
-import es6 from '../rules/es6.js';
-import importConfig from '../rules/import.js';
-import possibleErrors from '../rules/possible-errors.js';
-import stylistic from '../rules/stylistic.js';
-import variables from '../rules/variables.js';
-import comments from './comments.js';
-
-/** @type {import('eslint').Linter.Config} */
-export const baseConfig = {
-  name: '@jabworks/eslint-config-base',
-  plugins: {
-    unicorn,
-    'simple-import-sort': simpleImportSort,
-  },
-  rules: {
-    ...bestPractice,
-    ...es6,
-    ...importConfig,
-    ...possibleErrors,
-    ...stylistic,
-    ...variables,
-  },
-};
-
-/** @type {import('eslint').Linter.Config[]} */
-const configs = [
-  eslintjs.configs.recommended,
-  eslintConfigPrettier,
-  ...tseslint.configs.recommended,
-  importPlugin.flatConfigs.recommended,
-  ...comments,
-  stylisticPlugin.configs.customize({
-    semi: true,
-    arrowParens: 'as-needed',
-  }),
-  baseConfig,
-  {
-    ignores: [
-      'dist/**',
-      'build/**',
-      'out/**',
-      'coverage/**',
-      'node_modules/**',
-      'eslint.config.js',
-      'eslint.config.mjs',
-      'eslint.config.cjs',
-      '*.config.js',
-      '*.config.mjs',
-      '*.config.cjs',
-    ],
-  },
-];
-
-export default configs;

package/src/configs/comments.js

@@ -1,13 +0,0 @@
-import comments from '@eslint-community/eslint-plugin-eslint-comments/configs';
-import commentsRules from '../rules/comments.js';
-
-/** @type {import('eslint').Linter.Config} */
-export const commentsConfig = {
-	name: '@jabworks/eslint-config-comments',
-	rules: commentsRules,
-};
-
-/** @type {import('eslint').Linter.Config[]} */
-const configs = [comments.recommended, commentsConfig];
-
-export default configs;

package/src/configs/next.js

@@ -1,88 +0,0 @@
-import js from '@eslint/js';
-import pluginNext from '@next/eslint-plugin-next';
-import eslintConfigPrettier from 'eslint-config-prettier';
-import importPlugin from 'eslint-plugin-import';
-import pluginReact from 'eslint-plugin-react';
-import pluginReactHooks from 'eslint-plugin-react-hooks';
-import globals from 'globals';
-
-import reactRules from '../rules/react.js';
-import baseConfig from './base.js';
-import tseslintConfigs, { tseslintConfig } from './typescript.js';
-
-/** @type {import('eslint').Linter.Config[]} */
-const configs = [
-  ...baseConfig,
-  js.configs.recommended,
-  eslintConfigPrettier,
-  importPlugin.flatConfigs.recommended,
-  pluginReact.configs.flat.recommended,
-  pluginReact.configs.flat['jsx-runtime'],
-  ...tseslintConfigs,
-  {
-    name: '@jabworks/eslint-config-nextjs',
-    plugins: {
-      '@next/next': pluginNext,
-      'react-hooks': pluginReactHooks,
-    },
-    languageOptions: {
-      ...pluginReact.configs.flat.recommended?.languageOptions,
-      globals: {
-        ...globals.serviceworker,
-        ...globals.browser,
-      },
-      parserOptions: {
-        projectService: true,
-        tsconfigRootDir: import.meta.dirname,
-      },
-    },
-    settings: {
-      'import/resolver': { node: {} },
-      react: { version: 'detect' },
-    },
-    linterOptions: {
-      reportUnusedDisableDirectives: true,
-    },
-    rules: {
-      ...pluginReactHooks.configs['recommended-latest'].rules,
-      ...reactRules,
-      ...pluginNext.configs.recommended.rules,
-      ...pluginNext.configs['core-web-vitals'].rules,
-      ...tseslintConfig.rules,
-    },
-  },
-  {
-    files: [
-      '*.config.ts',
-      '**/*.d.ts',
-      '**/*.stories.ts',
-      '**/*.stories.tsx',
-      'app/**/*error.tsx',
-      'app/**/layout.tsx',
-      'app/**/not-found.tsx',
-      'app/**/opengraph-image.tsx',
-      'app/**/page.tsx',
-      'app/apple-icon.tsx',
-      'app/robots.ts',
-      'app/sitemap.ts',
-      'next.config.mjs',
-      'src/app/**/*error.tsx',
-      'src/app/**/layout.tsx',
-      'src/app/**/not-found.tsx',
-      'src/app/**/opengraph-image.tsx',
-      'src/app/**/page.tsx',
-      'src/app/apple-icon.tsx',
-      'src/app/robots.ts',
-      'src/app/sitemap.ts',
-    ],
-    rules: {
-      'import/no-default-export': 'off',
-      'import/prefer-default-export': ['error', { target: 'any' }],
-    },
-  },
-  {
-    ignores: ['.next/**'],
-  },
-];
-
-export default configs;

package/src/configs/react.js

@@ -1,52 +0,0 @@
-import js from '@eslint/js';
-import eslintConfigPrettier from 'eslint-config-prettier';
-import importPlugin from 'eslint-plugin-import';
-import pluginReact from 'eslint-plugin-react';
-import pluginReactHooks from 'eslint-plugin-react-hooks';
-import globals from 'globals';
-
-import reactRules from '../rules/react.js';
-import baseConfig from './base.js';
-import tseslintConfig from './typescript.js';
-
-/** @type {import("eslint").Linter.Config} */
-export const reactConfig = {
-	name: '@jabworks/eslint-config-react',
-	languageOptions: {
-		...pluginReact.configs.flat.recommended?.languageOptions,
-		globals: {
-			...globals.serviceworker,
-			...globals.browser,
-		},
-		parserOptions: {
-			projectService: true,
-			tsconfigRootDir: import.meta.dirname,
-		},
-	},
-	plugins: {
-		'react-hooks': pluginReactHooks,
-	},
-	settings: { react: { version: 'detect' } },
-	rules: {
-		...pluginReactHooks.configs['recommended-latest'].rules,
-		...reactRules,
-		'import/no-cycle': 'error',
-	},
-};
-
-/**
- * A custom ESLint configuration for libraries that use React.
- *
- * @type {import("eslint").Linter.Config[]}
- */
-const configs = [
-	js.configs.recommended,
-	eslintConfigPrettier,
-	importPlugin.flatConfigs.recommended,
-	...baseConfig,
-	...tseslintConfig,
-	pluginReact.configs.flat.recommended,
-	reactConfig,
-];
-
-export default configs;

package/src/configs/typescript.js

@@ -1,30 +0,0 @@
-import eslintConfigPrettier from 'eslint-config-prettier';
-import importPlugin from 'eslint-plugin-import';
-import tseslint from 'typescript-eslint';
-
-import { TYPESCRIPT_FILES } from '../lib/constants.js';
-import typescriptExtensionRules from '../rules/typescript.extension.js';
-import typescriptImportRules from '../rules/typescript.import.js';
-import typescriptRules from '../rules/typescript.js';
-
-/** @type {import('eslint').Linter.Config} */
-export const tseslintConfig = {
-	name: '@jabworks/eslint-config-typescript',
-	files: TYPESCRIPT_FILES,
-	rules: {
-		...typescriptRules,
-		...typescriptExtensionRules,
-		...typescriptImportRules,
-	},
-};
-
-/** @type {import('eslint').Linter.Config[]} */
-const configs = [
-	...tseslint.configs.strictTypeChecked,
-	...tseslint.configs.stylisticTypeChecked,
-	importPlugin.flatConfigs.typescript,
-	eslintConfigPrettier,
-	tseslintConfig,
-];
-
-export default configs;

package/src/configs/vitest.js

@@ -1,28 +0,0 @@
-import vitest from '@vitest/eslint-plugin';
-import globals from 'globals';
-
-import vitestRules from '../rules/vitest.js';
-
-/** @type {import('eslint').Linter.Config[]} */
-const configs = [
-	{
-		name: '@jabworks/eslint-config-vitest',
-		files: ['**/*.test.{js,ts,mjs,cjs,jsx,tsx}', '**/__tests__/**', '**/tests/**'],
-		plugins: {
-			vitest,
-		},
-		languageOptions: {
-			globals: {
-				...globals.node,
-				...globals.vitest,
-				vi: 'readonly',
-			},
-		},
-		rules: {
-			...vitest.configs.recommended.rules,
-			...vitestRules,
-		},
-	},
-];
-
-export default configs;

package/src/lib/constants.js

@@ -1,3 +0,0 @@
-export const ECMA_VERSION = 2021;
-export const JAVASCRIPT_FILES = ['*.js?(x)', '*.mjs'];
-export const TYPESCRIPT_FILES = ['*.ts?(x)'];

package/src/rules/best-practice.js

@@ -1,228 +0,0 @@
-/** @type {import('eslint').Linter.RulesRecord} */
-const rules = {
-	/**
-	 * Require return statements in array methods callbacks.
-	 *
-	 * 🚫 Not fixable -https://eslint.org/docs/rules/array-callback-return
-	 */
-	'array-callback-return': ['error', { allowImplicit: true }],
-	/**
-	 * Treat `var` statements as if they were block scoped.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/block-scoped-var
-	 */
-	'block-scoped-var': 'error',
-	/**
-	 * Require curly braces for multiline blocks.
-	 *
-	 * 🔧 Fixable - https://eslint.org/docs/rules/curly
-	 */
-	curly: ['warn', 'multi-line'],
-	/**
-	 * Require default clauses in switch statements to be last (if used).
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/default-case-last
-	 */
-	'default-case-last': 'error',
-	/**
-	 * Require triple equals (`===` and `!==`).
-	 *
-	 * 🔧 Fixable - https://eslint.org/docs/rules/eqeqeq
-	 */
-	eqeqeq: 'error',
-	/**
-	 * Require grouped accessor pairs in object literals and classes.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/grouped-accessor-pairs
-	 */
-	'grouped-accessor-pairs': 'error',
-	/**
-	 * Disallow use of `alert()`.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-alert
-	 */
-	'no-alert': 'error',
-	/**
-	 * Disallow use of `caller`/`callee`.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-caller
-	 */
-	'no-caller': 'error',
-	/**
-	 * Disallow returning value in constructor.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-constructor-return
-	 */
-	'no-constructor-return': 'error',
-	/**
-	 * Disallow using an `else` if the `if` block contains a return.
-	 *
-	 * 🔧 Fixable - https://eslint.org/docs/rules/no-else-return
-	 */
-	'no-else-return': 'warn',
-	/**
-	 * Disallow `eval()`.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-eval
-	 */
-	'no-eval': 'error',
-	/**
-	 * Disallow extending native objects.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-extend-native
-	 */
-	'no-extend-native': 'error',
-	/**
-	 * Disallow unnecessary function binding.
-	 *
-	 * 🔧 Fixable - https://eslint.org/docs/rules/no-extra-bind
-	 */
-	'no-extra-bind': 'error',
-	/**
-	 * Disallow unnecessary labels.
-	 *
-	 * 🔧 Fixable - https://eslint.org/docs/rules/no-extra-label
-	 */
-	'no-extra-label': 'error',
-	/**
-	 * Disallow floating decimals.
-	 *
-	 * 🔧 Fixable - https://eslint.org/docs/rules/no-floating-decimal
-	 */
-	'no-floating-decimal': 'error',
-	/**
-	 * Make people convert types explicitly e.g. `Boolean(foo)` instead of `!!foo`.
-	 *
-	 * 🔧 Partially Fixable - https://eslint.org/docs/rules/no-implicit-coercion
-	 */
-	'no-implicit-coercion': 'error',
-	/**
-	 * Disallow use of `eval()`-like methods.
-	 *
-	 * https://eslint.org/docs/rules/no-implied-eval
-	 */
-	'no-implied-eval': 'error',
-	/**
-	 * Disallow usage of `__iterator__` property.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-iterator
-	 */
-	'no-iterator': 'error',
-	/**
-	 * Disallow use of labels for anything other than loops and switches.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-labels
-	 */
-	'no-labels': ['error'],
-	/**
-	 * Disallow unnecessary nested blocks.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-lone-blocks
-	 */
-	'no-lone-blocks': 'error',
-	/**
-	 * Disallow `new` for side effects.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-new
-	 */
-	'no-new': 'error',
-	/**
-	 * Disallow function constructors.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-new-func
-	 */
-	'no-new-func': 'error',
-	/**
-	 * Disallow primitive wrapper instances, such as `new String('foo')`.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-new-wrappers
-	 */
-	'no-new-wrappers': 'error',
-	/**
-	 * Disallow use of octal escape sequences in string literals.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-octal-escape
-	 */
-	'no-octal-escape': 'error',
-	/**
-	 * Disallow reassignment of function parameters.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-param-reassign
-	 */
-	'no-param-reassign': 'error',
-	/**
-	 * Disallow usage of the deprecated `__proto__` property.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-proto
-	 */
-	'no-proto': 'error',
-	/**
-	 * Disallow assignment in `return` statement.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-return-assign
-	 */
-	'no-return-assign': 'error',
-	/**
-	 * Disallow use of `javascript:` urls.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-script-url
-	 */
-	'no-script-url': 'error',
-	/**
-	 * Disallow comparisons where both sides are exactly the same.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-self-compare
-	 */
-	'no-self-compare': 'error',
-	/**
-	 * Disallow use of comma operator.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-sequences
-	 */
-	'no-sequences': 'error',
-	/**
-	 * Disallow unnecessary `.call()` and `.apply()`.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-useless-call
-	 */
-	'no-useless-call': 'error',
-	/**
-	 * Disallow unnecessary concatenation of strings.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/no-useless-concat
-	 */
-	'no-useless-concat': 'error',
-	/**
-	 * Disallow redundant return statements.
-	 *
-	 * 🔧 Fixable - https://eslint.org/docs/rules/no-useless-return
-	 */
-	'no-useless-return': 'warn',
-	/**
-	 * Require using named capture groups in regular expressions.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/prefer-named-capture-group
-	 */
-	// 'prefer-named-capture-group': 'error',
-	/**
-	 * Require using Error objects as Promise rejection reasons.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/prefer-promise-reject-errors
-	 */
-	'prefer-promise-reject-errors': ['error', { allowEmptyReject: true }],
-	/**
-	 * Disallow use of the RegExp constructor in favor of regular expression
-	 * literals.
-	 *
-	 * 🚫 Not fixable - https://eslint.org/docs/rules/prefer-regex-literals
-	 */
-	'prefer-regex-literals': 'error',
-	/**
-	 * Disallow "Yoda conditions", ensuring the comparison.
-	 *
-	 * 🔧 Fixable - https://eslint.org/docs/rules/yoda
-	 */
-	yoda: 'warn',
-};
-
-export default rules;