@on-running/eslint-config

ESLint Config

On running Eslint config for Javascript and Typescript applications

How to use

For JavaScript

Install the package as a dev dependency:

yarn add --dev @on-running/eslint-config

Create an ESLint config .eslintrc.yml file in the root of your project with the content below:

extends: "@on-running/eslint-config" 

Ensure the package's required peer dependencies - eslint >= 8.0.0 are installed.

For TypeScript

Install the package as a dev dependency:

yarn add --dev @on-running/eslint-config

Create an ESLint config .eslintrc.yml file in the root of your project with the content below:

extends: "@on-running/eslint-config/typescript"

Create a tsconfig.eslint.json file if you don't alreay have one with the following content:

{
  "extends": "./tsconfig.json",
  "include": ["./*.ts", "src", "test", "tests"],
  "exclude": [""]
}

Ensure the package's required peer dependencies - eslint >= 8.0.0, typescript >= 4.0.0 are installed.

Publish new release

To publish a new release of the package start your commit message with any of the following:

release('minor'): for minor release
release('patch'): for patch release
release('major'): for a major release