@wok-cli/eslint-config-wok

Shared ESLint config for Wok-based templates.

Installation

This module requires @babel/core and eslint@6 as peer dependencies.

npm i @babel/core eslint@6 @wok-cli/eslint-config-wok --save-dev

Usage

This package exposes two main configurations:

Frontend sources configuration

This configuration is based on eslint-config-airbnb-base. Use it to lint source files intended to be executed on the browser.

Add "extends": "@wok-cli/eslint-config-wok/web" to your .eslintrc.json file.

Note: this configuration is aliased as the package main entry as well:

// load the web configuration

"extends": "@wok-cli/eslint-config-wok"

Node sources configuration

This configuration is based on eslint-plugin-node. Use this configuration for source files intended for usage on Node.js.

Add "extends": "@wok-cli/eslint-config-wok/node" to your .eslintrc.json file.

Note: Remember to set the correct target Node.js version in your package.json file in order for eslint-plugin-node to work correctly. Example:

"engines": {
  "node": ">=8.10.0"
}

Usage with prettier

In order to make this configuration interoperable with prettier you have to add the -prettier suffix to the configuration name:

• @wok-cli/eslint-config-wok/web -> @wok-cli/eslint-config-wok/web-prettier
• @wok-cli/eslint-config-wok/node -> @wok-cli/eslint-config-wok/node-prettier

You may also need to install prettier:

npm i prettier --save-dev

Note: this configuration implements the recommended configuration from eslint-plugin-prettier.