Registry / testing / eslint-config-vaadin

eslint-config-vaadin

library1.0.0-beta.5jsnpmunverified

ESLint shareable config for the Vaadin JavaScript style guide. Current version is 1.0.0-beta.5, requiring ESLint ^9 and Prettier ^3 as peer dependencies. Ships TypeScript types. Key differentiators: provides multiple config profiles (JavaScript, TypeScript, Lit, imports, testing, sorting) that can be combined; designed for Vaadin projects but usable elsewhere; actively maintained with flat config support since v1.0.0. This is a pre-release version (beta) so breaking changes may occur.

testing

npm install eslint-config-vaadin

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ESLINT-CONFIG-VAAD

eslint-config-vaadin

testingjavascriptv1.0.0-beta.5

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

javascript

✓ import javascript from 'eslint-config-vaadin/javascript'

✗ const javascript = require('eslint-config-vaadin/javascript')

ESM import; for flat config use spread operator

typescript

✓ import typescript from 'eslint-config-vaadin/typescript'

✗ import tsConfig from 'eslint-config-vaadin'

Named export for TypeScript config; requires underlying JavaScript config

prettier

✓ import prettier from 'eslint-config-vaadin/prettier'

✗ import { prettier } from 'eslint-config-vaadin'

Prettier config must be placed last in extends array

lit

✓ import lit from 'eslint-config-vaadin/lit'

✗ import litConfig from 'eslint-plugin-lit'

Lit config extends eslint-plugin-lit; not a standalone plugin

imports

✓ import importsConfig from 'eslint-config-vaadin/imports'

✗ import importConfig from 'eslint-config-vaadin/import'

Note the 's' in the path

testing

✓ import testing from 'eslint-config-vaadin/testing'

✗ import testConfig from 'eslint-config-vaadin/test'

Config for test files; overrides some rules

sort

✓ import sort from 'eslint-config-vaadin/sort'

✗ import sortConfig from 'eslint-config-vaadin/sorting'

Enables auto-fixable sorting rules; use with caution

Shows how to use three configs with flat config (ESLint 9+).

import javascript from 'eslint-config-vaadin/javascript'; import prettier from 'eslint-config-vaadin/prettier'; import testing from 'eslint-config-vaadin/testing'; export default [ ...javascript, { // Add project-specific overrides }, ...testing, ...prettier, ];

Debug

Known issues

breakingv1.0.0-beta.1 switched to ESLint 9 flat config, breaking all .eslintrc configurations

fix

Migrate to flat config (eslint.config.js) and import configs as arrays.

affects: >=1.0.0-beta.1

deprecatedThe package is in beta; API may change before stable release

fix

Pin to a specific version and watch release notes for breaking changes.

affects: >=1.0.0-alpha.1 <1.0.0

gotchaprettier config must be placed last in the extends array to avoid conflicts

fix

Ensure 'vaadin/prettier' is the last entry in the extends (or flat config array).

affects: >=1.0.0

gotchaThe sort config enables auto-fixable rules that may change order of object keys and exports; ESLint team advises caution

fix

Review sort config documentation and test thoroughly before using.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'eslint-config-vaadin/javascript'

Wrong import path; missing file extension or incorrect path for flat config

fix

Use `import javascript from 'eslint-config-vaadin/javascript'` (no extension) with ESM.

Configuration for rule "import/order" is invalid: Value ["error", {...}] is the wrong type. Expected object but got array.

Outdated config compatible with old ESLint versions; v1.0.0-beta requires flat config format

fix

Update to eslint-config-vaadin@1.0.0-beta.x and use flat config syntax.

ESLint couldn't find the config "vaadin/prettier" after extending "vaadin/typescript".

prettier config not imported or not placed last

fix

Ensure prettier is the last element in the flat config array or extends list.

Upgrade

Version history

1.0.0-beta.5latest on npm

Audit

Dependencies

eslintrequiredpeer dependency required for any ESLint config

prettierrequiredpeer dependency required for prettier config

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/vaadin/eslint-config-vaadin ↗

packagehttps://www.npmjs.com/package/eslint-config-vaadin ↗

homepagehttps://vaadin.com ↗