1.0.0 • Published 5 years ago

@ofadiman/eslint-config-ofadiman-base v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 years ago

Custom eslint config

This package includes a shareable ESLint configuration used by Ofadiman. Beware that it hasn't been tested for JavaScript apps, and it's been developed with TypeScript projects in mind.

Usage

In order to use this config you have to first install this package via npm:

npm i -D @ofadiman/eslint-config-ofadiman

Or if you are using yarn:

yarn add @ofadiman/eslint-config-ofadiman -D

Then create a file named .eslintrc in a desired directory with following contents in the root folder of your project/package:

{
  "extends": "@ofadiman/eslint-config-ofadiman-base",
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "project": "./tsconfig.json",
    "ecmaVersion": 2018,
    "sourceType": "module"
  }
}

Finally, you have to install peerDependencies. You can do this manually or with some cli tools like install-peerdeps.

That's it! You can override the settings from this config by editing the .eslintrc file.