eslint-plugin-vtex

This package provides VTEX's custom ESLint rules.

Installation

Give that you already have ESLint installed, run:

yarn add -D eslint-plugin-vtex

Usage

After installing the module, just add it to your plugins array inside your .eslintrc.

// .eslintrc
{
  ...,
  "plugins": ["vtex"]
}

Rules

This plugin provides the following custom ESLint rules:

• prefer-early-return: Suggest early returning to prevent nesting and improve code readability.
• enforce-explicit-enum-values: Enforce explicit enum values.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

2.3.0 - 2024-04-29

Added

• vtex/consistent-props-type rule

2.2.1 - 2022-05-30

Added

• vtex/prefer-use-effect-named-callback rule.

2.2.0 - 2022-03-15

Changed

• Include eslint major 8 in peer dependencies range.

2.1.0 - 2021-06-24

Fixed

• Fix OOM on monorepos by optmizing parsing of typescript files

2.0.6 - 2020-11-18

Changed

• Update typescript related tools.

2.0.4 - 2020-10-21

Changed

• Repo url in package.json

2.0.2 - 2020-08-21

Changed

• Add eslint v7 as peer dep

2.0.0 - 2020-08-03

Removed

• vtex/enforce-explicit-enum-values in favor of @typescript-eslint/prefer-enum-initializers.

1.2.0 - 2020-07-01

Added

• Add vtex/enforce-explicit-enum-values rule.

1.1.1 - 2020-06-19

Changed

• [vtex/prefer-early-return] Default maxStatements from 1 to 2.

1.0.3 - 2020-01-24

Fixed

• Changelog on deploy workflow again.

1.0.2 - 2020-01-24

Fixed

• Changelog on deploy workflow.

1.0.1 - 2020-01-24

Fixed

• Missing files in packages.