@planfredapp/eslint-config 1.0.59 → 1.1.0

package/README.md

@@ -3,40 +3,98 @@
 [![npm version](https://img.shields.io/npm/v/@planfredapp/eslint-config.svg)](https://www.npmjs.com/package/@planfredapp/eslint-config)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
 
-Shared ESLint configurations for the Planfred monorepo. Uses ESLint 9 flat config format.
+Shared ESLint 10 flat configs used in Planfred projects.
+
+The package ships its plugins and parsers as dependencies. In consuming projects, `eslint` is the only required peer dependency.
+
+## Requirements
+
+- Node `^20.19.0 || ^22.13.0 || >=24`
+- `eslint >= 10`
+- An ESM flat config file such as `eslint.config.js` or `eslint.config.mjs`
 
 ## Installation
 
 ```bash
-npm install --save-dev @planfredapp/eslint-config eslint
+npm install --save-dev eslint @planfredapp/eslint-config
 ```
 
-## Configurations
+## Available Configs
+
+| Config | Import Path | What It Adds |
+| --- | --- | --- |
+| Base | `@planfredapp/eslint-config` or `@planfredapp/eslint-config/base` | `@eslint/js`, import rules, promise rules, Node rules, stylistic rules, browser and Node globals |
+| Vue | `@planfredapp/eslint-config/vue` | Base config, `eslint-plugin-vue` recommended flat config, Vue-specific style and correctness rules |
+| Cypress | `@planfredapp/eslint-config/cypress` | Base config, `typescript-eslint` recommended rules, Cypress globals, `.only()` protection |
+| Test | `@planfredapp/eslint-config/test` | Base config, Vitest recommended rules, test globals, `.only()` protection |
+
+### Vue-Specific Assumptions
+
+The Vue config contains a few project-structure assumptions:
 
-| Config | Import Path | Description |
-|--------|-------------|-------------|
-| Base | `@planfredapp/eslint-config/base` | Core JS rules, imports, Node.js, stylistic |
-| Vue | `@planfredapp/eslint-config/vue` | Vue 3 components, extends base |
-| Cypress | `@planfredapp/eslint-config/cypress` | E2E tests with TypeScript |
-| Test | `@planfredapp/eslint-config/test` | Vitest unit tests |
+- `src/**/*` must use `@` imports instead of relative imports
+- `src/components/**/*` enforces component/file-name matching
+- The config is intended for Vue 3 single-file components
 
 ## Usage
 
-Create `eslint.config.js` in your project root:
+Use the entrypoint that matches the project you are linting.
 
-```javascript
-// Base config
-import baseConfig from '@planfredapp/eslint-config/base'
-export default [...baseConfig]
+### Base
 
-// Vue project
-import vueConfig from '@planfredapp/eslint-config/vue'
-export default [...vueConfig]
+```js
+import config from '@planfredapp/eslint-config'
+
+export default [
+  ...config,
+]
+```
+
+### Vue
+
+```js
+import config from '@planfredapp/eslint-config/vue'
+
+export default [
+  ...config,
+]
+```
+
+### Cypress
+
+```js
+import config from '@planfredapp/eslint-config/cypress'
+
+export default [
+  ...config,
+]
+```
+
+### Vitest
 
-// With overrides
+```js
+import config from '@planfredapp/eslint-config/test'
+
+export default [
+  ...config,
+]
+```
+
+## Customizing
+
+Append your own config objects after the shared config:
+
+```js
 import vueConfig from '@planfredapp/eslint-config/vue'
+
 export default [
   ...vueConfig,
+  {
+    ignores: [
+      'dist/**',
+      'coverage/**',
+    ],
+  },
   {
     rules: {
       'no-console': 'warn',
@@ -45,68 +103,43 @@ export default [
 ]
 ```
 
-## Included Plugins
-
-### Base Config
-- `@eslint/js` - ESLint recommended
-- `@stylistic/eslint-plugin` - Code formatting
-- `eslint-plugin-import` - Import/export validation
-- `eslint-plugin-n` - Node.js rules
-- `eslint-plugin-promise` - Promise handling
+If you combine multiple specialized configs in one root `eslint.config.js`, scope the test-oriented ones to the files they should apply to:
 
-### Vue Config
-- `eslint-plugin-vue` - Vue 3 rules
-- `eslint-plugin-no-relative-import-paths` - Enforce `@/` imports
+```js
+import baseConfig from '@planfredapp/eslint-config'
+import cypressConfig from '@planfredapp/eslint-config/cypress'
+import testConfig from '@planfredapp/eslint-config/test'
 
-### Cypress Config
-- `eslint-plugin-cypress` - Cypress globals and best practices
-- `typescript-eslint` - TypeScript support
+const scope = (configs, files) => configs.map(config => ({
+  ...config,
+  files,
+}))
 
-### Test Config
-- `@vitest/eslint-plugin` - Vitest globals and rules
-- `eslint-plugin-no-only-tests` - Prevent `.only()` in CI
+export default [
+  ...baseConfig,
+  ...scope(cypressConfig, [ 'cypress/**/*.{js,ts}' ]),
+  ...scope(testConfig, [ 'test/**/*.{js,ts}' ]),
+]
+```
 
-## Key Rules
+## What The Base Config Enforces
 
-### Stylistic
 - 2-space indentation
-- Single quotes, no semicolons
-- Trailing commas in multiline
-- Spaces inside brackets: `[ 'a', 'b' ]`
-- Newlines for arrays/objects with 2+ items
-- Blank lines between statements
-
-### Imports
-- Alphabetized, grouped by type
-- Newlines between groups
-- No relative paths in Vue (use `@/`)
-
-### Vue-Specific
-- Template-first block order
-- Component name matching filename
-- No unused refs/props/emits
-- PascalCase component names in templates
-
-## Peer Dependencies
-
-```json
-{
-  "eslint": "9.0.0"
-}
-```
+- Single quotes
+- No semicolons
+- Trailing commas for multiline arrays, objects, imports, exports, and function params
+- Blank lines between most statements
+- Import ordering with grouped and alphabetized imports
+- `no-var`, `prefer-const`, and a broad set of core correctness rules
 
-## Files
+## Development
 
+```bash
+npm run lint
+npm run test:run
 ```
-base.js     - Core configuration
-vue.js      - Vue.js (extends base)
-cypress.js  - Cypress E2E (extends base)
-test.js     - Vitest unit tests (extends base)
-```
-
-## Changelog
 
-See [CHANGELOG.md](CHANGELOG.md) for version history.
+More details are in [TESTING.md](TESTING.md). Release history is in [CHANGELOG.md](CHANGELOG.md).
 
 ## License
 

package/base.js

@@ -1,11 +1,12 @@
 /** @type {import('eslint').Linter.Config[]} */
 import js from '@eslint/js'
 import stylisticPlugin from '@stylistic/eslint-plugin'
-import importPlugin from 'eslint-plugin-import'
+import importPlugin from 'eslint-plugin-import-x'
 import nodePlugin from 'eslint-plugin-n'
-import promisePlugin from 'eslint-plugin-promise'
 import globals from 'globals'
 
+import promisePlugin from './promise-param-names.js'
+
 export default [
   js.configs.recommended,
   {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@planfredapp/eslint-config",
-  "version": "1.0.59",
-  "description": "Shared ESLint configurations for Planfred monorepo",
+  "version": "1.1.0",
+  "description": "Shared ESLint 10 configurations for Planfred monorepo",
   "keywords": [
     "eslint",
     "eslint-config",
@@ -33,6 +33,9 @@
   "files": [
     "*.js"
   ],
+  "engines": {
+    "node": "^20.19.0 || ^22.13.0 || >=24"
+  },
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
@@ -45,27 +48,26 @@
     "version:patch": "./scripts/version.sh patch"
   },
   "dependencies": {
-    "@eslint/js": "9.39.2",
+    "@eslint/js": "10.0.1",
     "@stylistic/eslint-plugin": "5.10.0",
-    "@vitest/eslint-plugin": "1.6.12",
-    "eslint-plugin-cypress": "6.2.0",
-    "eslint-plugin-import": "2.32.0",
+    "@vitest/eslint-plugin": "1.6.13",
+    "eslint-plugin-cypress": "6.2.1",
+    "eslint-plugin-import-x": "4.16.2",
     "eslint-plugin-n": "17.24.0",
     "eslint-plugin-no-only-tests": "3.3.0",
     "eslint-plugin-no-relative-import-paths": "1.6.1",
-    "eslint-plugin-promise": "7.2.1",
     "eslint-plugin-vue": "10.8.0",
     "globals": "17.4.0",
-    "typescript-eslint": "8.56.1"
+    "typescript-eslint": "8.57.2",
+    "vue-eslint-parser": "10.4.0"
   },
   "devDependencies": {
-    "eslint": "9.39.2",
+    "eslint": "10.1.0",
     "typescript": "5.9.3",
-    "vitest": "4.1.0",
-    "vue-eslint-parser": "10.4.0"
+    "vitest": "4.1.1"
   },
   "peerDependencies": {
-    "eslint": ">=9.0.0"
+    "eslint": ">=10.0.0"
   },
   "overrides": {
     "js-yaml": "4.1.1"

package/promise-param-names.js

@@ -0,0 +1,65 @@
+const PROMISE_EXECUTOR_NAMES = [
+  'resolve',
+  'reject',
+]
+
+const getIdentifier = (param) => {
+  if (param?.type === 'Identifier') {
+    return param
+  }
+
+  if (param?.type === 'AssignmentPattern' && param.left?.type === 'Identifier') {
+    return param.left
+  }
+
+  return null
+}
+
+export default {
+  rules: {
+    'param-names': {
+      meta: {
+        type: 'suggestion',
+        docs: {
+          description: 'Enforce standard Promise executor parameter names',
+        },
+        schema: [],
+        messages: {
+          unexpectedName: 'Promise executor parameter {{index}} should be named "{{expected}}".',
+        },
+      },
+      create (context) {
+        return {
+          'NewExpression[callee.type="Identifier"][callee.name="Promise"]' (node) {
+            const executor = node.arguments?.[0]
+
+            if (!executor || ![
+              'ArrowFunctionExpression',
+              'FunctionExpression',
+            ].includes(executor.type)) {
+              return
+            }
+
+            PROMISE_EXECUTOR_NAMES.forEach((expected, index) => {
+              const param = executor.params[index]
+              const identifier = getIdentifier(param)
+
+              if (!param || identifier?.name === expected) {
+                return
+              }
+
+              context.report({
+                node: param,
+                messageId: 'unexpectedName',
+                data: {
+                  index: index + 1,
+                  expected,
+                },
+              })
+            })
+          },
+        }
+      },
+    },
+  },
+}