@planfredapp/eslint-config

@planfredapp/eslint-config

View package on npm

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 >=26
• eslint >= 10
• An ESM flat config file such as eslint.config.js or eslint.config.mjs

Installation

pnpm add -D eslint @planfredapp/eslint-config
# or
npm install --save-dev eslint @planfredapp/eslint-config

Available Configs

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:

• 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

Use the entrypoint that matches the project you are linting.

Base

import config from '@planfredapp/eslint-config'

export default [
  ...config,
]

Vue

import config from '@planfredapp/eslint-config/vue'

export default [
  ...config,
]

Cypress

import config from '@planfredapp/eslint-config/cypress'

export default [
  ...config,
]

Vitest

import config from '@planfredapp/eslint-config/test'

export default [
  ...config,
]

Customizing

Append your own config objects after the shared config:

import vueConfig from '@planfredapp/eslint-config/vue'

export default [
  ...vueConfig,
  {
    ignores: [
      'dist/**',
      'coverage/**',
    ],
  },
  {
    rules: {
      'no-console': 'warn',
    },
  },
]

If one root eslint.config.js combines multiple specialized configs, apply the base config once and scope only each specialized config's additional entries:

import baseConfig from '@planfredapp/eslint-config'
import cypressConfig from '@planfredapp/eslint-config/cypress'
import testConfig from '@planfredapp/eslint-config/test'

const withoutBase = config => config.slice(baseConfig.length)
const scope = (config, files) => config.map(entry => ({
  ...entry,
  files,
}))

export default [
  ...baseConfig,
  ...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
• 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
• 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

pnpm lint
pnpm vitest run test/<relevant-spec>.test.js

Run the complete test suite through GitHub Actions. More details are in TESTING.md. Release history is in CHANGELOG.md.

License

MIT