README.md

eslint-config-k14v

This package provides the k14v eslint config

Install

You can install this package with, NPM:

npm install --save-dev eslint-config-k14v

or with Yarn:

yarn add eslint-config-k14v --dev

Peer Depencencies

This package don't have any package as dependency, all it have is peerDependencies. You can install only what it's needed.

Install all peerDependencies

NPM:

npm install --save-dev eslint eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks

Yarn:

yarn eslint eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks --dev

Install peerDependencies just for javascript

NPM:

npm install --save-dev eslint eslint-plugin-import

Yarn:

yarn eslint eslint-plugin-import --dev

Usage

Open your .eslintrc configuration file and add the following:

  "extends": [ "eslint-config-k14v" ],

If you want the React rules, use:

  "extends": [ "eslint-config-k14v/react" ]

React rules extends the base rules. So, you will have both.

In the end your .eslintrc file will look something like:

module.exports = {
  "extends": [ "eslint-config-k14v" ],
  "rules": {},
}

Override rules

The rules in this config can be overriden setting your own rules in your .eslintrc config file.