@plntr/eslint-config

eslint-config-plntr

This package provides Planitar's .eslintrc as an extensible shared config. This config should be used in any JS project developed by Planitar.

The package follows Planitar's JS code conventions and is built on top of Airbnb's eslint config.

Usage

Three ESLint configurations are provided:

• esm is an ES6+ configuration.
• es5 is an ES5 configuration.
• react-jsx is a React specific configuration.
• vue is a Vue specific configuration.

All three ESLint configurations listed above come in 2 variations:

• a strict and unforgiving configuration that should be used before code is committed or deployed to production.
• a more relaxed configuration where syntactic rules are set to warning level, that can be used in dev environment; prefixed with -dev.

List of provided configurations:

Type	"extends" path	Description
ES6+	plntr/esm	strict esm config
	plntr/esm-dev	relaxed esm config
React JSX	plntr/react-jsx	strict react-jsx config
	plntr/react-jsx-dev	relaxed react-jsx config
Vue	plntr/vue	strict vue config
	plntr/vue-dev	relaxed vue config
Jest	plntr/jest	strict jest config
	plntr/jest-dev	relaxed jest config
Typescript	plntr/typescript	strict typescript config
	plntr/typescript-dev	relaxed typescript config
ES5	plntr/es5	strict es5 config
	plntr/es5-dev	relaxed es5 config

In order to use any of the configs just add "extends": "<IMPORT PATH>" to your eslintrc.* file. For example, if you want to use React JSX rules, add "extends": "react-jsx".

By default if you just import the package, "extends": "plntr", a strict esm config is used.

Note: eslint documentation mentions:

A sharable configuration is an npm package that exports a configuration object. Make sure the package has been installed to a directory where ESLint can require it.

The extends property value can omit the eslint-config- prefix of the package name.

Since the package name is eslint-config-plntr, when it is used in extends property the prefix can be omitted, hence the "extends" paths listed above all use plntr instead of eslint-config-plntr.