@activescott/eslint-config

@activescott/eslint-config

This is @activescott's sharable config for ESLint. The default is optimized for TypeScript. It does prettify other files too including JavaScript, Markdown, etc.

Multiple config may be added to this package in the future as described at https://eslint.org/docs/developer-guide/shareable-configs#sharing-multiple-configs

Usage

Step 1: Add the following dependencies to your project:

yarn add --dev @activescott/eslint-config @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier prettier

Step 2: Enter the following to create a .eslintrc.yaml file in the root with the right content:

printf "extends:\n  - \"@activescott/eslint-config\"\n" > .eslintrc.yaml
printf "semi: false\n" > .prettierrc
printf "node_modules/\n/dist/\n/.next/\n.nyc_output/\ncoverage/\n" | tee .eslintignore .prettierignore

Step 3 (optional): Add the following scripts to package.json:

{
  "scripts": {
    "eslint": "./node_modules/.bin/eslint . --ext .ts",
    "lint": "./node_modules/.bin/prettier -l \"{,!(node_modules)/**/}*.{ts,tsx,md,yml,json,html}\" && yarn run eslint",
    "lint-fix": "./node_modules/.bin/prettier --write \"{,!(node_modules)/**/}*.{ts,tsx,md,yml,json,html}\" && yarn run eslint --fix"
  }
}

See https://eslint.org/docs/user-guide/configuring for more information.

Local Testing

You can also test your shareable config on your computer before publishing by linking your module globally. Type:

yarn link

Then, in your project that wants to use your shareable config, type:

yarn link @activescott/eslint-config

Todo

• build status