Airbnb JavaScript Style Guide() {

Un enfoque altamente razonable para JavaScript

Nota: Esta guía asume que usas Babel, adicionalmente de tener instalado babel-preset-airbnb o su equivalente. También asume que tienes instalado shims/pollyfills en tu aplicación, con airbnb-browser-shims o su equivalente.

Otras Guías de Estilos

• ES5 (Obsoleto)
• React
• CSS-in-JavaScript
• CSS & SASS
• Ruby

Tabla de Contenido

1. Tipos
2. Referencias
3. Objetos
4. Arreglos
5. Destructuring
6. Cadenas de Texto
7. Funciones
8. Notación de Funciones de Flecha
9. Clases y Constructores
10. Módulos
11. Iteradores y Generadores
12. Propiedades
13. Variables
14. Hoisting
15. Expresiones de comparación e igualdad
16. Bloques
17. Comentarios
18. Espacios en blanco
19. Comas
20. Puntos y Comas
21. Casting de Tipos y Coerción
22. Convenciones de nomenclatura
23. Funciones de Acceso
24. Eventos
25. jQuery
26. Compatibilidad con EcmaScript 5
27. Estilos de EcmaScript6+ (ES2015+)
28. Pruebas
29. Desempeño
30. Recursos
31. En la cancha
32. Traducciones
33. La guía de la Guía de Estilos JavaScript
34. Charla con nosotros sobre Javascript
35. Colaboradores
36. Licencia

Tipos

• Primitivos: Cuando accedes a un tipo primitivo, manejas directamente su valor

  • string
  • number
  • boolean
  • null
  • undefined

  constfoo=1;letbar=foo;bar=9;console.log(foo,bar);// => 1, 9

• Complejo: Cuando accedes a un tipo complejo, manejas la referencia a su valor.

  • object
  • array
  • function

  constfoo=[1,2];constbar=foo;bar[0]=9;console.log(foo[0],bar[0]);// => 9, 9

[⬆ regresar a la Tabla de Contenido]

Referencias

• Usa const para todas tus referencias; evita usar var.

¿Por qué? Esto asegura que no reasignes tus referencias, lo que puede llevar a bugs y dificultad para comprender el código.

// malvara=1;varb=2;// bienconsta=1;constb=2;

• Si vas a reasignar referencias, usa let en vez de var.

¿Por qué? El bloque let es de alcance a nivel de bloque a diferencia del alcance a nivel de función de var.

// malvarcount=1;if(true){count+=1;}// bien, usa el letletcount=1;if(true){count+=1;}

• Nota que tanto let como const tienen alcance a nivel de bloque.

// const y let solo existen en los bloques donde// estan definidos{leta=1;constb=1;}console.log(a);// ReferenceErrorconsole.log(b);// ReferenceError

Objetos

• Usa la sintaxis literal para la creación de un objeto.

  // malconstitem=newObject();// bienconstitem={};

• No uses palabras reservadas para nombres de propiedades. No funciona en IE8 Más información. No hay problema de usarlo en módulos de ES6 y en código de servidor.

  // malconstsuperman={default: {clark: 'kent'},private: true};// bienconstsuperman={defaults: {clark: 'kent'},hidden: true};

• Usa sinónimos legibles en lugar de palabras reservadas.

  // malconstsuperman={class: 'alien'};// malconstsuperman={klass: 'alien'};// bienconstsuperman={type: 'alien'};

[⬆ regresar a la Tabla de Contenido]

Arreglos

• Usa la sintaxis literal para la creación de arreglos

  // malconstitems=newArray();// bienconstitems=[];

• Usa Array#push, en vez de asignación directa, para agregar elementos a un arreglo.

  constsomeStack=[];// malsomeStack[someStack.length]='abracadabra';// biensomeStack.push('abracadabra');

• Usa spread de arrays para copiar arreglos.

  constlen=items.length;constitemsCopy=[];leti;// malfor(i=0;i<len;i++){itemsCopy[i]=items[i];}// bienconstitemsCopy=[...items];

• Para convertir un objeto "array-like" (similar a un arreglo) a un arreglo, usa Array#from.

  constfoo=document.querySelectorAll('.foo');constnodes=Array.from(foo);

[⬆ regresar a la Tabla de Contenido]

Destructuring

• Usa object destructuring cuando accedas y uses múltiples propiedades de un objeto.

  ¿Por qué? Destructuring te ahorra crear referencias temporales para esas propiedades.

  // malfunctiongetFullName(user){constfirstName=user.firstName;constlastName=user.lastName;return`${firstName}${lastName}`;}// bienfunctiongetFullName(user){const{ firstName, lastName }=user;return`${firstName}${lastName}`;}// mejorfunctiongetFullName({ firstName, lastName }){return`${firstName}${lastName}`;}

• Usa array destructuring.

  constarr=[1,2,3,4];// malconstfirst=arr[0];constsecond=arr[1];// bienconst[first,second]=arr;

• Usa object destructuring para múltiple valores de retorno, no array destructuring.

  ¿Por qué? Puedes agregar nuevas propiedades en el tiempo o cambiar el orden de las cosas sin afectar la forma en que se llama.

  // malfunctionprocessInput(input){// then a miracle occursreturn[left,right,top,bottom];}// el que llama necesita pensar en el orden de la data de retornoconst[left,__,top]=processInput(input);// bienfunctionprocessInput(input){// then a miracle occursreturn{ left, right, top, bottom };}// el que llama elige solo la data que necesitaconst{ left, top }=processInput(input);

[⬆ regresar a la Tabla de Contenido]

Cadenas de Texto

• Usa comillas simples '' para las cadenas de texto

  // malconstname="Bob Parr";// bienconstname='Bob Parr';

• Las cadenas de texto con una longitud mayor a 100 caracteres deben ser escritas en múltiples líneas usando concatenación.

Nota: Cuando se usa sin criterio, las cadenas de texto largas pueden impactar en el desempeño. jsPerf & Discusión

// malvarerrorMessage='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.';// bienvarerrorMessage='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.';// bienvarerrorMessage='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.';

• Cuando se crean cadenas de texto de forma programática, usa template strings (cadena de plantillas) en vez de concatenación.

¿Por qué? Los template strings te dan mayor legibilidad, sintaxis concisa con nuevas líneas apropiadas y capacidades de interpolación.

// malfunctionsayHi(name){return'How are you, '+name+'?';}// malfunctionsayHi(name){return['How are you, ',name,'?'].join();}// bienfunctionsayHi(name){return`How are you, ${name}?`;}

• Nunca uses eval() en una cadena de texto, abre una caja de Pandora de vulnerabilidades.

[⬆ regresar a la Tabla de Contenido]

Funciones

• Usa declaración de función en vez de expresiones de función.

¿Por qué? Las declaraciones de función son nombradas, por lo que son más sencillas de identificar en las pilas de llamadas. Además todo el contenido de una declaración de función es hoisted, mientras que solo la referencia de una expresión de función es hoisted. Esta regla hace posible que siempre se usen Arrow Functions en vez de las funciones de expresión.

// malconstfoo=function(){};// bienfunctionfoo(){}

• Nunca declares una función en un bloque que no sea de función (if, while, etc). En vez de ello, asigna la función a una variable. Los navegadores te permitirán hacerlo pero todos ellos lo interpretarán de modo diferente, lo que es lamentable.

Nota: ECMA-262 define un bloque como una lista de sentencias. Una declaración de función no es una sentencia. Lee la nota de ECMA-262 sobre este inconveniente.

// malif(currentUser){functiontest(){console.log('Nope.');}}// bienlettest;if(currentUser){test=()=>{console.log('Yup.');};}

• Nunca nombres a un parámetro como arguments, esto tendrá precedencia sobre el objeto arguments que es brindado en cada ámbito de función.

  // malfunctionnope(name,options,arguments){// ...algo...}// bienfunctionyup(name,options,args){// ...algo...}

[⬆ regresar a la Tabla de Contenido]

Notación de Funciones de Flecha

• Cuando debas usar funciones anónimas (como cuando pasas un callback inline), usa la notación de funciones de flecha.

  ¿Por qué? Crea una versión de la función que ejecuta en el contexto de this, lo que usualmente es lo que deseas, además que tiene una sintaxis más concisa.

  ¿Por qué no? Si tienes una función complicada, debes mover esa lógica fuera de su expresión de función nombrada.

  // mal[1,2,3].map(function(x){consty=x+1;returnx*y;});// bien[1,2,3].map((x)=>{consty=x+1;returnx*y;});

• Si el cuerpo de la función consiste en una sola sentencia retornando una expresión sin efectos colaterales, omite las llaves y usa el retorno implícito. De otro modo, mantén las llaves y usa una sentencia de retorno.

  ¿Por qué? Un edulcorante sintáctico. Se lee bien cuando múltiples funciones están encadenadas entre sí.

  // mal[1,2,3].map(number=>{constnextNumber=number+1;`A string containing the ${nextNumber}.`;});// bien[1,2,3].map(number=>`A string containing the ${number}.`);// bien[1,2,3].map((number)=>{constnextNumber=number+1;return`A string containing the ${nextNumber}.`;});// bien[1,2,3].map((number,index)=>({[index]: number,}));// Sin efectos colaterales para retorno implícitofunctionfoo(callback){constval=callback();if(val===true){// Do something if callback returns true}}letbool=false;// malfoo(()=>bool=true);// bienfoo(()=>{bool=true;});

• En caso que la expresión se expanda en varias líneas, envuélvela en paréntesis para una mejor legibilidad.

  ¿Por qué? Se observa claramente dónde empieza y termina la función.

  // mal['get','post','put'].map(httpMethod=>Object.prototype.hasOwnProperty.call(httpMagicObjectWithAVeryLongName,httpMethod,));// bien['get','post','put'].map(httpMethod=>(Object.prototype.hasOwnProperty.call(httpMagicObjectWithAVeryLongName,httpMethod,)));

• Si tu función tiene un solo argumento y no usa llaves, omite los paréntesis. De otra forma, siempre incluye paréntesis alrededor de los argumentos por claridad y consistencia. Nota: es también aceptable siempre usar paréntesis, en cuyo caso usa la opción de "always" para eslint o no incluyas disallowParenthesesAroundArrowParam para jscs.

  ¿Por qué? Menos basura visual.

  // mal[1,2,3].map((x)=>x*x);// bien[1,2,3].map(x=>x*x);// bien[1,2,3].map(number=>(`A long string with the ${number}. It’s so long that we don’t want it to take up space on the .map line!`));// mal[1,2,3].map(x=>{consty=x+1;returnx*y;});// bien[1,2,3].map((x)=>{consty=x+1;returnx*y;});

• Evita confundir la sintaxis de función de flecha (=>) con los operadores de comparación (<=, >=).

  // malconstitemHeight=item=>item.height>256 ? item.largeSize : item.smallSize;// malconstitemHeight=(item)=>item.height>256 ? item.largeSize : item.smallSize;// bienconstitemHeight=item=>(item.height>256 ? item.largeSize : item.smallSize);// bienconstitemHeight=(item)=>{const{ height, largeSize, smallSize }=item;returnheight>256 ? largeSize : smallSize;};

⬆ regresar a la Tabla de Contenido

Clases y Constructores

• Siempre usa class. Evita manipular prototype directamente.

  ¿Por qué? La sintaxis class es más concisa y fácil con la cual lidiar.

  // malfunctionQueue(contents=[]){this._queue=[...contents];}Queue.prototype.pop=function(){constvalue=this._queue[0];this._queue.splice(0,1);returnvalue;}// bienclassQueue{constructor(contents=[]){this._queue=[...contents];}pop(){constvalue=this._queue[0];this._queue.splice(0,1);returnvalue;}}

• Métodos pueden retornar this para ayudar con el encadenamiento de métodos (chaining).

  // malJedi.prototype.jump=function(){this.jumping=true;returntrue;};Jedi.prototype.setHeight=function(height){this.height=height;};constluke=newJedi();luke.jump();// => trueluke.setHeight(20);// => undefined// bienclassJedi{jump(){this.jumping=true;returnthis;}setHeight(height){this.height=height;returnthis;}}constluke=newJedi();luke.jump().setHeight(20);

• Está bien escribir un método toString() personalizado, solo asegúrate que funcione correctamente y no cause efectos colaterales.

  classJedi{constructor(options={}){this.name=options.name||'no name';}getName(){returnthis.name;}toString(){return`Jedi - ${this.getName()}`;}}

[⬆ regresar a la Tabla de Contenido]

Módulos

• Siempre usa módulos (import/export) antes que un sistema de módulos no estándar. Siempre puedes transpilar a tu sistema de módulos preferido.

  ¿Por qué? Los módulos son el futuro, comencemos a usar el futuro en el presente.

  // malconstAirbnbStyleGuide=require('./AirbnbStyleGuide');module.exports=AirbnbStyleGuide.es6;// okimportAirbnbStyleGuidefrom'./AirbnbStyleGuide';exportdefaultAirbnbStyleGuide.es6;// mejorimport{es6}from'./AirbnbStyleGuide';exportdefaultes6;

• No uses imports con comodines (asterisco).

  ¿Por qué? Esto te asegura de tener una única exportación por defecto.

  // malimport*asAirbnbStyleGuidefrom'./AirbnbStyleGuide';// bienimportAirbnbStyleGuidefrom'./AirbnbStyleGuide';

• Y no exportes directamente lo que traigas de un import.

  ¿Por qué? A pesar que hacer las cosas en una línea es conciso, tener un modo claro de importar y un modo claro de exportar, hace las cosas consistentes.

  // mal// filename es6.jsexport{es6asdefault}from'./AirbnbStyleGuide';// bien// filename es6.jsimport{es6}from'./AirbnbStyleGuide';exportdefaultes6;

• Solo importa de una ruta en un mismo lugar.

  ¿Por qué? Tener varias líneas que importan de una misma ruta hace al código difícil de mantener.

  // malimportfoofrom'foo';// … some other imports … //import{named1,named2}from'foo';// bienimportfoo,{named1,named2}from'foo';// bienimportfoo,{named1,named2,}from'foo';

• No exportes las asociaciones (bindings) mutables.

  ¿Por qué? La mutación debe ser evitada en general, pero en particular cuando se exportan asociaciones (bindings) mutables. Mientras esta técnica puede ser necesaria para algunos casos especiales, en general solo referencias constantes deben ser exportadas.

  // malletfoo=3;export{foo};// bienconstfoo=3;export{foo};

• En módulos con una única exportación, prefiere la exportación por defecto sobre la exportación nombrada.

  ¿Por qué? Para forzar a que más archivos solo exporten una sola cosa, lo que es mejor para la legibilidad y mantenibilidad.

  // malexportfunctionfoo(){}// bienexportdefaultfunctionfoo(){}

• Pon todos los imports encima de las sentencias de no importación.

  ¿Por qué? Desde que los imports son elevados (hoisted), mantenerlos en el inicio previene comportamientos sorpresivos.

  // malimportfoofrom'foo';foo.init();importbarfrom'bar';// bienimportfoofrom'foo';importbarfrom'bar';foo.init();

• Imports de multi-línea deben ser indentados como los arreglos multi-línea y literales de objeto.

  ¿Por qué? Las llaves deben seguir las mismas reglas de indentación como en otros bloques de llaves en la guía de estilos, así como las comas finales.

  // malimport{longNameA,longNameB,longNameC,longNameD,longNameE}from'path';// bienimport{longNameA,longNameB,longNameC,longNameD,longNameE,}from'path';

• No permitas la sintaxis de carga de Webpack en las sentencias de importación de módulos.

  ¿Por qué? Debido a que usar la sintaxis de Webpack en los imports acopla el código a un ensamblador de módulos. Prefiere usar aquella sintaxis de carga en el archivo de webpack.config.js.

  // malimportfooSassfrom'css!sass!foo.scss';importbarCssfrom'style!css!bar.css';// bienimportfooSassfrom'foo.scss';importbarCssfrom'bar.css';

[⬆ regresar a la Tabla de Contenido]

Propiedades

• Usa la notación de punto . cuando accedas a las propiedades.

  constluke={jedi: true,age: 28};// malconstisJedi=luke['jedi'];// bienconstisJedi=luke.jedi;

• Usa la notación subscript [] cuando accedas a las propiedades con una variable.

  constluke={jedi: true,age: 28};functiongetProp(prop){returnluke[prop];}constisJedi=getProp('jedi');

[⬆ regresar a la Tabla de Contenido]

Variables

• Siempre usa const para declarar constantes o let para declarar variables. No hacerlo resultará en variables globales. Debemos evitar contaminar el espacio global (global namespace). El Capitán Planeta nos advirtió de eso.

  // malsuperPower=newSuperPower();// bienconstsuperPower=newSuperPower();o// bienletaPower;aPower=newSuperPower();// esto puede cambiar a otro poder posteriormente

• Usa una declaración const o let por variable.

  ¿Por qué? Es más fácil agregar nuevas declaraciones de variables de este modo, y no tendrás que preocuparte por reemplazar ; por , o introducir diffs de sólo puntuación .

  // malconstitems=getItems(),goSportsTeam=true,dragonball='z';// mal// (compara con lo de arriba y encuentra el error)constitems=getItems(),goSportsTeam=true;dragonball='z';// bienconstitems=getItems();constgoSportsTeam=true;constdragonball='z';

• Agrupa tus consts y luego agrupa tus lets.

  ¿Por qué? Esto es útil cuando necesites asignar una variable luego dependiendo de una de las variables asignadas previamente.

// malleti,len,dragonball,items=getItems(),goSportsTeam=true;// malleti;constitems=getItems();letdragonball;constgoSportsTeam=true;letlen;// bienconstgoSportsTeam=true;constitems=getItems();letdragonball;leti;letlength;

• Asigna las variables cuando las necesites, pero ponlas en un lugar razonable.

  ¿Por qué? let y const están a nivel de bloque, no a nivel de función.

// mal - llamada a funcion innecesariafunctioncheckName(hasName){constname=getName();if(hasName==='test'){returnfalse;}if(name==='test'){this.setName('');returnfalse;}returnname;}// bienfunctioncheckName(hasName){if(hasName==='test'){returnfalse;}constname=getName();if(name==='test'){this.setName('');returnfalse;}returnname;}

[⬆ regresar a la Tabla de Contenido]

Hoisting

• Las declaraciones de variables son movidas a la parte superior de su ámbito, sin embargo su asignación no.

  // sabemos que esto no funcionara (asumiendo// que no hay una variable global notDefined)functionexample(){console.log(notDefined);// => lanza un ReferenceError}// crear una declaracion de variable luego// que referencies a la variable funcionara// por el hoisting. Nota: A la asignacion// del valor `true` no se le aplico hoisting.functionexample(){console.log(declaredButNotAssigned);// => undefinedvardeclaredButNotAssigned=true;}// El interprete lleva la declaracion de la// variable a la parte superior de la funcion.// Eso significa que nuestro ejemplo// podria ser reescrito como:functionexample(){vardeclaredButNotAssigned;console.log(declaredButNotAssigned);// => undefineddeclaredButNotAssigned=true;}

• Expresiones de función anónimas hacen hoisting de su nombre de variable, pero no de la asignación de la función.

  functionexample(){console.log(anonymous);// => undefinedanonymous();// => TypeError anonymous is not a functionvaranonymous=function(){console.log('anonymous function expression');};}

• Expresiones de función nombradas hacen hoisting de su nombre de variable, pero no del nombre de la función ni del contenido de la función.

  functionexample(){console.log(named);// => undefinednamed();// => TypeError named is not a functionsuperPower();// => ReferenceError superPower is not definedvarnamed=functionsuperPower(){console.log('Flying');};}// lo mismo es cierto cuando el nombre// de la funcion es igual al nombre de// la variable.functionexample(){console.log(named);// => undefinednamed();// => TypeError named is not a functionvarnamed=functionnamed(){console.log('named');}}

• Las declaraciones de función hacen hoist de su nombre y del contenido de la función.

  functionexample(){superPower();// => FlyingfunctionsuperPower(){console.log('Flying');}}

• Para más información lee JavaScript Scoping & Hoisting por Ben Cherry

[⬆ regresar a la Tabla de Contenido]

Expresiones de comparación e igualdad

• Usa === y !== en vez de == y != respectivamente.

• Las expresiones condicionales son evaluadas usando coerción con el método ToBoolean y siempre obedecen a estas reglas sencillas:

  • Objects son evaluados como true (se considera así al objeto vacío {} y arreglos sin contenido [])
  • Undefined es evaluado como false
  • Null es evaluado como false
  • Booleans son evaluados como el valor del booleano
  • Numbers son evaluados como false si su valor es +0, -0, o NaN, de otro modo true
  • Strings son evaluados como false si es una cadena de texto vacía '', de otro modo son true

  if([0]&&[]){// true// un arreglo es un objeto (incluso uno vacío), los objetos son evaluados como true}

• Usa atajos.

  // malif(name!==''){// ...cosas...}// bienif(name){// ...cosas...}// malif(collection.length>0){// ...cosas...}// bienif(collection.length){// ...cosas...}

• Para más información revisa Truth Equality and JavaScript por Angus Croll

• Usa llaves para crear bloques en cláusulas case y default que contengan declaraciones léxicas (e.g. let, const, function y class).

  ¿Por qué? La declaración léxica es visible en todo el bloque switch pero solo se inicializa al ser asignado, lo que solo ocurre cuando el bloque case donde es declarado es alcanzado. Esto causa problemas cuando múltiples bloques case intentan definir la misma variable.

  // malswitch(foo){case1:
  letx=1;break;case2:
  consty=2;break;case3:
  functionf(){}break;default:
  classC{}}// bienswitch(foo){case1: {letx=1;break;}case2: {consty=2;break;}case3: {functionf(){}break;}case4:
  bar();break;default: {classC{}}}

[⬆ regresar a la Tabla de Contenido]

Bloques

• Usa llaves con todos los bloques de múltiples líneas.

  // malif(test)returnfalse;// bienif(test)returnfalse;// bienif(test){returnfalse;}// malfunction(){returnfalse;}// bienfunction(){returnfalse;}

• Si estás usando bloques de muchas líneas con if y else, pon el else en la misma línea que el if.

  // malif(test){thing1();thing2();}else{thing3();}// bienif(test){thing1();thing2();}else{thing3();}

[⬆ regresar a la Tabla de Contenido]

Comentarios

• Usa /** ... */ para comentarios de múltiples líneas. Incluye una descripción, especificación de tipos y valores para todos los parámetros y valores de retorno.

  // mal// make() returns a new element// based on the passed in tag name//// @param {String} tag// @return {Element} elementfunctionmake(tag){// ...stuff...returnelement;}// bien/** * make() returns a new element * based on the passed in tag name * * @param {String} tag * @return {Element} element */functionmake(tag){// ...stuff...returnelement;}

• Usa // para comentarios de una sola línea. Ubica los comentarios de una sola línea encima de la sentencia comentada. Deja una línea en blanco antes del comentario, a menos que sea la primera línea de un bloque.

  // malconstactive=true;// is current tab// bien// is current tabconstactive=true;// malfunctiongetType(){console.log('fetching type...');// set the default type to 'no type'consttype=this._type||'no type';returntype;}// bienfunctiongetType(){console.log('fetching type...');// set the default type to 'no type'consttype=this._type||'no type';returntype;}

• Agregando a tus comentarios los prefijos FIXME o TODO, ayudará a otros desarrolladores a entender rápidamente si estás apuntando a un problema que precisa ser revisado o si estás sugiriendo una solución al problema que debería ser implementado. Estos son diferentes a comentarios regulares en el sentido que requieren alguna acción. Las acciones son FIXME -- necesito resolver esto o TODO -- necesita implementarse.

• Usa // FIXME: para anotar problemas.

  classCalculatorextendsAbacus{constructor(){super();// FIXME: shouldn't use a global heretotal=0;}}

• Usa // TODO: para anotar soluciones a los problemas.

  classCalculatorextendsAbacus{constructor(){super();// TODO: total should be configurable by an options paramthis.total=0;}}

[⬆ regresar a la Tabla de Contenido]

Espacios en blanco

• Usa indentaciones blandas (sin TAB) establecidas en dos espacios.

  // malfunctionfoo(){∙∙∙∙constname;}// malfunctionbar(){∙constname;}// bienfunctionbaz(){∙∙constname;}

• Deja un espacio antes de la llave de apertura.

  // malfunctiontest(){console.log('test');}// bienfunctiontest(){console.log('test');}// maldog.set('attr',{age: '1 year',breed: 'Bernese Mountain Dog'});// biendog.set('attr',{age: '1 year',breed: 'Bernese Mountain Dog'});

• Deja un espacio antes del paréntesis de apertura en las sentencias de control (if, while, etc.). No dejes espacios antes de la lista de argumentos en las invocaciones y declaraciones de funciones.

  // malif(isJedi){fight();}// bienif(isJedi){fight();}// malfunctionfight(){console.log('Swooosh!');}// bienfunctionfight(){console.log('Swooosh!');}

• Separa a los operadores con espacios.

  // malconstx=y+5;// bienconstx=y+5;

• Deja una línea en blanco al final del archivo.

  // mal(function(global){// ...algo...})(this);

  // mal(function(global){// ...algo...})(this);↵↵

  // bien(function(global){// ...algo...})(this);↵

• Usa indentación cuando uses métodos largos con 'chaining' (más de dos métodos encadenados). Emplea un punto adelante en cada nueva línea, lo que enfatiza que es un método llamado no una nueva sentencia.

  // mal$('#items').find('.selected').highlight().end().find('.open').updateCount();// mal$('#items').find('.selected').highlight().end().find('.open').updateCount();// bien$('#items').find('.selected').highlight().end().find('.open').updateCount();// malconstleds=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);// bienconstleds=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);

• Deja una línea en blanco luego de los bloques y antes de la siguiente sentencia.

  // malif(foo){returnbar;}returnbaz;// bienif(foo){returnbar;}returnbaz;// malconstobj={foo(){},bar(){}};returnobj;// bienconstobj={foo(){},bar(){}};returnobj;// malconstarr=[functionfoo(){},functionbar(){},];returnarr;// bienconstarr=[functionfoo(){},functionbar(){},];returnarr;

[⬆ regresar a la Tabla de Contenido]

Comas

• Comas al inicio de línea: Nop.

  // malconststory=[once,upon,aTime];// bienconststory=[once,upon,aTime,];// malconsthero={firstName: 'Ada',lastName: 'Lovelace',birthYear: 1815,superPower: 'strength'};// bienconsthero={firstName: 'Ada',lastName: 'Lovelace',birthYear: 1815,superPower: 'computers',};

• Coma adicional al final: Sip.

¿Por qué? Esto lleva a diferenciales en git más claros. Además los transpiladores como Babel removerán la coma del final en el código transpilado lo que significa que no te tendrás que preocupar del problema de la coma adicional al final en navegadores antiguos.

// mal - git diff sin coma adicional al finalconsthero={firstName: 'Florence',-lastName: 'Nightingale'+lastName: 'Nightingale',+inventorOf: ['coxcomb chart','modern nursing']};// bien - git diff con coma adicional al finalconsthero={firstName: 'Florence',lastName: 'Nightingale',+inventorOf: ['coxcomb chart','modern nursing'],};// malconsthero={firstName: 'Dana',lastName: 'Scully'};constheroes=['Batman','Superman'];// bienconsthero={firstName: 'Dana',lastName: 'Scully',};constheroes=['Batman','Superman',];

[⬆ regresar a la Tabla de Contenido]

Puntos y Comas

• Sip.

  // mal(function(){constname='Skywalker'returnname})()// bien(()=>{constname='Skywalker';returnname;}());// bien, pero arcaico (evita que la funcion se vuelva un argumento// cuando dos archivos con IIFEs sean concatenados);(()=>{constname='Skywalker';returnname;}());

[⬆ regresar a la Tabla de Contenido]

Casting de Tipos y Coerción

• Ejecuta coerción al inicio de una sentencia.

• Strings:

  // => this.reviewScore = 9;// malconsttotalScore=this.reviewScore+'';// invoca a this.reviewScore.valueOf()// malconsttotalScore=this.reviewScore.toString();// no se garantiza que retorne una cadena de texto// bienconsttotalScore=String(this.reviewScore);

• Números: Usa Number para el casting de tipo y parseInt siempre con la base numérica para el casting de textos.

  constinputValue='4';// malconstval=newNumber(inputValue);// malconstval=+inputValue;// malconstval=inputValue>>0;// malconstval=parseInt(inputValue);// bienconstval=Number(inputValue);// bienconstval=parseInt(inputValue,10);

• Si por alguna razón estás haciendo algo salvaje y parseInt es un cuello de botella por lo que necesitaste usar Bitshift por razones de desempeño, deja un comentario explicando la razón y resumen de lo que estás haciendo.

  // bien/** * parseInt was the reason my code was slow. * Bitshifting the String to coerce it to a * Number made it a lot faster. */constval=inputValue>>0;

Nota: Ten mucho cuidado al hacer operaciones de Bitshift. En Javascript los números son representados como valores de 64-bit, sin embargo las operaciones de Bitshift siempre retornan un entero de 32-bits (fuente). Bitshift puede presentarnos un comportamiento inesperado para valores enteros mayores a 32 bits. Discusión. El mayor entero con signo de 32 bits es 2,147,483,647:

2147483647>>0//=> 21474836472147483648>>0//=> -21474836482147483649>>0//=> -2147483647

• Booleans:

  constage=0;// malconsthasAge=newBoolean(age);// bienconsthasAge=Boolean(age);// bienconsthasAge=!!age;

[⬆ regresar a la Tabla de Contenido]

Convenciones de nomenclatura

• Evita nombres de una sola letra. Sé descriptivo con tus nombres.

  // malfunctionq(){// ...algo...}// bienfunctionquery(){// ...algo...}

• Usa camelCase cuando nombres tus objetos, funciones e instancias.

  // malconstOBJEcttsssss={};constthis_is_my_object={};consto={};functionc(){}// bienvarthisIsMyObject={};functionthisIsMyFunction(){}

• Usa PascalCase cuando nombres constructores o clases.

  // malfunctionuser(options){this.name=options.name;}constbad=newuser({name: 'nope'});// bienclassUser{constructor(options){this.name=options.name;}}constgood=newUser({name: 'yup',});

• No uses prefijos ni sufijos de guiones bajo.

¿Por qué? JavaScript no tiene el concepto de privacidad en términos de propiedades o métodos. A pesar que un guión bajo como prefijo es una convención común para indicar que son "privados", la realidad es que estas propiedades son absolutamente públicas, y por ello, parte de tu contrato público de API. La convención del prefijo de guión bajo podría orientar a los desarrolladores a pensar erróneamente que un cambio a aquellos no será de impacto o que los tests no son necesarios.

// malthis.__firstName__='Panda';this.firstName_='Panda';this._firstName='Panda';// bienthis.firstName='Panda';

• Nunca guardes referencias a this. Usa funciones arrow o la función #bind

  // malfunction(){constself=this;returnfunction(){console.log(self);};}// malfunction(){constthat=this;returnfunction(){console.log(that);};}// bienfunctionfoo(){return()=>{console.log(this);};}

• El nombre del archivo base debe corresponder exactamente con el nombre de su export por defecto.

// contenido archivo 1classCheckBox{// ...}exportdefaultCheckBox;// contenido archivo 2exportdefaultfunctionfortyTwo(){return42;}// contenido archivo 3exportdefaultfunctioninsideDirectory(){}// en algún otro archivo// malimportCheckBoxfrom'./checkBox';// importacion/exportacion PascalCase, nombre de archivo camelCaseimportFortyTwofrom'./FortyTwo';// importacion/nombre de archivo PascalCase, exportacion camelCaseimportInsideDirectoryfrom'./InsideDirectory';// importacion/nombre de archivo PascalCase, exportacion camelCase// malimportCheckBoxfrom'./check_box';// importacion/exportacion PascalCase, nombre de archivo snake_caseimportforty_twofrom'./forty_two';// importacion/nombre de archivo snake_case, exportacion camelCaseimportinside_directoryfrom'./inside_directory';// importacion snake_case, exportacion camelCaseimportindexfrom'./inside_directory/index';// requiere el archivo de index explicitamenteimportinsideDirectoryfrom'./insideDirectory/index';// requiere el archivo de index explicitamente// bienimportCheckBoxfrom'./CheckBox';// importacion/exportacion/nombre de archivo PascalCaseimportfortyTwofrom'./fortyTwo';// importacion/exportacion/nombre de archivo camelCaseimportinsideDirectoryfrom'./insideDirectory';// importacion/exportacion/nombre directorio/archivo "index" implícito// ^ soporta tanto insideDirectory.js e insideDirectory/index.js

• Usa camelCase cuando exportes por defecto una función. Tu nombre de archivo debe ser idéntico al nombre de tu función.

functionmakeStyleGuide(){}exportdefaultmakeStyleGuide;

• Usa camelCase cuando exportes un objeto constructor / clase / singleton / librería de función / esqueleto.

constAirbnbStyleGuide={es6: {}};exportdefaultAirbnbStyleGuide;

[⬆ regresar a la Tabla de Contenido]

Funciones de Acceso

• Funciones de acceso para las propiedades no son requeridas.

• No uses getters/setters de JavaScript ya que causan efectos colaterales no esperados y son difíciles de probar, mantener y razonar. En vez de ello, si creas funciones de acceso usa getVal() y setVal('hello').

  // Maintainable-JavaScript-Nicholas-C-ZakasclassDragon{getage(){// ...}setage(value){// ...}}// bienclassDragon{getAge(){// ...}setAge(value){// ...}}

• Si la propiedad es un booleano, usa isVal() o hasVal().

  // malif(!dragon.age()){returnfalse;}// bienif(!dragon.hasAge()){returnfalse;}

• Está bien crear funciones get() y set(), pero sé consistente.

  classJedi{constructor(options={}){constlightsaber=options.lightsaber||'blue';this.set('lightsaber',lightsaber);}set(key,val){this[key]=val;}get(key){returnthis[key];}}

[⬆ regresar a la Tabla de Contenido]

Eventos

• Cuando envíes paquetes de datos a los eventos (ya sea con eventos del DOM o algo propietario como los eventos de Backbone), pasa un mapa en vez de un valor directo. Esto permitirá a un próximo colaborador a agregar más datos al paquete de datos sin que tenga que encontrar o actualizar un handler para cada evento. Por ejemplo, en vez de:

  // mal$(this).trigger('listingUpdated',listing.id);
  ...
  $(this).on('listingUpdated',(e,listingId)=>{// hacer algo con listingId});

  prefiere:

  // bien$(this).trigger('listingUpdated',{listingId : listing.id});
  ...
  $(this).on('listingUpdated',(e,data)=>{// hacer algo con data.listingId});

[⬆ regresar a la Tabla de Contenido]

jQuery

• Nombre las variables de objetos jQuery con un prefijo $.

  // malconstsidebar=$('.sidebar');// bienconst$sidebar=$('.sidebar');

• Guarde en variables los lookups de jQuery que se necesiten posteriormente.

  // malfunctionsetSidebar(){$('.sidebar').hide();// ...algo...$('.sidebar').css({'background-color': 'pink'});}// bienfunctionsetSidebar(){const$sidebar=$('.sidebar');$sidebar.hide();// ...algo...$sidebar.css({'background-color': 'pink'});}

• Para consultas de elementos DOM usa el modo Cascada $('.sidebar ul') o parent > child $('.sidebar > ul'). jsPerf

• Usa find solo con consultas guardadas en variables previamente.

  // mal$('ul','.sidebar').hide();// mal$('.sidebar').find('ul').hide();// bien$('.sidebar ul').hide();// bien$('.sidebar > ul').hide();// bien$sidebar.find('ul');

[⬆ regresar a la Tabla de Contenido]

Compatibilidad con ECMAScript 5

• Revisa la tabla de compatibilidad de ES5 de Kangax.

[⬆ regresar a la Tabla de Contenido]

Estilos de EcmaScript6+ (ES 2015+)

- A continuación, un conjunto de enlaces hacia los estilos para las nuevas características de ES6:

1. Notación Funciones de Flecha
2. Clases
3. Declaración abreviada para objeto
4. Declaración de objeto concisa
5. Propiedades computadas de objeto
6. Plantillas de texto
7. Destructuring
8. Parámetros por defecto
9. Rest
10. Spreads de arreglos
11. Let y Const
12. Iteradores y Generadores
13. Módulos

- No uses [las propuestas de TC39](https://github.com/tc39/proposals) puesto que aún no han llegado a la tercera etapa.
> ¿Por qué? [No están finalizadas](https://tc39.github.io/process-document/), y están sujetas a cambios o reescritas completamente. Vamos a usar JavaScript y las propuestas aún no son JavaScript.

[⬆ regresar a la Tabla de Contenido]

Pruebas

• Sip.

  functionfoo(){returntrue;}

• No, but seriously:

• Cualquiera que sea el framework de testing que emplees, ¡deberías escribir tests!

• Esfuérzate por escribir funciones pequeñas y puras, además de minimizar las posibles mutaciones que pudiesen ocurrir.

• Sé cuidados con los stubs y los mocks - pueden hacer tus tests más frágiles.

• Usamos principalmente mocha en Airbnb. tape es también usado ocasionalmente para módulos pequeños y separados.

• 100% de cobertura de pruebas es una buena meta a perseguir, a pesar que no es siempre práctico conseguirlo.

• Cuando corrijas una incidencia (bug), escribe una prueba de regresión. Una incidencia sin una prueba de regresión es casi seguro que volverá a ocurrir en el futuro.

[⬆ regresar a la Tabla de Contenido]

Desempeño

• On Layout & Web Performance
• String vs Array Concat
• Try/Catch Cost In a Loop
• Bang Function
• jQuery Find vs Context, Selector
• innerHTML vs textContent for script text
• Long String Concatenation
• Are Javascript functions like map(), reduce(), and filter() optimized for traversing arrays?
• Loading...

[⬆ regresar a la Tabla de Contenido]

Recursos

Learning ES6

• Draft ECMA 2015 (ES6) Spec
• ExploringJS
• Tabla de compatibilidad de ES6
• Vistazo comprensivo de las nuevas características de ES6

Lee esto

• Standard ECMA-262

Tools

Code Style Linters

• JSHint - Airbnb Style .jshintrc
• JSCS - Airbnb Style Preset

Otras guías de estilo

• Google JavaScript Style Guide (Guía de Estilo de Javascript de Google)
• jQuery Core Style Guidelines (Lineamientos de Estilo con el núcleo de jQuery)
• Principles of Writing Consistent, Idiomatic JavaScript (Idiomatic Javascript: Principios de Escritura Consistente)

Otros estilos

• Naming this in nested functions - Christian Johansen (Nomenclatura en funciones anidadas)
• Conditional Callbacks (Callbacks condicionales)
• Popular JavaScript Coding Conventions on Github (Convenciones Populares de Programación con Javascript en Github)
• Multiple var statements in JavaScript, not superfluous - Ben Alman (Múltiples sentencias var en JavaScript, no superfluas)

Lecturas más profundas

• Understanding JavaScript Closures - Angus Croll (Entendiendo los Closures de JavaScript)
• Basic JavaScript for the impatient programmer - Dr. Axel Rauschmayer (JavaScript Básico para el programador impaciente)
• You Might Not Need jQuery - Zack Bloom & Adam Schwartz (Podrías no necesitar jQuery)
• ES6 Features - Luke Hoban (Características de ES6)
• Frontend Guidelines - Benjamin De Cock (Lineamientos para el Frontend)

Libros

• JavaScript: The Good Parts - Douglas Crockford (JavaScript: Las Buenas Partes)
• JavaScript Patterns - Stoyan Stefanov (Patrones JavaScript)
• Pro JavaScript Design Patterns - Ross Harmes and Dustin Diaz (Patrones de Diseño Avanzados en Javascript)
• High Performance Web Sites: Essential Knowledge for Front-End Engineers - Steve Souders (Sitios Web de Alto Desempeño: Conocimiento Esencial para los Ingenieros de Capa de Presentación)
• Maintainable JavaScript - Nicholas C. Zakas (JavaScript Mantenible)
• JavaScript Web Applications - Alex MacCaw (Aplicaciones Web JavaScript)
• Pro JavaScript Techniques - John Resig (Técnicas Avanzadas JavaScript)
• Smashing Node.js: JavaScript Everywhere - Guillermo Rauch (Increíble Node.js: JavaScript en todas partes)
• Secrets of the JavaScript Ninja - John Resig and Bear Bibeault (Secretos del JavaScript Ninja)
• Human JavaScript - Henrik Joreteg (JavaScript Humano)
• Superhero.js - Kim Joar Bekkelund, Mads Mobæk, & Olav Bjorkoy (Superhéroe.js)
• JSBooks - Julien Bouquillon
• Third Party JavaScript - Ben Vinegar and Anton Kovalyov (JavaScript de Terceros)
• Effective JavaScript: 68 Specific Ways to Harness the Power of JavaScript - David Herman (JavaScript Efectivo: 68 modos específicos para elevar el poder de JavaScript)
• Eloquent JavaScript - Marijn Haverbeke (JavaScript Elocuente)
• You Don't Know JS: ES6 & Beyond - Kyle Simpson (No sabes JS: ES6 y más allá)

Blogs

• DailyJS
• JavaScript Weekly
• JavaScript, JavaScript...
• Bocoup Weblog
• Adequately Good
• NCZOnline
• Perfection Kills
• Ben Alman
• Dmitry Baranovskiy
• Dustin Diaz
• nettuts

Podcasts

• JavaScript Air
• JavaScript Jabber

[⬆ regresar a la Tabla de Contenido]

En la cancha

Esta es una lista de las organizaciones que están usando esta guía de estilo. Envíanos un pull request o abre un issue y te agregaremos a la lista.

• Airbnb: airbnb/javascript
• Aan Zee: AanZee/javascript
• American Insitutes for Research: AIRAST/javascript
• Compass Learning: compasslearning/javascript-style-guide
• DailyMotion: dailymotion/javascript
• Evernote: evernote/javascript-style-guide
• ExactTarget: ExactTarget/javascript
• Gawker Media: gawkermedia/javascript
• GeneralElectric: GeneralElectric/javascript
• GoodData: gooddata/gdc-js-style
• Grooveshark: grooveshark/javascript
• How About We: howaboutwe/javascript
• Mighty Spring: mightyspring/javascript
• MinnPost: MinnPost/javascript
• ModCloth: modcloth/javascript
• National Geographic: natgeo/javascript
• National Park Service: nationalparkservice/javascript
• reddit: reddit/styleguide/javascript
• REI: reidev/js-style-guide
• Razorfish: razorfish/javascript-style-guide
• Shutterfly: shutterfly/javascript
• Userify: userify/javascript
• Zillow: zillow/javascript
• ZocDoc: ZocDoc/javascript

Traducciones

Esta guía de estilo es también disponible en otros lenguajes:

• Inglés (original): airbnb/javascript
• Portugués Brasileño: armoucar/javascript-style-guide
• Búlgaro: borislavvv/javascript
• Catalán: fpmweb/javascript-style-guide
• Chino (Tradicional): jigsawye/javascript
• Chino (Simplificado): sivan/javascript-style-guide
• Francés: nmussy/javascript-style-guide
• Alemán: timofurrer/javascript-style-guide
• Italiano: sinkswim/javascript-style-guide
• Japonés: mitsuruog/javacript-style-guide
• Coreano: tipjs/javascript-style-guide
• Polaco: mjurczyk/javascript
• Ruso: uprock/javascript
• Tailandés: lvarayut/javascript-style-guide
• Vietnamita: giangpii/javascript-style-guide

La guía de la Guía de Estilos de Javascript

• Referencia

Charla con nosotros sobre Javascript

• Encuéntranos en gitter.

Colaboradores

• Vea a los colaboradores

Licencia

(The MIT License)

Copyright (c) 2014-2016 Airbnb

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[⬆ regresar a la Tabla de Contenido]

Enmiendas

Te recomendamos hacer fork de esta guía y cambiar las reglas para que se adecúen a la guía de estilos de tu equipo. Abajo podrás encontrar algunas enmiendas a la guía de estilos. Esto te permitirá actualizar periódicamente tu guía de estilos sin tener que lidiar con conflictos al hacer merge.

};