@planfredapp/eslint-config 1.2.1 → 1.2.15

package/README.md

@@ -1,5 +1,7 @@
 # @planfredapp/eslint-config
 
+[View package on npm](https://www.npmjs.com/package/@planfredapp/eslint-config)
+
 [![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)
 
@@ -9,13 +11,15 @@ The package ships its plugins and parsers as dependencies. In consuming projects
 
 ## Requirements
 
-- Node `^20.19.0 || ^22.13.0 || >=24`
+- Node `>=26`
 - `eslint >= 10`
 - An ESM flat config file such as `eslint.config.js` or `eslint.config.mjs`
 
 ## Installation
 
 ```bash
+pnpm add -D eslint @planfredapp/eslint-config
+# or
 npm install --save-dev eslint @planfredapp/eslint-config
 ```
 
@@ -28,6 +32,8 @@ npm install --save-dev eslint @planfredapp/eslint-config
 | 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 |
 
+Every specialized entrypoint already includes the complete base config. Use the base entrypoint by itself for plain JavaScript, or select a specialized entrypoint when it applies to the whole project.
+
 ### Vue-Specific Assumptions
 
 The Vue config contains a few project-structure assumptions:
@@ -103,25 +109,28 @@ export default [
 ]
 ```
 
-If you combine multiple specialized configs in one root `eslint.config.js`, scope the test-oriented ones to the files they should apply to:
+If one root `eslint.config.js` combines multiple specialized configs, apply the base config once and scope only each specialized config's additional entries:
 
 ```js
 import baseConfig from '@planfredapp/eslint-config'
 import cypressConfig from '@planfredapp/eslint-config/cypress'
 import testConfig from '@planfredapp/eslint-config/test'
 
-const scope = (configs, files) => configs.map(config => ({
-  ...config,
+const withoutBase = config => config.slice(baseConfig.length)
+const scope = (config, files) => config.map(entry => ({
+  ...entry,
   files,
 }))
 
 export default [
   ...baseConfig,
-  ...scope(cypressConfig, [ 'cypress/**/*.{js,ts}' ]),
-  ...scope(testConfig, [ 'test/**/*.{js,ts}' ]),
+  ...scope(withoutBase(cypressConfig), [ 'cypress/**/*.{js,ts}' ]),
+  ...scope(withoutBase(testConfig), [ 'test/**/*.{js,ts}' ]),
 ]
 ```
 
+This avoids applying the base entries more than once. The specialized entrypoints intentionally begin with the same base config entries.
+
 ## What The Base Config Enforces
 
 - 2-space indentation
@@ -131,15 +140,22 @@ export default [
 - Blank lines between most statements
 - Import ordering with grouped and alphabetized imports
 - `no-var`, `prefer-const`, and a broad set of core correctness rules
+- Promise executor parameters named `resolve` and `reject`
+
+The Vue config also enforces `@/` imports inside `src/` through the bundled `no-relative-import-paths` rule and provides an autofix for matching relative imports.
+
+## Package Contents
+
+The npm package contains the four public config entrypoints plus the two internal custom-rule modules they use. Repository-only ESLint and Vitest config files are excluded from the published tarball.
 
 ## Development
 
 ```bash
-npm run lint
-npm run test:run
+pnpm lint
+pnpm vitest run test/<relevant-spec>.test.js
 ```
 
-More details are in [TESTING.md](TESTING.md). Release history is in [CHANGELOG.md](CHANGELOG.md).
+Run the complete test suite through GitHub Actions. More details are in [TESTING.md](TESTING.md). Release history is in [CHANGELOG.md](CHANGELOG.md).
 
 ## License
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@planfredapp/eslint-config",
-  "version": "1.2.1",
-  "description": "Shared ESLint 10 configurations for Planfred monorepo",
+  "version": "1.2.15",
+  "description": "Shared ESLint 10 flat configurations for Planfred projects",
   "keywords": [
     "eslint",
     "eslint-config",
@@ -29,46 +29,48 @@
     "./cypress": "./cypress.js",
     "./test": "./test.js"
   },
-  "main": "index.js",
+  "main": "./base.js",
   "files": [
-    "*.js"
+    "base.js",
+    "cypress.js",
+    "no-relative-import-paths.js",
+    "promise-param-names.js",
+    "test.js",
+    "vue.js"
   ],
   "engines": {
-    "node": "^20.19.0 || ^22.13.0 || >=24"
-  },
-  "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "release": "npm publish --access public",
-    "test": "vitest",
-    "test:run": "vitest run",
-    "upgrade": "./scripts/upgrade.sh",
-    "version:major": "./scripts/version.sh major",
-    "version:minor": "./scripts/version.sh minor",
-    "version:patch": "./scripts/version.sh patch"
+    "node": ">=26"
   },
   "dependencies": {
     "@eslint/js": "10.0.1",
     "@stylistic/eslint-plugin": "5.10.0",
-    "@vitest/eslint-plugin": "1.6.15",
-    "eslint-plugin-cypress": "6.3.0",
-    "eslint-plugin-import-x": "4.16.2",
-    "eslint-plugin-n": "17.24.0",
-    "eslint-plugin-no-only-tests": "3.3.0",
-    "eslint-plugin-vue": "10.8.0",
-    "globals": "17.4.0",
-    "typescript-eslint": "8.58.1",
-    "vue-eslint-parser": "10.4.0"
+    "@vitest/eslint-plugin": "1.6.27",
+    "eslint-plugin-cypress": "7.0.2",
+    "eslint-plugin-import-x": "4.17.1",
+    "eslint-plugin-n": "18.3.0",
+    "eslint-plugin-no-only-tests": "3.4.0",
+    "eslint-plugin-vue": "10.11.0",
+    "globals": "17.12.0",
+    "typescript-eslint": "8.70.0",
+    "vue-eslint-parser": "10.4.1"
   },
   "devDependencies": {
-    "eslint": "10.2.0",
-    "typescript": "6.0.2",
-    "vitest": "4.1.4"
+    "eslint": "10.11.0",
+    "typescript": "6.0.3",
+    "vitest": "5.0.1"
   },
   "peerDependencies": {
     "eslint": ">=10.0.0"
   },
-  "overrides": {
-    "js-yaml": "4.1.1"
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "release": "pnpm publish --access public --no-git-checks",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "deps:upgrade": "./scripts/upgrade.sh",
+    "version:major": "./scripts/version.sh major",
+    "version:minor": "./scripts/version.sh minor",
+    "version:patch": "./scripts/version.sh patch"
   }
-}
+}

package/eslint.config.js

@@ -1,12 +0,0 @@
-import baseConfig from './base.js'
-
-export default [
-  ...baseConfig,
-  {
-    files: [ '**/*.js' ],
-    ignores: [
-      'node_modules/**',
-      'dist/**',
-    ],
-  },
-]

package/vitest.config.js

@@ -1,8 +0,0 @@
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-  test: {
-    globals: true,
-    environment: 'node',
-  },
-})