@waiting/eslint-config

ESLint Shareable Configuration for Typescrpt

Usage no npm install needed!

<script type="module">
  import waitingEslintConfig from 'https://cdn.skypack.dev/@waiting/eslint-config';
</script>

README

eslint-config

A strict TypeScript ESLint Shareable Config for instead of TSlint

Version License Conventional Commits

Features

  • @waiting/eslint-config/recommended extends and customize from
    • eslint-plugin-import
    • eslint-plugin-node
    • eslint-plugin-unicorn
    • eslint:recommended
    • @typescript-eslint/recommended
    • @typescript-eslint/recommended-requiring-type-checking
  • @waiting/eslint-config extends @waiting/eslint-config/strict and more strict rules enabled

Install

npm i -D @waiting/eslint-config eslint

Usage

Shareable configs are designed to work with the extends feature of .eslintrc.* files. You can learn more about Shareable Configs on the official ESLint website.

Add this to your .eslintrc.* file:

  • .eslintrc.yml
    extends: '@waiting/eslint-config'
  • .eslintrc.json
    {
  "extends": "@waiting/eslint-config"
}

You can override settings from the shareable config by adding them directly into your .eslintrc.* file. And add file .eslintrc.yml under the folder such as ./test for fast linting with less strict rules:

# .eslintrc.yml
extends: '@waiting/eslint-config/recommended'

Linting

eslint --fix src/**/*.ts
eslint src/**/*.{ts,js}

Learn more

License

MIT

Languages