@nisje/eslint-plugin

Nisje's ESLint plugin, following our styleguide.

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install @nisje/eslint-plugin:

$ npm install @nisje/eslint-plugin --save-dev

Usage

This plugin exports a base config that enforces best practices.

Create your own .eslintrc.js configuration file:

{
	"extends": "plugin:@nisje/base",
	"plugins": [
		"@nisje"
	]
}

Or see the ESLint docs for more information about configuration file formats.

You can also stack any of the extra shared configs on top of the "base" config by extending an array of linting configs. For example, this package provides a React linting config, which can be added to the base config with the following configuration file:

{
	"extends": [
		"plugin:@nisje/base",
		"plugin:@nisje/react"
	]
}

Available rulesets

The following rulesets are available:

base: Enforces best practices and possible errors
flowtype: Enforces best Flow practices
react: Enforces best React.js practices