Skip to content
This repository has been archived by the owner on Feb 17, 2018. It is now read-only.

Latest commit

 

History

History
30 lines (20 loc) · 1.45 KB

README.md

File metadata and controls

30 lines (20 loc) · 1.45 KB

JavaScript

A hopefully sane JavaScript code styleguide for Subchannel projects. To maintain conformance we created a shareable ESLint configuration package which is included in this repository.

Codeship Status for subchannel/javascript Code Climate

Installation and Usage

First install ESLint and the Subchannel configuration and save them to your project’s devDependencies using Yarn or npm. You may choose to install them globally but that is up to you.

$ yarn add --dev eslint eslint-config-subchannel
$ npm install --save-dev eslint eslint-config-subchannel

Create or modify your project’s .eslintrc file to extend from the Subchannel configuration.

{
  "extends": "subchannel"
}

Now when you run eslint it will use the Subchannel configuration.

More detailed and thorough guides for installing and integrating ESLint with developer tools like Atom and Sublime Text can be found on their website, http://eslint.org.