This guide is based on airbnb Guide with adaptations from the npm style guide
- Types
- Objects
- Arrays
- Strings
- Functions
- Properties
- Variables
- Hoisting
- Conditional Expressions & Equality
- Blocks
- Comments
- Whitespace
- Comma First
- Semicolons
- Asynchronous
- Type Casting & Coercion
- Naming Conventions
- Accessors
- Constructors
- Errors
- Modules
- jQuery
- ES5 Compatability
- Testing
- Performance
- Resources
- Alternatives
- The JavaScript Style Guide Guide
- Contributors
- License
Primitives: When you access a primitive type you work directly on its value
StringNumberBooleannullundefined
varfoo=1,bar=foo;bar=9;console.log(foo,bar);// => 1, 9
Complex: When you access a complex type you work on a reference to its value
ObjectArrayFunction
varfoo=[1,2],bar=foo;bar[0]=9;console.log(foo[0],bar[0]);// => 9, 9
Use the literal syntax for object creation.
// badvaritem=newObject();// goodvaritem={};
Don't use reserved words as keys.
// badvarsuperman={class: 'superhero',default: {clark: kent},private: true};// goodvarsuperman={klass: 'superhero',defaults: {clark: kent},hidden: true};
Use the literal syntax for array creation
// badvaritems=newArray();// goodvaritems=[];
For performance reasons use direct assignment over Array#push
varlen=items.length,itemsCopy=[],i;// badfor(i=0;i<len;i++){itemsCopy.push(items[i])}// goodfor(i=0;i<len;i++){itemsCopy[i]=items[i];}
Use single quotes
''for strings// badvarname="Bob Parr";// goodvarname='Bob Parr';// badvarfullName="Bob"+this.lastName;// goodvarfullName='Bob'+this.lastName;
Strings longer than 80 characters should be written across multiple lines using string concatenation.
// badvarerrorMessage='This is a super long error that was thrown because of Batman. When you stop to think about how Batman had anything to do with this, you would get nowhere fast.';// badvarerrorMessage='This is a super long error that \was thrown because of Batman. \When you stop to think about \how Batman had anything to do \with this, you would get nowhere \fast.';// goodvarerrorMessage='This is a super long error that '+'was thrown because of Batman.'+'When you stop to think about '+'how Batman had anything to do '+'with this, you would get nowhere '+'fast.';
When programatically building up a string, use Array#join instead of string concatenation. Mostly for IE: jsPerf.
varitems,messages,length,i;messages=[{state: 'success',message: 'This one worked.'},{state: 'success',message: 'This one worked as well.'},{state: 'error',message: 'This one did not work.'}];length=messages.length;// badfunctioninbox(messages){items='<ul>';for(i=0;i<length;i++){items+='<li>'+messages[i].message+'</li>';}returnitems+'</ul>';}// goodfunctioninbox(messages){items=[];for(i=0;i<length;i++){items[i]=messages[i].message;}return'<ul><li>'+items.join('</li><li>')+'</li></ul>';}
- Use named functions. They make stack traces a lot easier to read and they avoid problems with hoisting
- Function expressions:
// named function expressionvarnamed=functionnamed(){returntrue;};// immediately-invoked function expression (IIFE)(function(){console.log('Welcome to the Internet. Please follow me.');})();// **avoid** anonymous function expressionvaranonymous=function(){returntrue;};Never declare a function in a non-function block (if, while, etc). Assign the function to a variable instead. Browsers will allow you to do it, but they all interpret it differently, which is bad news bears.
// badif(currentUser){functiontest(){console.log('Nope.');}}// goodif(currentUser){vartest=functiontest(){console.log('Yup.');};}
Never name a parameter
arguments, this will take precendence over theargumentsobject that is given to every function scope.// badfunctionnope(name,options,arguments){// ...stuff...}// goodfunctionyup(name,options,args){// ...stuff...}
Use dot notation when accessing properties.
varluke={jedi: true,age: 28};// badvarisJedi=luke['jedi'];// goodvarisJedi=luke.jedi;
Use subscript notation
[]when accessing properties with a variable.varluke={jedi: true,age: 28};functiongetProp(prop){returnluke[prop];}varisJedi=getProp('jedi');
Always use
varto declare variables. Not doing so will result in global variables. We want to avoid polluting the global namespace. Captain Planet warned us of that.// badsuperPower=newSuperPower();// goodvarsuperPower=newSuperPower();
Use one
vardeclaration for multiple variables and declare each variable on a newline.// badvaritems=getItems();vargoSportsTeam=true;vardragonball='z';// goodvaritems=getItems(),goSportsTeam=true,dragonball='z';
Declare unassigned variables last. This is helpful when later on you might need to assign a variable depending on one of the previous assigned variables.
// badvari,len,dragonball,items=getItems(),goSportsTeam=true;// badvari,items=getItems(),dragonball,goSportsTeam=true,len;// goodvaritems=getItems(),goSportsTeam=true,dragonball,i,length;
Assign variables at the top of their scope. This helps avoid issues with variable declaration and assignment hoisting related issues.
// badfunction(){test();console.log('doing stuff..');//..other stuff..varname=getName();if(name==='test'){returnfalse;}returnname;}// goodfunction(){varname=getName();test();console.log('doing stuff..');//..other stuff..if(name==='test'){returnfalse;}returnname;}// badfunction(){varname=getName();if(!arguments.length){returnfalse;}returntrue;}// goodfunction(){if(!arguments.length){returnfalse;}varname=getName();returntrue;}
Variable declarations get hoisted to the top of their scope, their assignment does not.
// we know this wouldn't work (assuming there// is no notDefined global variable)functionexample(){console.log(notDefined);// => throws a ReferenceError}// creating a variable declaration after you// reference the variable will work due to// variable hoisting. Note: the assignment// value of `true` is not hoisted.functionexample(){console.log(declaredButNotAssigned);// => undefinedvardeclaredButNotAssigned=true;}// The interpretor is hoisting the variable// declaration to the top of the scope.// Which means our example could be rewritten as:functionexample(){vardeclaredButNotAssigned;console.log(declaredButNotAssigned);// => undefineddeclaredButNotAssigned=true;}
Anonymous function expression hoist their variable name, but not the function assignment.
functionexample(){console.log(anonymous);// => undefinedanonymous();// => TypeError anonymous is not a functionvaranonymous=function(){console.log('anonymous function expression');};}
Named function expressions hoist the variable name, not the function name or the function body.
functionexample(){console.log(named);// => undefinednamed();// => TypeError named is not a functionsuperPower();// => ReferenceError superPower is not definedvarnamed=functionsuperPower(){console.log('Flying');};// the same is true when the function name// is the same as the variable name.functionexample(){console.log(named);// => undefinednamed();// => TypeError named is not a functionvarnamed=functionnamed(){console.log('named');};}}
Function declarations hoist their name and the function body.
functionexample(){superPower();// => FlyingfunctionsuperPower(){console.log('Flying');}}
For more information refer to JavaScript Scoping & Hoisting by Ben Cherry
Use
===and!==over==and!=.Conditional expressions are evaluated using coercion with the
ToBooleanmethod and always follow these simple rules:- Objects evaluate to true
- Undefined evaluates to false
- Null evaluates to false
- Booleans evaluate to the value of the boolean
- Numbers evalute to false if +0, -0, or NaN, otherwise true
- Strings evaluate to false if an empty string
'', otherwise true
if([0]){// true// An array is an object, objects evaluate to true}
Use shortcuts.
// badif(name!==''){// ...stuff...}// goodif(name){// ...stuff...}// badif(collection.length>0){// ...stuff...}// goodif(collection.length){// ...stuff...}
For more information see Truth Equality and JavaScript by Angus Croll
Use braces with all multi-line blocks.
// badif(test)returnfalse;// goodif(test)returnfalse;// goodif(test){returnfalse;}// badfunction(){returnfalse;}// goodfunction(){returnfalse;}
Use
/** ... */for multiline comments. Include a description, specify types and values for all parameters and return values.// bad// make() returns a new element// based on the passed in tag name//// @param <String> tag// @return <Element> elementfunctionmake(tag){// ...stuff...returnelement;}// good/** * make() returns a new element * based on the passed in tag name * * @param <String> tag * @return <Element> element */functionmake(tag){// ...stuff...returnelement;}
Use
//for single line comments. Place single line comments on a newline above the subject of the comment. Put an emptyline before the comment.// badvaractive=true;// is current tab// good// is current tabvaractive=true;// badfunctiongetType(){console.log('fetching type...');// set the default type to 'no type'vartype=this._type||'no type';returntype;}// goodfunctiongetType(){console.log('fetching type...');// set the default type to 'no type'vartype=this._type||'no type';returntype;}
Use soft tabs set to 4 spaces
// badfunction(){∙∙varname;}// badfunction(){∙varname;}// goodfunction(){∙∙∙∙varname;}
Place 1 space before the leading brace.
// badfunctiontest(){console.log('test');}// goodfunctiontest(){console.log('test');}// baddog.set('attr',{age: '1 year',breed: 'Bernese Mountain Dog'});// gooddog.set('attr',{age: '1 year',breed: 'Bernese Mountain Dog'});
Do not place a space after a control statement
// bad if (bad) mojo ()
// good if(good) luck() ```
Do not have more than 1 blank line at the end of a file
// bad(function(global){// ...stuff...})(this);
// good(function(global){// ...stuff...})(this);
Use indentation when making long method chains.
// bad$('#items').find('.selected').highlight().end().find('.open').updateCount();// good$('#items').find('.selected').highlight().end().find('.open').updateCount();// badvarleds=stage.selectAll('.led').data(data).enter().append("svg:svg").class('led',true).attr('width',(radius+margin)*2).append("svg:g").attr("transform","translate("+(radius+margin)+","+(radius+margin)+")").call(tron.led);// goodvarleds=stage.selectAll('.led').data(data).enter().append("svg:svg").class('led',true).attr('width',(radius+margin)*2).append("svg:g").attr("transform","translate("+(radius+margin)+","+(radius+margin)+")").call(tron.led);**[[⬆]](#TOC)** Yes.
If there is a list of things separated by commas, and it wraps across multiple lines, put the comma at the start of the next line, directly below the token that starts the list. Put the final token in the list on a line by itself.
// badvaronce,upon,aTime;// goodvaronce,upon,aTime// badvarhero={firstName: 'Bob',lastName: 'Parr',heroName: 'Mr. Incredible',superPower: 'strength'};// goodvarmagicWords=["abracadabra","gesundheit","ventrilo"],spells={"fireball" : function(){setOnFire()},"water" : function(){putOut()}},a=1,b="abc",etc,somethingElse
results in:
- easier to identify missing separaters (esp. in code reviews)
Don't use them except in four situations:
for (;) loops. They're actually required.
null loops like: while (something) ; (But you'd better have a good reason for doing that.)
case "foo": doSomething(); break
In front of a leading ( or [ at the start of the line. This prevents the expression from being interpreted as a function call or property access, respectively.
// bad(function(){varname='Skywalker';returnname;})();// good;(x||y).doSomething();[a,b,c].forEach(doSomething)for(vari=0;i<10;i++){switch(state){case"begin": start();continuecase"end": finish();breakdefault: thrownewError("unknown state")}end()};(function(window){// do something})()
- The callback should always be the last argument in the list. Its first argument is the Error or null. - Send the error message back as the first argument to the callback. ```javascript // bad function async(data, callback){var result = doStuff() if(isError(result)) throw new Error('I kill state and failed to inform') } // good function async(data, callback){var result = doStuff() if(isError(result)) callback(result) else callback(null, result) } ``` **[[⬆]](#TOC)** Perform type coercion at the beginning of the statement.
Strings:
// => this.reviewScore = 9;// badvartotalScore=this.reviewScore+'';// goodvartotalScore=''+this.reviewScore;// badvartotalScore=''+this.reviewScore+' total score';// goodvartotalScore=this.reviewScore+' total score';
Use
parseIntfor Numbers and always with a radix for type casting.If for whatever reason you are doing something wild and
parseIntis your bottleneck and need to use Bitshift for performance reasons, leave a comment explaining why and what you're doing.varinputValue='4';// badvarval=newNumber(inputValue);// badvarval=+inputValue;// badvarval=inputValue>>0;// badvarval=parseInt(inputValue);// goodvarval=Number(inputValue);// goodvarval=parseInt(inputValue,10);// good/** * parseInt was the reason my code was slow. * Bitshifting the String to coerce it to a * Number made it a lot faster. */varval=inputValue>>0;
Booleans:
varage=0;// badvarhasAge=newBoolean(age);// goodvarhasAge=Boolean(age);// goodvarhasAge=!!age;
- In general avoid single letter names. Be descriptive.
// badfunctionq(){// ...stuff...}// goodfunctionquery(){// ..stuff..}```- Use camelCase when naming objects, functions, and instances ```javascript// badvarOBJEcttsssss={};varthis_is_my_object={};varthis-is-my-object={};functionc(){};varu=newuser({name: 'Bob Parr'});// goodvarthisIsMyObject={};functionthisIsMyFunction(){};varuser=newUser({name: 'Bob Parr'});```- Use PascalCase when naming constructors or classes ```javascript// badfunctionuser(options){this.name=options.name;}varbad=newuser({name: 'nope'});// goodfunctionUser(options){this.name=options.name;}vargood=newUser({name: 'yup'});```- Use a leading underscore `_` when naming private properties ```javascript// badthis.__firstName__='Panda';this.firstName_='Panda';// goodthis._firstName='Panda';```- Name your functions. This is helpful for stack traces. ```javascript// badvarlog=function(msg){console.log(msg);};// goodvarlog=functionlog(msg){console.log(msg);};``` **[[⬆]](#TOC)**## <a name='accessors'>Accessors</a>- Accessor functions for properties are not required- If you do make accessor functions use getVal() and setVal('hello') ```javascript// baddragon.age();// gooddragon.getAge();// baddragon.age(25);// gooddragon.setAge(25);```- If the property is a boolean, use isVal() or hasVal() ```javascript// badif(!dragon.age()){returnfalse;}// goodif(!dragon.hasAge()){returnfalse;}```- It's okay to create get() and set() functions, but be consistent. ```javascriptfunctionJedi(options){options||(options={});varlightsaber=options.lightsaber||'blue';this.set('lightsaber',lightsaber);}Jedi.prototype.set=function(key,val){this[key]=val;};Jedi.prototype.get=function(key){returnthis[key];};``` **[[⬆]](#TOC)**## <a name='constructors'>Constructors</a>- 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! ```javascriptfunctionJedi(){console.log('new jedi');}// badJedi.prototype={fight: functionfight(){console.log('fighting');},block: functionblock(){console.log('blocking');}};// goodJedi.prototype.fight=functionfight(){console.log('fighting');};Jedi.prototype.block=functionblock(){console.log('blocking');};```- Methods can return `this` to help with method chaining. ```javascript// badJedi.prototype.jump=function(){this.jumping=true;returntrue;};Jedi.prototype.setHeight=function(height){this.height=height;};varluke=newJedi();luke.jump();// => trueluke.setHeight(20)// => undefined// goodJedi.prototype.jump=function(){this.jumping=true;returnthis;};Jedi.prototype.setHeight=function(height){this.height=height;returnthis;};varluke=newJedi();luke.jump().setHeight(20);```- It's okay to write a custom toString() method, just make sure it works successfully and causes no side effects. ```javascriptfunctionJedi(options){options||(options={});this.name=options.name||'no name';}Jedi.prototype.getName=functiongetName(){returnthis.name;};Jedi.prototype.toString=functiontoString(){return'Jedi - '+this.getName();};``` **[[⬆]](#TOC)**## <a name='errors'>Errors</a>- Never throw in an asynchronous method.- always create a new Error object as it provides a call stack for debugging**[[⬆]](#TOC)**## <a name='modules'>Modules</a>- The module should start with a `!`. This ensures that if a malformed module forgets to include a final semicolon there aren't errors in production when the scripts get concatenated.- The file should be named with camelCase, live in a folder with the same name, and match the name of the single export.- Add a method called noConflict() that sets the exported module to the previous version.- Always declare `'use strict';` at the top of the module. ```javascript// fancyInput/fancyInput.js!function(global){'use strict';varpreviousFancyInput=global.FancyInput;functionFancyInput(options){options||(options={});}FancyInput.noConflict=functionnoConflict(){global.FancyInput=previousFancyInput;};global.FancyInput=FancyInput;}(this);``` **[[⬆]](#TOC)**## <a name='jquery'>jQuery</a>- Prefix jQuery object variables with a `$`. ```javascript// badvarsidebar=$('.sidebar');// goodvar$sidebar=$('.sidebar');```- Cache jQuery lookups. ```javascript// badfunctionsetSidebar(){$('.sidebar').hide();// ...stuff...$('.sidebar').css({'background-color': 'pink'});}// goodfunctionsetSidebar(){var$sidebar=$('.sidebar');$sidebar.hide();// ...stuff...$sidebar.css({'background-color': 'pink'});}```- For DOM queries use Cascading `$('.sidebar ul')` or parent > child `$('.sidebar > .ul')`. [jsPerf](http://jsperf.com/jquery-find-vs-context-sel/16)- Use `find` with scoped jQuery object queries. ```javascript// bad$('.sidebar','ul').hide();// bad$('.sidebar').find('ul').hide();// good$('.sidebar ul').hide();// good$('.sidebar > ul').hide();// good (slower)$sidebar.find('ul');// good (faster)$($sidebar[0]).find('ul');``` **[[⬆]](#TOC)**## <a name='es5'>ECMAScript 5 Compatability</a>- Refer to [Kangax](https://twitter.com/kangax/)'s ES5 [compatibility table](http://kangax.github.com/es5-compat-table/)**[[⬆]](#TOC)**## <a name='testing'>Testing</a>- **Yes.**A separate describe (object literal in the case of nodeunit) is used for each functional unit tested. This keepsbeforeEach and afterEach relevant to the unit under test and helps to group tests. ```javascriptfunction(){returntrue;}``` **[[⬆]](#TOC)**## <a name='performance'>Performance</a>- [String vs Array Concat](http://jsperf.com/string-vs-array-concat/2)- [Try/Catch Cost In a Loop](http://jsperf.com/try-catch-in-loop-cost)- [Bang Function](http://jsperf.com/bang-function)- [jQuery Find vs Context, Selector](http://jsperf.com/jquery-find-vs-context-sel/13)- Loading...**[[⬆]](#TOC)**## <a name='alternatives'>Alternatives</a>This section highlights considerations when choosing an alternative style- **comma-first** If your team chooses to not use comma-first then use of jslint and jshint is necessary to identify syntax errors as well as placing "use strict"; at the top of the functional scope to avoid global variable declarations. Before avoiding comma-first, consider [is there something to the crazy comma-first style](http://ajaxian.com/archives/is-there-something-to-the-crazy-comma-first-style) ```javascript// okvaro={a : "ape",b : "bat",c : "cat",d : "dog",e : "elf",f : "fly",g : "gnu",h : "hat",i : "ibu"},a=[["ape","bat"],["cat","dog"],["elf","fly"],["gnu","hat"],["ibu"]];// preferablevaro={a : "ape",b : "bat",c : "cat",d : "dog",e : "elf",f : "fly",g : "gnu",h : "hat",i : "ibu"},a=[["ape","bat"],["cat","dog"],["elf","fly"],["gnu","hat"],["ibu"]]```- **semi-colons** If your team does not want to rely on automatic semi-colon insertion (ASI) then it is necessary to use jslint and jshint to identify syntax errors and terminate function declarations with semi-colons ```javascript// badfunction(){console.log(arguments.length);// 1}(function(){console.log('I am an argument');})();// okfunction(){console.log(argument.length);// 0};(function(){console.log('I am not an argument');})();// preferablefunction(){console.log(argument.length)// 0};(function(){console.log('I am not an argument');})()``` Inmostcasesit's easier to remember (and identify) when a semi-colon is missing in front of a ( or [ at the beginningofaline. ## <aname='resources'>Resources</a>**ReadThis**-[AnnotatedECMAScript5.1](http://es5.github.com/)**OtherStyleguides**-[GoogleJavaScriptStyleGuide](http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml)-[jQueryCoreStyleGuidelines](http://docs.jquery.com/JQuery_Core_Style_Guidelines)-[PrinciplesofWritingConsistent,IdiomaticJavaScript](https://github.com/rwldrn/idiomatic.js/)**Books**-[JavaScript: TheGoodParts](http://www.amazon.com/JavaScript-Good-Parts-Douglas-Crockford/dp/0596517742)-DouglasCrockford-[JavaScriptPatterns](http://www.amazon.com/JavaScript-Patterns-Stoyan-Stefanov/dp/0596806752)-StoyanStefanov-[ProJavaScriptDesignPatterns](http://www.amazon.com/JavaScript-Design-Patterns-Recipes-Problem-Solution/dp/159059908X)-RossHarmesandDustinDiaz-[HighPerformanceWebSites: EssentialKnowledgeforFront-EndEngineers](http://www.amazon.com/High-Performance-Web-Sites-Essential/dp/0596529309)-SteveSouders-[MaintainableJavaScript](http://www.amazon.com/Maintainable-JavaScript-Nicholas-C-Zakas/dp/1449327680)-NicholasC.Zakas-[JavaScriptWebApplications](http://www.amazon.com/JavaScript-Web-Applications-Alex-MacCaw/dp/144930351X)-AlexMacCaw-[ProJavaScriptTechniques](http://www.amazon.com/Pro-JavaScript-Techniques-John-Resig/dp/1590597273)-JohnResig-[SmashingNode.js: JavaScriptEverywhere](http://www.amazon.com/Smashing-Node-js-JavaScript-Everywhere-Magazine/dp/1119962595)-GuillermoRauch**Blogs**-[DailyJS](//dailyjs.com)-[JavaScriptWeekly](http://javascriptweekly.com/)-[JavaScript,JavaScript...](http://javascriptweblog.wordpress.com/)-[BocoupWeblog](http://weblog.bocoup.com/)-[AdequatelyGood](http://www.adequatelygood.com/)-[NCZOnline](http://www.nczonline.net/)-[PerfectionKills](http://perfectionkills.com/)-[BenAlman](http://benalman.com/)-[DmitryBaranovskiy](http://dmitry.baranovskiy.com/)-[DustinDiaz](http://dustindiaz.com/)-[net.tutsplus](http://net.tutsplus.com/?s=javascript)**[[⬆]](#TOC)** ## <aname='guide-guide'>The JavaScript Style Guide Guide</a>-[Reference](//github.com/airbnb/javascript/wiki/The-JavaScript-Style-Guide-Guide) ## <aname='authors'>Contributors</a>-[ViewContributors](https://github.com/airbnb/javascript/graphs/contributors) ## <aname='license'>License</a>(TheMITLicense)Copyright(c)2012AirbnbPermissionisherebygranted,freeofcharge,toanypersonobtainingacopyofthissoftwareandassociateddocumentationfiles(the'Software'),todealintheSoftwarewithoutrestriction,includingwithoutlimitationtherightstouse,copy,modify,merge,publish,distribute,sublicense,and/orsellcopiesoftheSoftware,andtopermitpersonstowhomtheSoftwareisfurnishedtodoso,subjecttothefollowingconditions: TheabovecopyrightnoticeandthispermissionnoticeshallbeincludedinallcopiesorsubstantialportionsoftheSoftware.THESOFTWAREISPROVIDED'AS IS',WITHOUTWARRANTYOFANYKIND,EXPRESSORIMPLIED,INCLUDINGBUTNOTLIMITEDTOTHEWARRANTIESOFMERCHANTABILITY,FITNESSFORAPARTICULARPURPOSEANDNONINFRINGEMENT.INNOEVENTSHALLTHEAUTHORSORCOPYRIGHTHOLDERSBELIABLEFORANYCLAIM,DAMAGESOROTHERLIABILITY,WHETHERINANACTIONOFCONTRACT,TORTOROTHERWISE,ARISINGFROM,OUTOFORINCONNECTIONWITHTHESOFTWAREORTHEUSEOROTHERDEALINGSINTHESOFTWARE.**[[⬆]](#TOC)** # };