npm.io
0.1.1 • Published 3 years ago

@uselessjs/eslint-config-base

Licence
MIT
Version
0.1.1
Deps
14
Size
60 kB
Vulns
0
Weekly
0

@uselessjs/eslint-config-base

base eslint config presets

  • Auto fix for formatting with prettier
  • lint JavaScript
  • Lint also for JSON, yaml, markdown
  • Sorted imports, dangling commas for cleaner commit diff
  • Reasonable defaults, best practices, only one-line of config
  • Default Alias mapping "@" => "src", "~" => "./"

Usage

Install
pnpm i -D eslint @uselessjs/eslint-config-base
Config eslint (.eslintrc | .eslintrc.js | .eslintrc.json)
{
  "extends": "@uselessjs/eslint-config-base"
}

You don't need .eslintignore normally as it has been provided by the preset.

add import alias
{
  "settings": {
    "import/resolver": {
      "alias": { // default alias
        "map": [
          ["~", "."],
          ["@", "./src"]
        ],
        "extensions": [".js", ".jsx", ".mjs", ".ts", ".tsx", "mts", ".d.ts"]
      }
    }
  }
}
Add scripts for package.json

For example:

{
  "scripts": {
    "lint": "eslint . --fix"
  }
}