README
addresscloud-eslint-config
Addresscloud eslint specification.
This ESLint configuration aims to standardise Addresscloud's Javascript/ES6 code style.
Table of Contents
Install
In your project install eslint, and the addresscloud package:
npm install --save-dev eslint@^6.5.1 @addresscloud/eslint-config
In your project's root directory create an .eslintrc.js
file, specifying this module using the extends
syntax:
module.exports = {
"extends": "@addresscloud"
};
Usage
You can now run eslint on your source code (e.g. src folder):
node_modules/.bin/eslint src
It is recommended to add this as a script in your package.json so that it can be used for CI/CD, for example:
"scripts": {
"lint": "node_modules/.bin/eslint src",
},
Maintainers
Contributing
PRs accepted. This is a work in progress to try and find a common style across Addresscloud projects.
Small note: If editing the README, please conform to the standard-readme specification.
License
UNLICENSED © 2019 Addresscloud Limited