GoAbout Javascript Styleguide + ESLint config

This package provides GoAbout's base JS .eslintrc as an extensible shared config. It uses AirBnB's config as a base with a few differences.

The main differences are

• semicolons are not necessary;
• Most errors changed to warnings. Because "errors" prevent webpack-compiled code from running and hence provide unnecessary point of distraction while writing the code. Warnings are still visible and can be fixed later;
• Added config options specific to Adonis.js and Vue.js
• Added config globals specific to Mocha and some other associated unit test frameworks

Usage

Our default export contains all of our ESLint rules, including ECMAScript 6+. It requires eslint and eslint-plugin-import.

0. Install linter itself with npm

npm install eslint eslint-find-rules eslint-plugin-import babel-eslint --save-dev

1. Install the correct versions of each package using npm by adding in packages.json:

  "goabout-eslint-config": "git+https://github.com/goabout/goabout-eslint-config.git" //Will be published to npm later

(And don't forget to run npm install afterwards)

2. Add to your .eslintrc:

var path = require('path');

module.exports = {
  //Your own stuff above
  extends: path.join(__dirname, "node_modules/goabout-eslint-config/index.js")
}

Using with command line

You can enjoy real-time checks in atom by installing linter-eslint.

Using with atom

You can enjoy real-time checks in atom by installing linter-eslint.

Extending rules

Feel free to rewrite rules or extend them using your own .eslintrc. Like that:

// add your custom rules here
'rules': {
  // allow paren-less arrow functions
  'arrow-parens': 0,
  // allow async-await
  'generator-star-spacing': 0
}

Improving this config

Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc?

You can run tests with npm test.

You can make sure this module lints with itself using npm run lint.