@planfredapp/eslint-config 1.2.12 → 1.3.0

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,7 +11,7 @@ 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`
 
@@ -30,12 +32,16 @@ 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 and adds its own rules on top without loosening base's options. Cypress swaps the core unused-code rules for typescript-eslint's versions with the same options; in `.ts` files, typescript-eslint also switches off the core rules that the TypeScript compiler covers, such as `no-undef`, so those checks depend on running `tsc` over the files (unreachable code is only a compiler error with `allowUnreachableCode: false`). Use the base entrypoint by itself for plain JavaScript, or select a specialized entrypoint when it applies to the whole project.
+
+All entrypoints lint `.js`, `.mjs`, and `.cjs` files (`.cjs` is parsed as CommonJS). The Vue entrypoint adds `.vue` files. Only the Cypress entrypoint parses TypeScript; it uses the TypeScript parser for every file, so it doesn't reject TypeScript syntax in `.js` files or ESM syntax in `.cjs` files.
+
 ### Vue-Specific Assumptions
 
 The Vue config contains a few project-structure assumptions:
 
 - `src/**/*` must use `@` imports instead of relative imports
-- `src/components/**/*` enforces component/file-name matching
+- `src/components/**/*` enforces component/file-name matching and a `name` property on Options API components
 - The config is intended for Vue 3 single-file components
 
 ## Usage
@@ -105,43 +111,75 @@ 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 with `defineConfig`'s `extends`:
 
 ```js
 import baseConfig from '@planfredapp/eslint-config'
 import cypressConfig from '@planfredapp/eslint-config/cypress'
 import testConfig from '@planfredapp/eslint-config/test'
+import vueConfig from '@planfredapp/eslint-config/vue'
+import { defineConfig } from 'eslint/config'
 
-const scope = (configs, files) => configs.map(config => ({
-  ...config,
-  files,
-}))
+const withoutBase = config => config.slice(baseConfig.length)
 
-export default [
-  ...baseConfig,
-  ...scope(cypressConfig, [ 'cypress/**/*.{js,ts}' ]),
-  ...scope(testConfig, [ 'test/**/*.{js,ts}' ]),
-]
+export default defineConfig([
+  baseConfig,
+  {
+    files: [ 'src/**/*.{js,vue}' ],
+    extends: [ withoutBase(vueConfig) ],
+  },
+  {
+    files: [ 'cypress/**/*.{js,ts}' ],
+    extends: [ withoutBase(cypressConfig) ],
+  },
+  {
+    files: [ 'test/**/*.js' ],
+    extends: [ withoutBase(testConfig) ],
+  },
+])
 ```
 
+This avoids applying the base entries more than once. The specialized entrypoints intentionally begin with the same base config entries. Widen the `files` patterns if those folders also hold `.mjs`, `.cjs`, or other file types.
+
+Vue's path-scoped entries (`src/**` and `src/components/**`) are relative to the config's base path. For a Vue app in a subfolder, set `basePath` instead of prefixing `files`, or those entries silently match nothing: `{ basePath: 'apps/web', files: [ 'src/**/*.{js,vue}' ], extends: [ withoutBase(vueConfig) ] }`.
+
+Don't scope entries by overwriting their `files` (`config.map(entry => ({ ...entry, files }))`). Some entries carry their own `files`, and overwriting them widens their scope: typescript-eslint's `.ts`-only overrides would switch off `no-undef` for Cypress `.js` files, and Vue's component-only rules would apply to every file. `extends` intersects the patterns instead.
+
 ## What The Base Config Enforces
 
-- 2-space indentation
-- 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
+Each item below is covered by a valid and an invalid example in [`test/configs.test.js`](test/configs.test.js).
+
+- 2-space indentation, single quotes, no semicolons
+- Trailing commas for multiline arrays, objects, imports, exports, function params, and call arguments; commas at the end of the line, never on a line of their own
+- Spaces inside array brackets (`[ 1 ]`); arrays with 2+ items put each item on its own line
+- Object literals with 2+ properties break after `{` and before `}`; inside, either all properties share one line or each gets its own line. Object destructuring may stay on one line; array destructuring follows the array rules
+- A space before function parentheses (`function f ()`, `method ()`)
+- A blank line between statements, including before `return`. Consecutive imports, consecutive `const`/`let`/`var` declarations, and consecutive expression statements may be adjacent; exported and function declarations are always separated
+- Chains of 2+ calls put each call on its own line (`list.map(f).join()` → one call per line); a single call stays inline
+- Imports in groups separated by a blank line: Node builtins and packages together, then relative paths, each group alphabetized. Without an import resolver, aliases and subpath imports (`@/`, `#`, `~/`) form a last group after relative paths; an `import-x/internal-regex` setting that marks them internal moves them between packages and relative paths
+- `no-var`, `prefer-const`, `eqeqeq` (except `== null`), and a broad set of core correctness rules
+- Unused function arguments, unused caught errors, and rest siblings used to omit properties are allowed; unused variables are not. An unused first parameter named `err` or `error` is reported, because `n/handle-callback-err` requires handling it
+- Promise executor parameters named `resolve` and `reject`
+
+### What The Vue Config Adds
+
+- `@/` imports inside `src/` through the bundled `no-relative-import-paths` rule, with an autofix for relative imports
+- Template expressions follow their own style: no spaces inside array brackets, arrays may stay on one line (`:items="[1, 2]"`), and multi-property objects put each property on its own line
+- A blank line between sibling template elements
+- Blocks ordered `<template>`, `<script>`, `<style>`, blank lines around multi-line component options, no `v-html`
+
+## 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/base.js

@@ -17,7 +17,6 @@ export default [
       stylistic: stylisticPlugin,
     },
     languageOptions: {
-      sourceType: 'module',
       globals: {
         ...globals.node,
         ...globals.browser,
@@ -55,10 +54,6 @@ export default [
           ignoreGlobals: true,
         },
       ],
-      'comma-style': [
-        'error',
-        'last',
-      ],
       'constructor-super': 'error',
       curly: [
         'error',
@@ -136,10 +131,10 @@ export default [
       'no-useless-catch': 'error',
       'no-new': 'error',
       'no-new-func': 'error',
-      'no-new-object': 'error',
-      'no-new-symbol': 'error',
+      'no-new-native-nonconstructor': 'error',
       'no-new-wrappers': 'error',
       'no-obj-calls': 'error',
+      'no-object-constructor': 'error',
       'no-octal': 'error',
       'no-octal-escape': 'error',
       'no-proto': 'error',
@@ -352,6 +347,10 @@ export default [
           after: true,
         },
       ],
+      'stylistic/comma-style': [
+        'error',
+        'last',
+      ],
       'stylistic/computed-property-spacing': [
         'error',
         'never',

package/cypress.js

@@ -6,9 +6,17 @@ import tsEslint from 'typescript-eslint'
 
 import baseConfig from './base.js'
 
+// typescript-eslint replaces these core rules with its own versions, so carry over the base options
+const baseRule = name => baseConfig.findLast(config => !config.files && config.rules?.[name]).rules[name]
+
 export default [
   ...baseConfig,
   ...tsEslint.configs.recommended,
+  {
+    // typescript-eslint sets sourceType: 'module' for every file; restore ESLint's default for .cjs
+    files: [ '**/*.cjs' ],
+    languageOptions: { sourceType: 'commonjs' },
+  },
   cypressPlugin.configs.recommended,
   {
     plugins: {
@@ -23,6 +31,8 @@ export default [
       },
     },
     rules: {
+      '@typescript-eslint/no-unused-expressions': baseRule('no-unused-expressions'),
+      '@typescript-eslint/no-unused-vars': baseRule('no-unused-vars'),
       '@typescript-eslint/no-require-imports': 'off',
       'noOnlyTestsPlugin/no-only-tests': 'error',
     },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@planfredapp/eslint-config",
-  "version": "1.2.12",
-  "description": "Shared ESLint 10 configurations for Planfred monorepo",
+  "version": "1.3.0",
+  "description": "Shared ESLint 10 flat configurations for Planfred projects",
   "keywords": [
     "eslint",
     "eslint-config",
@@ -29,9 +29,14 @@
     "./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": ">=26"
@@ -39,20 +44,20 @@
   "dependencies": {
     "@eslint/js": "10.0.1",
     "@stylistic/eslint-plugin": "5.10.0",
-    "@vitest/eslint-plugin": "1.6.17",
-    "eslint-plugin-cypress": "6.4.1",
-    "eslint-plugin-import-x": "4.16.2",
-    "eslint-plugin-n": "18.0.1",
+    "@vitest/eslint-plugin": "1.6.28",
+    "eslint-plugin-cypress": "7.0.2",
+    "eslint-plugin-import-x": "4.17.1",
+    "eslint-plugin-n": "18.5.0",
     "eslint-plugin-no-only-tests": "3.4.0",
-    "eslint-plugin-vue": "10.9.1",
-    "globals": "17.6.0",
-    "typescript-eslint": "8.59.3",
-    "vue-eslint-parser": "10.4.0"
+    "eslint-plugin-vue": "10.11.1",
+    "globals": "17.13.0",
+    "typescript-eslint": "8.72.0",
+    "vue-eslint-parser": "10.4.1"
   },
   "devDependencies": {
-    "eslint": "10.4.0",
+    "eslint": "10.13.0",
     "typescript": "6.0.3",
-    "vitest": "4.1.6"
+    "vitest": "5.0.5"
   },
   "peerDependencies": {
     "eslint": ">=10.0.0"

package/vue.js

@@ -7,6 +7,11 @@ import noRelativeImportPathsPlugin from './no-relative-import-paths.js'
 export default [
   ...baseConfig,
   ...vuePlugin.configs['flat/recommended'],
+  {
+    // eslint-plugin-vue sets sourceType: 'module' for every file; restore ESLint's default for .cjs
+    files: [ '**/*.cjs' ],
+    languageOptions: { sourceType: 'commonjs' },
+  },
   {
     plugins: {
       vue: vuePlugin,

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',
-  },
-})