Registry / testing / eslint-config-vtex

eslint-config-vtex

library15.1.0jsnpmunverified

VTEX's shared ESLint configuration, version 15.1.0. It provides a preset for both JavaScript and TypeScript projects, automatically applying TypeScript rules for .ts/.tsx files and requiring type-checking via tsconfig. The config is extensible and integrates with Prettier. Released monthly with breaking changes following VTEX's internal needs. Differentiates from other configs by its opinionated set of rules tuned for VTEX's ecosystem, including React and Node.js practices.

testing devops

npm install eslint-config-vtex

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-CONFIG-VTEX

eslint-config-vtex

testingjavascriptv15.1.0

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.

vtex (config name)

✓ // .eslintrc { "extends": ["vtex"] }

✗ // wrong: extends as a string { "extends": "vtex" }

In ESLint 8, 'extends' expects an array. Single string works but array is recommended for adding other configs.

babel-eslint parser for JS files

✓ parser: "babel-eslint"

✗ // wrong: misspelled parser: "babel-eslint-parser"

For TypeScript projects, parser is auto-detected; only set for JS override.

TypeScript type-checking rules

✓ // tsconfig.eslint.json { "extends": "./tsconfig.json", "include": ["**/*.ts", "**/*.tsx", "**/*.js"], "exclude": [] }

✗ // wrong: including node_modules { "exclude": [] }

Required for rules requiring type information. Ensure tsconfig includes all linted files.

Shows basic ESLint config extending vtex preset and overriding one rule.

// .eslintrc { "extends": ["vtex"], "rules": { "no-console": "warn" } }

Debug

Known issues

breakingIn v15, dropped support for ESLint 7; requires ESLint ^8.

fix

Upgrade ESLint to version 8 or later.

affects: >=15.0.0

deprecatedbabel-eslint is deprecated; use @babel/eslint-parser instead.

fix

Replace 'babel-eslint' with '@babel/eslint-parser' in dependencies and config.

affects: >=0.0.0

gotchaTypeScript type-checking rules require a tsconfig.json including all files.

fix

Create tsconfig.eslint.json that extends base and includes needed files.

affects: >=1.0.0

gotchaUsing 'extends' as a string instead of array can cause issues with override resolution.

fix

Always use array syntax: "extends": ["vtex"].

affects: >=0.0.0

Errors

Common errors & fixes

Error: Cannot find module 'eslint-config-vtex'

Missing package installation or incorrect extends value.

fix

Run: yarn add -D eslint-config-vtex (or npm install --save-dev eslint-config-vtex)

ESLint: Error while loading rule '@typescript-eslint/...': You have used a rule which requires parserServices to be generated. You must provide 'parserOptions.project'.

Missing tsconfig for type-checking rules.

fix

Add tsconfig.eslint.json and set parserOptions.project: './tsconfig.eslint.json'

Error: Failed to load parser 'babel-eslint'

babel-eslint not installed or wrong parser name.

fix

Install @babel/eslint-parser and use parser: '@babel/eslint-parser'

Upgrade

Version history

15.1.0latest on npm

Audit

Dependencies

eslintrequiredpeer dependency for linting

prettierrequiredpeer dependency for code formatting

typescriptoptionalpeer dependency for TypeScript support

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/vtex/typescript ↗

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