README.md

@extensionengine/eslint-config

This package provides Extension Engine's extensible ESLint config.

Usage

Package contains two shared ESLint configs:

@extensionengine/eslint-config

This is default configuration supporting both server & Vue powered client codebases.

@extensionengine/eslint-config/base

This is base configuration without Vue specific rules.

Install

Use install-peerdeps

npx install-peerdeps --dev @extensionengine/eslint-config

or the classic way:

npm install --save-dev eslint @extensionengine/eslint-config @babel/eslint-parser @babel/eslint-plugin eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-require-sort eslint-plugin-vue eslint-config-standard eslint-config-semistandard

Using @extensionengine/eslint-config in your project

In your local .eslintrc.* extend this configuration

'use strict';

module.exports = {
  root: true,
  extends: '@extensionengine'
};

If you don't need Vue you can use base configuration:

'use strict';

module.exports = {
  root: true,
  extends: '@extensionengine/eslint-config/base'
};

Check ESlint documentation for rules explanation.

Badge

If you are using this config in your project you can include this badge in a readme to let people know that your code is using it.

[![js @extensionengine style](https://badgen.net/badge/code%20style/@extensionengine/black)](https://github.com/ExtensionEngine/eslint-config)