eslint-config-vi

ESLint shareable config used by VI Company

Usage no npm install needed!

<script type="module">
  import eslintConfigVi from 'https://cdn.skypack.dev/eslint-config-vi';
</script>

README

eslint-config-vi

npm Build Status Renovate enabled

This package provides an ESLint config for the VI Company's JS coding style.

Why another config?

The eslint-config-vi is based on the eslint-config-airbnb-base config. That config is well maintained and we agree with most of the rules set. We extend the eslint-config-airbnb-base with our own rules.
The eslint-config-airbnb-base is defined as a peerDependency so it should be installed separately.

Installation

To make use of this config, install this package and its peerDepencies as a development dependencies of your project. eslint-config-airbnb-base also makes use of peerDependencies which also needs to be installed:

npx install-peerdeps eslint-config-vi
npx install-peerdeps eslint-config-airbnb-base -o

Usage

Create a .eslintrc.* config file:

.eslintrc.js

module.exports = {
  extends: 'vi'
};

.eslintrc.json

{
  "extends": "vi"
}

Configuration

The default vi config supports ES2015+ code and targets the browser.

Node.js

For Node.js development you can use the eslint-config-vi/node config:

.eslintrc.js

module.exports = {
  extends: 'eslint-config-vi/node'
};

Changelog

Read the Changelog

License

MIT © VI Company