Installation

The simplest way to install is to simply run the npx command below. This command will automatically detect and use yarn if available.

> npx install-peerdeps --dev eslint-config-shadowacre

You can manually install the eslint-config-shadowacre package, but you'll have to install peer dependencies manually too.

Once installed, pick a configuration that works for you from below.

Add to your package.json

If you want to be able to run the linter with yarn lint then add the lint script to your package.json, like so:

  "scripts": {
    "lint": "npx eslint ."
  },

Configuration

Below are some example .eslintrc.js files using the ShadowAcre eslint configuration as a base.

Basic node.js project (with babel)

/* eslint-env node */
module.exports = {
	root:    true,
	extends: "eslint-config-shadowacre/node",
}

Basic nuxt.js project

/* eslint-env node */
module.exports = {
	root:    true,
	extends: "eslint-config-shadowacre/nuxt",
}

Recommended additional rules

{
	rules: {
		// error when attempting to use vue features that are not available in the projects version of vue:
		"vue/no-unsupported-features":     ["error", { version: "^2.6.14" }],

		// if we have no i18n we can disable this rule:
		"vue/no-bare-strings-in-template": "off",

		// if we have a custom button component we can enforce using it:
		"vue/no-restricted-html-elements": ["error", { element: "button", message: "Please us the custom <SimpleButton /> component" }],
	}
}

Jest config, extending project config

/* eslint-env node */
module.exports = {
	extends: [
		"../.eslintrc.js"
		"eslint-config-shadowacre/jest",
	],
}