Crispy
This is a guide for writing consistent and aesthetically pleasing JavaScript. It is inspired by what is popular within the community, and flavored with some personal opinions.
Installation
$ npm install crispy
Usage
$ ./node_modules/crispy/node_modules/.bin/eslint -c ./node_modules/crispy/.eslintrc ./lib/ ./test/
The Rules
4 Spaces for indention
Use 4 spaces for indenting your code and swear an oath to never mix tabs and spaces—a special kind of hell is awaiting you otherwise.
Newlines
Use UNIX-style newlines (\n
), and a newline character as the last character
of a file. Windows-style newlines (\r\n
) are forbidden inside any repository.
No trailing whitespace
Just like you brush your teeth after every meal, you clean up any trailing whitespace in your JS files before committing. Otherwise the rotten smell of careless neglect will eventually drive away contributors and/or co-workers.
Don't use semicolons unless you have to
There are rare occasions where you need a semicolon. Read about them here.
80(ish) characters per line
Limit your lines to 80 characters. Yes, screens have gotten much bigger over the last few years, but your brain has not. Use the additional room for split screen, your editor supports that, right? And increase the font size so your colleague standing behind can read it too.
Use single quotes
Use single quotes, unless you're writing JSON.
Right:
var foo = 'bar'
Wrong:
var foo = "bar"
Opening braces go on the same line
Your opening braces go on the same line as the statement.
Right:
if true console
Wrong:
if true console
Also, notice the use of whitespace before and after the condition statement.
Declare one variable per var statement
Declare one variable per var statement, it makes it easier to re-order the lines. Put them at the beginning of the function body.
Right:
var keys = 'foo' 'bar'var values = 23 42var object = {}var key while itemslength key = keys objectkey = values
Wrong:
var keys = 'foo' 'bar' values = 23 42 object = {} key; while itemslength key = keys objectkey = values
Use lowerCamelCase for variables, properties and function names
Variables, properties and function names should use lowerCamelCase
. They should also be descriptive. Single character variables and uncommon abbreviations should generally be avoided.
Right:
var adminUser = db
Wrong:
var admin_user = db
Use UpperCamelCase for class names
Class names should be capitalized using UpperCamelCase
.
Right:
{}
Wrong:
{}
Use UPPERCASE for Constants
Constants should be declared as regular variables or static class properties, using all uppercase letters.
Node.js/V8 actually supports mozilla's const extension, but unfortunately that cannot be applied to class members, nor is it part of any ECMA standard.
Right:
var SECOND = 1 * 1000 {} FileFULL_PERMISSIONS = 0777
Wrong:
const SECOND = 1 * 1000 {} FilefullPermissions = 0777
Object/Array creation
Use trailing commas and put short declarations on a single line. Only quote keys when your interpreter complains:
Right:
var a = 'hello' 'world'var b = good: 'code' 'is generally': 'pretty'
Wrong:
var a = 'hello' 'world'var b = "good": 'code' is generally: 'pretty'
Use the === operator
Programming is not about remembering stupid rules. Use the triple equality operator as it will work just as expected.
Right:
var a = 0if a === '' console
Wrong:
var a = 0if a == '' console
Use multi-line ternary operator
The ternary operator should not be used on a single line. Split it up into multiple lines instead.
Right:
var foo = a === b ? 1 : 2
Wrong:
var foo = a === b ? 1 : 2
Do not extend built-in prototypes
Do not extend the prototype of native JavaScript objects. Your future self will be forever grateful.
Right:
var a = if !alength console
Wrong:
Arrayprototype { return !thislength} var a = if a console
Use descriptive conditions
Any non-trivial conditions should be assigned to a descriptive variable:
Right:
var isAuthorized = user || userif isAuthorized console
Wrong:
if user || user console
Write small functions
Keep your functions short. A good function fits on a slide that the people in the last row of a big room can comfortably read. So don't count on them having perfect vision and limit yourself to ~15 lines of code per function.
Return early from functions
To avoid deep nesting of if-statements, always return a function's value as early as possible.
Right:
{ if val < 0 return false if val > 100 return false return true}
Wrong:
{ if val >= 0 if val < 100 return true; else return false; else return false; }
Don't nest closures
Use closures, but try not to nest them. Otherwise your code will become a mess.
Right:
{ console}
Wrong:
Callbacks must be ALWAYS immediate or ALWAYS deferred
isaacs posted a nice explanation here.
Right:
{ if !stuff return process return }
Wrong:
{ if !stuff return // Sometimes returns now... return // Other times returns later}
Object.freeze, Object.preventExtensions, Object.seal, with, eval
Crazy shit that you will probably never need. Stay away from it.
License
MIT, see LICENSE for details.
Acknowledgements
The original version of this guide was created by Felix Geisendörfer.