JavaScript Style Guide
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 27 commits ahead, 1449 commits behind airbnb:master.
clark800 Merge pull request #31 from clark800/master
Update to ES6 and add no-unused-expressions rule
Latest commit fac6483 Nov 18, 2016
Permalink
Failed to load latest commit information.
README.md Add Jetbrains instructions Jul 8, 2015
eslintrc Update to ES6 and add no-unused-expressions rule Nov 19, 2016

README.md

Javascript Style Guide

The Ripple Labs style guide is defined by the eslintrc file in this repository along with the supplemental rules listed below.

Additional Rules not covered by ESLint

  • Declare variables in the deepest possible block and as close to their use as possible (the linter will catch issues with hoisting)
  • Use soft tabs set to 2 spaces
  • Use a leading underscore _ when naming private properties
  • Use stack.push(x) instead of stack[stack.length] = x
  • Copy arrays with Array.slice
  • Convert array-like objects to arrays with Array.prototype.slice.call(arguments)
  • Strings longer than 80 characters should be written across multiple lines using string concatenation.
  • Never name a parameter arguments, this will take precedence over the arguments object that is given to every function scope.
  • Assign methods to the prototype object, instead of overwriting the prototype with a new object. Overwriting the prototype makes inheritance impossible: by resetting the prototype you'll overwrite the base!
  • When attaching data payloads to events (whether DOM events or something more proprietary like Backbone events), pass a hash instead of a raw value. This allows a subsequent contributor to add more data to the event payload without finding and updating every handler for the event. For example, instead of:

Editor Configuration

It is recommended that you configure your text editor to show linter errors while you are typing.

Sublime Text 3

Note that Sublime Text can optionally be configured for vim or emacs key bindings.

Jetbrains products (IDEA, WebStorm)

https://www.jetbrains.com/webstorm/help/eslint.html

  • npm install -g eslint
  • Enable ESLint from File > Settings > Languages and Frameworks > JavaScript > Code Quality Tools > ESLint
  • Point "ESLint package" to the installed eslint (osx default /usr/local/lib/node_modules/eslint)

TODO: Write ESLint rules for

  • Never name a parameter arguments
  • Never assign <Function>.prototype = ...
  • Warn when a variable is explicitly re-assigned

Resources

The rules in the previous section are from the Airbnb Style Guide