@ethereumjs/eslint-config-defaults

Common linting configuration for EthereumJS libraries utilizing:

• ESLint
• TypeScript ESLint
• TypeStrict
• Prettier

Exposed CLI commands:

• ethereumjs-config-lint
• ethereumjs-config-lint-fix

Usage

Add .eslintrc.js:

module.exports = {
  extends: "@ethereumjs/eslint-config-defaults"
}

Add prettier.config.js:

module.exports = require('@ethereumjs/eslint-config-defaults/prettier.config.js')

Use CLI commands above in your package.json:

  "scripts": {
    "lint": "ethereumjs-config-lint",
    "lint:fix": "ethereumjs-config-lint-fix",
  }

Getting the most out of linting

This lint package is used as git pre-push hook on EthereumJS VM repo, with the help of Husky.

Note: The name of this package deviates from the standard @ethereumjs/config-xxx, due to an ESLint hard rule on package naming. Reference.

Changelog

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

The format is based on Keep a Changelog (modification: no type change headlines) and this project adheres to Semantic Versioning.

2.0.0 - 2020-08-25

This project got a major overhaul, with several updates to the tooling, including packages renaming and retiring some scripts. Below is a breakdown by package.

Breaking changes

• This package got renamed: @ethereumjs/config-tslint => @ethereumjs/eslint-config-defaults, PRs #29, #32
• Updated shell scripts and overall configuration, PR #34

Following the deprecation of the TSLint project by Palantir, we moved on to ESLint, that allows us to better integrate with TypeScript and Prettier.

• @ethereumjs/config-tslint got renamed to @ethereumjs/eslint-config-defaults
• Removal of scripts ethereumjs-config-tslint and ethereumjs-config-tslint-fix
• Added TypeScript ESLint
• Added TypeStrict
• Added Prettier