activescott/eslint-config

An ESLint sharable config for mixed TypeScript & JavaScript projects

@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:

npm install --save-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": "eslint . --ext ts,tsx,js,jsx",
    "lint": "prettier -l \"{,!(node_modules)/**/}*.{ts,tsx,md,yml,json,html}\" && npm run eslint",
    "lint-fix": "prettier --write \"{,!(node_modules)/**/}*.{ts,tsx,md,yml,json,html}\" && npm run eslint --fix"
  }
}

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

Notes

React

When using React add plugin:react/recommended from package eslint-plugin-react:

extends:
  - ...
  - "plugin:react/recommended"

Local Testing

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

npm link

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

npm link @activescott/eslint-config

Release Process (Deploying to NPM) 🚀

We use semantic-release to consistently release semver-compatible versions. This project deploys to multiple npm distribution tags. Each of the below branches correspond to the following npm distribution tags:

branch	npm distribution tag
master	latest
beta	beta

To trigger a release use a Conventional Commit following Angular Commit Message Conventions on one of the above branches.