ESLint config
ESLint config for JavaScript code.
Table of Contents
Overview
In order to standardize and enforce's JavaScript coding style across multiple codebases, you can adopt ESLint and this shared ESLint config. This document describes the JavaScript style and its inspirations.
Dependencies
ESLint is required to use this package, as it is an ESLint shareable config.
Usage
As this package is held on a private repo, you may want to install it through link, so in this folder, run
npm link
# or
yarn link
To begin using the ESLint config in a codebase, first install ESLint and the config:
# peerdependencies are not installed anymore since npm 3
yarn add @arco-cloud/eslint-config-arco babel-eslint eslint eslint-config-airbnb-base eslint-plugin-import --dev
Then, configure your project's ESLint config to extend eslint-config-arco
(see the ESLint docs on Using a Shareable Config)
Basically, create a .eslintrc
file with this inside
{
"extends": "@arco-cloud/eslint-config-arco"
}
or a.eslintrc.js
javascript file
module.exports = {
extends: "@arco-cloud/eslint-config-arco"
}