常に気をつけたい、JavaScriptへの正しい接し方
Switch branches/tags
Nothing to show
Clone or download
mitsuruog Merge pull request #20 from u4da3/patch-1
modify some indent spacing
Latest commit a78c11c Jun 15, 2018
Permalink
Failed to load latest commit information.
css-in-javascript Tweak style Mar 10, 2018
es5 modify some indent spacing Jun 13, 2018
origin @ c81eac1 Update submodule Aug 8, 2014
react Tweak style Mar 10, 2018
.gitignore Update react style Mar 5, 2018
.gitmodules add submodule Jan 31, 2013
README.md Fix README code highlight Mar 9, 2018

README.md

元文書:https://github.com/airbnb/javascript

Airbnb JavaScript スタイルガイド() {

常に気をつけたい、JavaScriptへの正しい接し方

他のスタイルガイドたち

目次

  1. 型(Types)
  2. 参照(References)
  3. オブジェクト(Objects)
  4. 配列(Arrays)
  5. 構造化代入(Destructuring)
  6. 文字列(Strings)
  7. 関数(Functions)
  8. アロー関数(Arrow Functions)
  9. コンストラクタ(Constructors)
  10. モジュール(Modules)
  11. イテレータとジェネレータ(Iterators and Generators)
  12. プロパティ(Properties)
  13. 変数(Variables)
  14. 巻き上げ(Hoisting)
  15. 条件式と等価式(Comparison Operators & Equality)
  16. ブロック(Blocks)
  17. コメント(Comments)
  18. 空白(Whitespace)
  19. カンマ(Commas)
  20. セミコロン(Semicolons)
  21. 型変換と強制(Type Casting & Coercion)
  22. 命名規則(Naming Conventions)
  23. アクセッサ(Accessors)
  24. イベント(Events)
  25. jQuery(jQuery)
  26. ECMAScript 5 互換性(ECMAScript 5 Compatibility)
  27. ECMAScript 6 スタイル(ECMAScript 6 Styles)
  28. テスト(Testing)
  29. パフォーマンス(Performance)
  30. 参考文献(Resources)
  31. 共鳴者(In the Wild)
  32. 翻訳(Translation)
  33. JavaScriptスタイルガイドへの手引き(The JavaScript Style Guide Guide)
  34. Javascriptスタイルガイドについてのchat(Chat With Us About JavaScript)
  35. 貢献者(Contributors)
  36. ライセンス(License)

型(Types)

  • 1.1 Primitives: When you access a primitive type you work directly on its value.

  • 1.1 プリミティブ型: プリミティブ型は、その値を直接操作します。

    • string
    • number
    • boolean
    • null
    • undefined
    const foo = 1;
    let bar = foo;
    
    bar = 9;
    
    console.log(foo, bar); // => 1, 9
  • 1.2 Complex: When you access a complex type you work on a reference to its value.

  • 1.2 参照型: 参照型は、参照を通して値を操作します。

    • object
    • array
    • function
    const foo = [1, 2];
    const bar = foo;
    
    bar[0] = 9;
    
    console.log(foo[0], bar[0]); // => 9, 9

⬆ ページのTopへ戻る

参照(References)

  • 2.1 Use const for all of your references; avoid using var.
  • 2.1 すべての参照は const を使用し、var を使用しないでください。

Why? This ensures that you can't reassign your references, which can lead to bugs and difficult to comprehend code.

なぜ? 参照を再割り当でできないことで、バグに繋がりやすく理解しがたいコードになることを防ぎます。

// bad
var a = 1;
var b = 2;

// good
const a = 1;
const b = 2;
  • 2.2 If you must reassign references, use let instead of var.
  • 2.2 参照を再割当てする場合は var の代わりに let を利用してください。

Why? let is block-scoped rather than function-scoped like var.

なぜ? 関数スコープの var よりむしろ、ブロックスコープの let

// bad
var count = 1;
if (true) {
  count += 1;
}

// good, use the let.
let count = 1;
if (true) {
  count += 1;
}
  • 2.3 Note that both let and const are block-scoped.

  • 2.3 letconst は共にブロックスコープであることに注意すること。

    // const and let only exist in the blocks they are defined in.
    // const と let はそれらが宣言されたブロックの中でのみ存在します。
    {
      let a = 1;
      const b = 1;
    }
    console.log(a); // ReferenceError
    console.log(b); // ReferenceError

⬆ ページのTopへ戻る

オブジェクト(Objects)

  • 3.1 Use the literal syntax for object creation.

  • 3.1 オブジェクトを作成する際は、リテラル構文を使用してください。

    // bad
    const item = new Object();
    
    // good
    const item = {};
  • 3.2 If your code will be executed in browsers in script context, don't use reserved words as keys. It won't work in IE8. More info. It’s OK to use them in ES6 modules and server-side code.

  • 3.2 コードが、ブラウザ上のスクリプトとして実行される場合、予約語をキーとして利用しないでください。これはIE8では動作しません。More info しかし、ES6モジュール内やサーバサイドでは利用可能です。

    // bad
    const superman = {
      default: { clark: 'kent' },
      private: true,
    };
    
    // good
    const superman = {
      defaults: { clark: 'kent' },
      hidden: true,
    };
  • 3.3 Use readable synonyms in place of reserved words.

  • 3.3 予約語の代わりに分かりやすい同義語を使用してください。

    // bad
    const superman = {
      class: 'alien',
    };
    
    // bad
    const superman = {
      klass: 'alien',
    };
    
    // good
    const superman = {
      type: 'alien',
    };

  • 3.4 Use computed property names when creating objects with dynamic property names.
  • 3.4 動的にプロパティ名を持つオブジェクトを作成する場合、計算されたプロパティ名(computed property names)を利用してください。

Why? They allow you to define all the properties of an object in one place.

なぜ? こうすることで、オブジェクトのプロパティを1箇所で定義することができます。

function getKey(k) {
  return a `key named ${k}`;
}

// bad
const obj = {
  id: 5,
  name: 'San Francisco',
};
obj[getKey('enabled')] = true;

// good
const obj = {
  id: 5,
  name: 'San Francisco',
  [getKey('enabled')]: true
};

  • 3.5 Use object method shorthand.

  • 3.5 メソッドの短縮構文を利用してください。

    // bad
    const atom = {
      value: 1,
    
      addValue: function (value) {
        return atom.value + value;
      },
    };
    
    // good
    const atom = {
      value: 1,
    
      addValue(value) {
        return atom.value + value;
      },
    };

  • 3.6 Use property value shorthand.
  • 3.6 プロパティの短縮構文を利用してください。

Why? It is shorter to write and descriptive.

Why? 記述や説明が簡潔になるからです。

const lukeSkywalker = 'Luke Skywalker';

// bad
const obj = {
  lukeSkywalker: lukeSkywalker,
};

// good
const obj = {
  lukeSkywalker,
};
  • 3.7 Group your shorthand properties at the beginning of your object declaration.
  • 3.7 プロパティの短縮構文はオブジェクト宣言の先頭にまとめてください。

Why? It's easier to tell which properties are using the shorthand.

なぜ? どのプロパティが短縮構文を利用しているか分かりやすいからです。

const anakinSkywalker = 'Anakin Skywalker';
const lukeSkywalker = 'Luke Skywalker';

// bad
const obj = {
  episodeOne: 1,
  twoJediWalkIntoACantina: 2,
  lukeSkywalker,
  episodeThree: 3,
  mayTheFourth: 4,
  anakinSkywalker,
};

// good
const obj = {
  lukeSkywalker,
  anakinSkywalker,
  episodeOne: 1,
  twoJediWalkIntoACantina: 2,
  episodeThree: 3,
  mayTheFourth: 4,
};

⬆ ページのTopへ戻る

配列(Arrays)

  • 4.1 Use the literal syntax for array creation.

  • 4.1 配列を作成する際は、リテラル構文を使用してください。

    // bad
    const items = new Array();
    
    // good
    const items = [];
  • 4.2 Use Array#push instead of direct assignment to add items to an array.

  • 4.2 直接配列に項目を代入せず、Array#pushを利用してください。

    const someStack = [];
    
    // bad
    someStack[someStack.length] = 'abracadabra';
    
    // good
    someStack.push('abracadabra');

  • 4.3 Use array spreads ... to copy arrays.

  • 4.3 配列をコピーする場合は、配列の拡張演算子 ... を利用してください。

    // bad
    const len = items.length;
    const itemsCopy = [];
    let i;
    
    for (i = 0; i < len; i++) {
      itemsCopy[i] = items[i];
    }
    
    // good
    const itemsCopy = [...items];
  • 4.4 To convert an array-like object to an array, use Array#from.

  • 4.4 array-likeなオブジェクトを配列に変換する場合は、Array#fromを利用してください。

    const foo = document.querySelectorAll('.foo');
    const nodes = Array.from(foo);

⬆ ページのTopへ戻る

構造化代入(Destructuring)

  • 5.1 Use object destructuring when accessing and using multiple properties of an object.
  • 5.1 複数のプロパティからなるオブジェクトにアクセスする際は、オブジェクト構造化代入を利用してください。

Why? Destructuring saves you from creating temporary references for those properties.

なぜ? 構造化代入を利用することで、それらのプロパティのための中間的な参照を減らすことができます。

// bad
function getFullName(user) {
  const firstName = user.firstName;
  const lastName = user.lastName;

  return `${firstName} ${lastName}`;
}

// good
function getFullName(obj) {
  const { firstName, lastName } = obj;
  return `${firstName} ${lastName}`;
}

// best
function getFullName({ firstName, lastName }) {
  return `${firstName} ${lastName}`;
}
  • 5.2 Use array destructuring.

  • 5.2 配列の構造化代入を利用してください。

    const arr = [1, 2, 3, 4];
    
    // bad
    const first = arr[0];
    const second = arr[1];
    
    // good
    const [first, second] = arr;
  • 5.3 Use object destructuring for multiple return values, not array destructuring.

  • 5.3 複数の値を返却する場合は、配列の構造化代入ではなく、オブジェクトの構造化代入を利用してください。

Why? You can add new properties over time or change the order of things without breaking call sites.

なぜ? こうすることで、後で新しいプロパティを追加したり、呼び出し元に影響することなく順序を変更することができます。

// bad
function processInput(input) {
  // then a miracle occurs
  // その後、奇跡が起こります。
  return [left, right, top, bottom];
}

// the caller needs to think about the order of return data
// 呼び出し者で返却されるデータの順番を考慮する必要があります。
const [left, __, top] = processInput(input);

// good
function processInput(input) {
  // then a miracle occurs
  // その後、奇跡が起こります。
  return { left, right, top, bottom };
}

// the caller selects only the data they need
// 呼び出し元は必要なデータのみ選択すればいい。
const { left, right } = processInput(input);

⬆ ページのTopへ戻る

文字列(Strings)

  • 6.1 Use single quotes '' for strings.

  • 6.1 文字列にはシングルクオート '' を使用してください。

    // bad
    const name = "Capt. Janeway";
    
    // good
    const name = 'Capt. Janeway';
  • 6.2 Strings longer than 100 characters should be written across multiple lines using string concatenation.

  • 6.2 100文字以上の文字列は、文字列連結を使用して複数行にまたがって記述する必要があります。

  • 6.3 Note: If overused, long strings with concatenation could impact performance. jsPerf & Discussion.

  • 6.3 注意: 文字連結を多用した場合、パフォーマンスに影響を与えることがあります。 jsPerf & Discussion.

    // bad
    const errorMessage = '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.';
    
    // bad
    const errorMessage = '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.';
    
    // good
    const errorMessage = '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.';

  • 6.4 When programmatically building up strings, use template strings instead of concatenation.
  • 6.4 プログラムで文字列を生成する場合は、文字列連結ではなく、template stringsを利用してください。

Why? Template strings give you a readable, concise syntax with proper newlines and string interpolation features.

なぜ? Template strings は文字列補完機能・複数行文字列機能を持つ簡潔な構文で、可読性が良いからです。

// bad
function sayHi(name) {
  return 'How are you, ' + name + '?';
}

// bad
function sayHi(name) {
  return ['How are you, ', name, '?'].join();
}

// good
function sayHi(name) {
  return `How are you, ${name}?`;
}
  • 6.5 Never use eval() on a string, it opens too many vulnerabilities.
  • 6.5 絶対に eval() を利用しないでください。これは、いままで数多くの脆弱性を作って来たからです。

⬆ ページのTopへ戻る

関数(Functions)

  • 7.1 Use function declarations instead of function expressions.
  • 7.1 関数式より関数宣言を利用してください。

Why? Function declarations are named, so they're easier to identify in call stacks. Also, the whole body of a function declaration is hoisted, whereas only the reference of a function expression is hoisted. This rule makes it possible to always use Arrow Functions in place of function expressions.

なぜ? 名前が付けられた関数宣言はコールスタックで簡単に見分けることができます。さらに関数宣言は関数の本体が巻き上げられます。それに対し、関数式は参照だけが巻き上げられます。 このルールにより、関数式の部分を常にアロー関数で置き換えて利用することができます。

// bad
const foo = function () {
};

// good
function foo() {
}
  • 7.2 Function expressions:

  • 7.2 関数式

    // immediately-invoked function expression (IIFE)
    // 即時実行関数(IIFE)
    (() => {
      console.log('Welcome to the Internet. Please follow me.');
    })();
  • 7.3 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.

  • 7.3 関数以外のブロック(ifやwhileなど)の中で関数を宣言しないでください。、変数に関数を代入する代わりブラウザはそのことを許可しますが、(それはまるで「頑張れベアーズ」の悪ガキ達のように)すべて違ったように解釈されます。

  • 7.4 Note: ECMA-262 defines a block as a list of statements. A function declaration is not a statement. Read ECMA-262's note on this issue.

  • 7.4 注意: ECMA-262仕様では block はstatementsの一覧に定義されていますが、関数宣言はstatementsではありません。 Read ECMA-262's note on this issue.

    // bad
    if (currentUser) {
      function test() {
        console.log('Nope.');
      }
    }
    
    // good
    let test;
    if (currentUser) {
      test = () => {
        console.log('Yup.');
      };
    }
  • 7.5 Never name a parameter arguments. This will take precedence over the arguments object that is given to every function scope.

  • 7.5 パラメータに arguments を指定しないでください。これは、関数スコープに渡される arguments オブジェクトの参照を上書きしてしまうためです。

    // bad
    function nope(name, options, arguments) {
      // ...stuff...
    }
    
    // good
    function yup(name, options, args) {
      // ...stuff...
    }

  • 7.6 Never use arguments, opt to use rest syntax ... instead.
  • 7.6 arguments を利用しないでください。代わりにrest syntax ... を利用してください。

Why? ... is explicit about which arguments you want pulled. Plus rest arguments are a real Array and not Array-like like arguments.

なぜ? ... を利用することで、いつくかのパラメータを利用したいことを明らかにすることができます。加えてrestパラメータは arguments の様なArray-likeなオブジェクトではなく正真正銘のArrayです。

// bad
function concatenateAll() {
  const args = Array.prototype.slice.call(arguments);
  return args.join('');
}

// good
function concatenateAll(...args) {
  return args.join('');
}

  • 7.7 Use default parameter syntax rather than mutating function arguments.

  • 7.7 関数のパラメータを突然変異させるのではなく、デフォルトパラメータを利用してください。

    // really bad
    function handleThings(opts) {
      // No! We shouldn't mutate function arguments.
      // Double bad: if opts is falsy it'll be set to an object which may
      // be what you want but it can introduce subtle bugs.
    
      // だめ!関数のパラメータを突然変異させるべきではありません。
      // もし、optsがfalsyだった場合は、望んだようにオブジェクトが設定されます。
      // しかし、微妙なバグを引き起こすかもしれません。
      opts = opts || {};
      // ...
    }
    
    // still bad
    function handleThings(opts) {
      if (opts === void 0) {
        opts = {};
      }
      // ...
    }
    
    // good
    function handleThings(opts = {}) {
      // ...
    }
  • 7.8 Avoid side effects with default parameters.

  • 7.8 副作用のあるデフォルトパラメータの利用は避けてください。

Why? They are confusing to reason about.

なぜ? 混乱させるからです。

var b = 1;
// bad
function count(a = b++) {
  console.log(a);
}
count();  // 1
count();  // 2
count(3); // 3
count();  // 3
  • 7.9 Always put default parameters last.

  • 7.9 常にデフォルトパラメータは末尾に配置してください。

    // bad
    function handleThings(opts = {}, name) {
      // ...
    }
    
    // good
    function handleThings(name, opts = {}) {
      // ...
    }
  • 7.10 Never use the Function constructor to create a new function.

  • 7.10 新しい関数を作成するためにFunctionコンストラクタを利用しないでください。

    Why? Creating a function in this way evaluates a string similarly to eval(), which opens vulnerabilities.

    なぜ? この方法で文字列を評価させて新しい関数を作成することは、eval()と同様の脆弱性を引き起こすことになります。

    // bad
    var add = new Function('a', 'b', 'return a + b');
    
    // still bad
    var subtract = Function('a', 'b', 'return a - b');

⬆ ページのTopへ戻る

アロー関数(Arrow Functions)

  • 8.1 When you must use function expressions (as when passing an anonymous function), use arrow function notation.
  • 8.1 (無名関数を渡すような)関数式を利用する場合、アロー関数表記を利用してください。

Why? It creates a version of the function that executes in the context of this, which is usually what you want, and is a more concise syntax.

なぜ? アロー関数はそのコンテキストの this で実行するバージョンの関数を作成します。これは通常期待通りの動作をし、より簡潔な構文だからです。

Why not? If you have a fairly complicated function, you might move that logic out into its own function declaration.

利用するべきではない? 複雑な関数でロジックを定義した関数の外側に移動したいケース。

// bad
[1, 2, 3].map(function (x) {
  const y = x + 1;
  return x * y;
});

// good
[1, 2, 3].map((x) => {
  const y = x + 1;
  return x * y;
});
  • 8.2 If the function body consists of a single expression, feel free to omit the braces and use the implicit return. Otherwise use a return statement.
  • 8.2 関数の本体が1つの式で構成されている場合は、中括弧({})を省略し、暗黙のreturnを利用することができます。それ以外は return 文を利用してください。

Why? Syntactic sugar. It reads well when multiple functions are chained together.

なぜ? 糖衣構文(読みやすさのために導入される構文)だからです。複数の関数が連結される場合に読みやすくなります。

Why not? If you plan on returning an object.

使うべきではない? オブジェクトを返すケース。

// good
[1, 2, 3].map(number => `A string containing the ${number}.`);

// bad
[1, 2, 3].map(number => {
  const nextNumber = number + 1;
  `A string containing the ${nextNumber}.`;
});

// good
[1, 2, 3].map(number => {
  const nextNumber = number + 1;
  return `A string containing the ${nextNumber}.`;
});
  • 8.3 In case the expression spans over multiple lines, wrap it in parentheses for better readability.
  • 8.3 式の全長が複数行にまたがる場合は、可読性をより良くするため丸括弧()で囲ってください。

Why? It shows clearly where the function starts and ends.

なぜ? 関数の開始と終了部分が分かりやすく見えるためです。

// bad
[1, 2, 3].map(number => 'As time went by, the string containing the ' +
  `${number} became much longer. So we needed to break it over multiple ` +
  'lines.'
);

// good
[1, 2, 3].map(number => (
  `As time went by, the string containing the ${number} became much ` +
  'longer. So we needed to break it over multiple lines.'
));
  • 8.4 If your function only takes a single argument, feel free to omit the parentheses.
  • 8.4 関数の引数が1つの場合、丸括弧()を省略することができます。

Why? Less visual clutter.

なぜ? あまり見難くないからです。

// good
[1, 2, 3].map(x => x * x);

// good
[1, 2, 3].reduce((y, x) => x + y);

⬆ ページのTopへ戻る

コンストラクタ(Constructors)

  • 9.1 Always use class. Avoid manipulating prototype directly.
  • 9.1 prototype を直接操作することを避け、常に class を利用してください。

Why? class syntax is more concise and easier to reason about.

なぜ? class 構文は簡潔で意図がわかりやすいからです。

// bad
function Queue(contents = []) {
  this._queue = [...contents];
}
Queue.prototype.pop = function() {
  const value = this._queue[0];
  this._queue.splice(0, 1);
  return value;
}

// good
class Queue {
  constructor(contents = []) {
    this._queue = [...contents];
  }
  pop() {
    const value = this._queue[0];
    this._queue.splice(0, 1);
    return value;
  }
}
  • 9.2 Use extends for inheritance.
  • 9.2 継承は extends を利用してください。

Why? It is a built-in way to inherit prototype functionality without breaking instanceof.

なぜ? プロトタイプ継承するためにビルトインされた方法で、instanceof を破壊することがないためです。

// bad
const inherits = require('inherits');
function PeekableQueue(contents) {
  Queue.apply(this, contents);
}
inherits(PeekableQueue, Queue);
PeekableQueue.prototype.peek = function() {
  return this._queue[0];
}

// good
class PeekableQueue extends Queue {
  peek() {
    return this._queue[0];
  }
}
  • 9.3 Methods can return this to help with method chaining.

  • 9.3 メソッドの戻り値で this を返すことで、メソッドチェーンをすることができます。

    // bad
    Jedi.prototype.jump = function() {
      this.jumping = true;
      return true;
    };
    
    Jedi.prototype.setHeight = function(height) {
      this.height = height;
    };
    
    const luke = new Jedi();
    luke.jump(); // => true
    luke.setHeight(20); // => undefined
    
    // good
    class Jedi {
      jump() {
        this.jumping = true;
        return this;
      }
    
      setHeight(height) {
        this.height = height;
        return this;
      }
    }
    
    const luke = new Jedi();
    
    luke.jump()
      .setHeight(20);
  • 9.4 It's okay to write a custom toString() method, just make sure it works successfully and causes no side effects.

  • 9.4 独自のtoString()を作成することも認めますが、正しく動作すること、副作用がないことだけは確認してください。

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

⬆ ページのTopへ戻る

モジュール(Modules)

  • 10.1 Always use modules (import/export) over a non-standard module system. You can always transpile to your preferred module system.
  • 10.1 非標準のモジュールシステムではなく、常に (import/export) を利用してください。こうすることで好みのモジュールシステムへいつでもトランスパイルすることでできます。

Why? Modules are the future, let's start using the future now.

Why? モジュールは将来性があります。未来を先取りして使いましょう。

// bad
const AirbnbStyleGuide = require('./AirbnbStyleGuide');
module.exports = AirbnbStyleGuide.es6;

// ok
import AirbnbStyleGuide from './AirbnbStyleGuide';
export default AirbnbStyleGuide.es6;

// best
import { es6 } from './AirbnbStyleGuide';
export default es6;
  • 10.2 Do not use wildcard imports.
  • 10.2 ワイルドカードインポートは利用しないでください。

Why? This makes sure you have a single default export.

なぜ? single default exportであることに注意する必要があるからです。

// bad
import * as AirbnbStyleGuide from './AirbnbStyleGuide';

// good
import AirbnbStyleGuide from './AirbnbStyleGuide';
  • 10.3 And do not export directly from an import.
  • 10.3 import文から直接exportするのはやめてください。

Why? Although the one-liner is concise, having one clear way to import and one clear way to export makes things consistent.

なぜ? ワンライナーは簡潔ではありますが、importとexportの方法を明確に1つとすることで一貫性を保つことができます。

// bad
// filename es6.js
export { es6 as default } from './airbnbStyleGuide';

// good
// filename es6.js
import { es6 } from './AirbnbStyleGuide';
export default es6;

⬆ ページのTopへ戻る

イテレータとジェネレータ(Iterators and Generators)

  • 11.1 Don't use iterators. Prefer JavaScript's higher-order functions like map() and reduce() instead of loops like for-of.
  • 11.1 iteratorsを利用しないでください。for-of ループの代わりに map()reduce() のようなJavascriptの高級関数(higher-order functions)を利用してください。

Why? This enforces our immutable rule. Dealing with pure functions that return values is easier to reason about than side-effects.

なぜ? これはimmutable(不変)ルールを適用します。値を返ような関数の中身の処理を気にするより副作用について推測するほうが簡単です。

const numbers = [1, 2, 3, 4, 5];

// bad
let sum = 0;
for (let num of numbers) {
  sum += num;
}

sum === 15;

// good
let sum = 0;
numbers.forEach((num) => sum += num);
sum === 15;

// best (use the functional force)
const sum = numbers.reduce((total, num) => total + num, 0);
sum === 15;
  • 11.2 Don't use generators for now.
  • 11.2 現時点ではgeneratorsは利用しないでください。

Why? They don't transpile well to ES5.

なぜ? ES5にうまくトランスパイルできないから。

⬆ ページのTopへ戻る

プロパティ(Properties)

  • 12.1 Use dot notation when accessing properties.

  • 12.1 プロパティにアクセスする場合は、ドット . を使用してください。

    const luke = {
      jedi: true,
      age: 28,
    };
    
    // bad
    const isJedi = luke['jedi'];
    
    // good
    const isJedi = luke.jedi;
  • 12.2 Use subscript notation [] when accessing properties with a variable.

  • 12.2 変数を使用してプロパティにアクセスする場合は、角括弧 [] を使用してください。

    const luke = {
      jedi: true,
      age: 28,
    };
    
    function getProp(prop) {
      return luke[prop];
    }
    
    const isJedi = getProp('jedi');

⬆ ページのTopへ戻る

変数(Variables)

  • 13.1 Always use const to declare variables. Not doing so will result in global variables. We want to avoid polluting the global namespace. Captain Planet warned us of that.

  • 13.1 変数を宣言する際は、常に const を使用してください。使用しない場合、グローバル変数として宣言されます。グローバルな名前空間を汚染しないように、キャプテンプラネット(環境保護とエコロジーをテーマにしたスーパーヒーローアニメ)も警告しています。

    // bad
    superPower = new SuperPower();
    
    // good
    const superPower = new SuperPower();
  • 13.2 Use one const declaration per variable.

  • 13.2 1つの変数宣言に対して1つの const を利用してください。

    Why? It's easier to add new variable declarations this way, and you never have to worry about swapping out a ; for a , or introducing punctuation-only diffs.

    なぜ? この方法の場合、簡単に新しい変数を追加することができます。また、二度と区切り文字の違いによる ;, に置き換える作業を心配することがありません。

    // bad
    const items = getItems(),
        goSportsTeam = true,
        dragonball = 'z';
    
    // bad
    // (compare to above, and try to spot the mistake)
    const items = getItems(),
        goSportsTeam = true;
        dragonball = 'z';
    
    // good
    const items = getItems();
    const goSportsTeam = true;
    const dragonball = 'z';
  • 13.3 Group all your consts and then group all your lets.

  • 13.3 まず const をグループ化して、その後 let をグループ化してください。

Why? This is helpful when later on you might need to assign a variable depending on one of the previous assigned variables.

なぜ? 以前に割り当てた変数に応じて、後で新しい変数を追加する場合に有用だからです。

// bad
let i, len, dragonball,
    items = getItems(),
    goSportsTeam = true;

// bad
let i;
const items = getItems();
let dragonball;
const goSportsTeam = true;
let len;

// good
const goSportsTeam = true;
const items = getItems();
let dragonball;
let i;
let length;
  • 13.4 Assign variables where you need them, but place them in a reasonable place.
  • 13.4 変数を割り当てる際は、必要かつ合理的な場所で行ってください。

Why? let and const are block scoped and not function scoped.

なぜ? letconst はブロックスコープだからです。関数スコープではありません。

// good
function() {
  test();
  console.log('doing stuff..');

  //..other stuff..

  const name = getName();

  if (name === 'test') {
    return false;
  }

  return name;
}

// bad - unnecessary function call
function(hasName) {
  const name = getName();

  if (!hasName) {
    return false;
  }

  this.setFirstName(name);

  return true;
}

// good
function(hasName) {
  if (!hasName) {
    return false;
  }

  const name = getName();
  this.setFirstName(name);

  return true;
}

⬆ ページのTopへ戻る

巻き上げ(Hoisting)

  • 14.1 var declarations get hoisted to the top of their scope, their assignment does not. const and let declarations are blessed with a new concept called Temporal Dead Zones (TDZ). It's important to know why typeof is no longer safe.

  • 14.1 var 宣言は割り当てがないままスコープの先頭へ巻き上げられます。 constlet 宣言は時間的デットゾーン(Temporal Dead Zones (TDZ))と呼ばれる新しいコンセプトの恩恵を受けています。これはなぜtypeofは安全ではないかを知っていることが重要です。

    // we know this wouldn't work (assuming there
    // is no notDefined global variable)
    // (notDefinedがグローバル変数に存在しないと仮定した場合。)
    // これはうまく動作しません。
    function example() {
      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.
    // その変数を参照するコードの後でその変数を宣言した場合、
    // 変数が巻上げられた上で動作します。
    // 注意:`true` という値自体は巻き上げられません。
    function example() {
      console.log(declaredButNotAssigned); // => undefined
      var declaredButNotAssigned = true;
    }
    
    // The interpreter is hoisting the variable
    // declaration to the top of the scope,
    // which means our example could be rewritten as:
    // インタープリンタは変数宣言をスコープの先頭に巻き上げます。
    // 上の例は次のように書き直すことが出来ます。
    function example() {
      let declaredButNotAssigned;
      console.log(declaredButNotAssigned); // => undefined
      declaredButNotAssigned = true;
    }
    
    // using const and let
    // const と let を利用した場合
    function example() {
      console.log(declaredButNotAssigned); // => throws a ReferenceError
      console.log(typeof declaredButNotAssigned); // => throws a ReferenceError
      const declaredButNotAssigned = true;
    }
  • 14.2 Anonymous function expressions hoist their variable name, but not the function assignment.

  • 14.2 無名関数の場合、関数が割当てされる前の変数が巻き上げられます。

    function example() {
      console.log(anonymous); // => undefined
    
      anonymous(); // => TypeError anonymous is not a function
    
      var anonymous = function() {
        console.log('anonymous function expression');
      };
    }
  • 14.3 Named function expressions hoist the variable name, not the function name or the function body.

  • 14.3 名前付き関数の場合も同様に変数が巻き上げられます。関数名や関数本体は巻き上げられません。

    function example() {
      console.log(named); // => undefined
    
      named(); // => TypeError named is not a function
    
      superPower(); // => ReferenceError superPower is not defined
    
      var named = function superPower() {
        console.log('Flying');
      };
    }
    
    // the same is true when the function name
    // is the same as the variable name.
    // 関数名と変数名が同じ場合も同じことが起きます。
    function example() {
      console.log(named); // => undefined
    
      named(); // => TypeError named is not a function
    
      var named = function named() {
        console.log('named');
      }
    }
  • 14.4 Function declarations hoist their name and the function body.

  • 14.4 関数宣言は関数名と関数本体が巻き上げられます。

    function example() {
      superPower(); // => Flying
    
      function superPower() {
        console.log('Flying');
      }
    }
  • For more information refer to JavaScript Scoping & Hoisting by Ben Cherry.

  • 詳しくはこちらを参照してください。 JavaScript Scoping & Hoisting by Ben Cherry.

⬆ ページのTopへ戻る

条件式と等価式(Comparison Operators & Equality)

  • 15.1 Use === and !== over == and !=.

  • 15.1 ==!=より ===!== を使用してください。

  • 15.2 Conditional statements such as the if statement evaluate their expression using coercion with the ToBoolean abstract method 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 evaluate to false if +0, -0, or NaN, otherwise true
    • Strings evaluate to false if an empty string '', otherwise true
  • 15.2 if 文のような条件式は ToBoolean メソッドによる強制型変換で評価され、常にこれらのシンプルなルールに従います。

    • オブジェクトtrue と評価されます。
    • undefinedfalse と評価されます。
    • nullfalse と評価されます。
    • 真偽値boolean型の値 として評価されます。
    • 数値true と評価されます。しかし、 +0, -0, or NaN の場合は false です。
    • 文字列true と評価されます。 しかし、空文字 '' の場合は false です。
    if ([0]) {
      // true
      // An array is an object, objects evaluate to true
      // 配列はオブジェクトなのでtrueとして評価されます。
    }
  • 15.3 Use shortcuts.

  • 15.3 短縮形を使用してください。

    // bad
    if (name !== '') {
      // ...stuff...
    }
    
    // good
    if (name) {
      // ...stuff...
    }
    
    // bad
    if (collection.length > 0) {
      // ...stuff...
    }
    
    // good
    if (collection.length) {
      // ...stuff...
    }
  • 15.4 For more information see Truth Equality and JavaScript by Angus Croll.

  • 15.4 詳しくはこちらを参照してください。 Truth Equality and JavaScript by Angus Croll.

⬆ ページのTopへ戻る

ブロック(Blocks)

  • 16.1 Use braces with all multi-line blocks.

  • 16.1 複数行のブロックには中括弧({})を使用してください。

    // bad
    if (test)
      return false;
    
    // good
    if (test) return false;
    
    // good
    if (test) {
      return false;
    }
    
    // bad
    function() { return false; }
    
    // good
    function() {
      return false;
    }
  • 16.2 If you're using multi-line blocks with if and else, put else on the same line as your if block's closing brace.

  • 16.2 複数ブロックに渡る ifelse を利用する場合、 elseif ブロックの終わりの中括弧(})と同じ行においてください。

    // bad
    if (test) {
      thing1();
      thing2();
    }
    else {
      thing3();
    }
    
    // good
    if (test) {
      thing1();
      thing2();
    } else {
      thing3();
    }

⬆ ページのTopへ戻る

コメント(Comments)

  • 17.1 Use /** ... */ for multi-line comments. Include a description, specify types and values for all parameters and return values.

  • 17.1 複数行のコメントは/** ... */ を使用してください。その中には説明とすべてのパラメータと戻り値についての型や値を記述してください。

    // bad
    // make() returns a new element
    // based on the passed in tag name
    //
    // @param {String} tag
    // @return {Element} element
    function make(tag) {
    
      // ...stuff...
    
      return element;
    }
    
    // good
    /**
     * make() returns a new element
     * based on the passed in tag name
     *
     * @param {String} tag
     * @return {Element} element
     */
    function make(tag) {
    
      // ...stuff...
    
      return element;
    }
  • 17.2 Use // for single line comments. Place single line comments on a newline above the subject of the comment. Put an empty line before the comment unless it's on the first line of a block.

  • 17.2 単一行コメントには// を使用してください。コメントを加えたいコードの上部に配置してください。また、コメントの前に空行を入れてください。

    // bad
    const active = true;  // is current tab
    
    // good
    // is current tab
    const active = true;
    
    // bad
    function getType() {
      console.log('fetching type...');
      // set the default type to 'no type'
      const type = this._type || 'no type';
    
      return type;
    }
    
    // good
    function getType() {
      console.log('fetching type...');
    
      // set the default type to 'no type'
      const type = this._type || 'no type';
    
      return type;
    }
    
    // also good
    function getType() {
      // set the default type to 'no type'
      const type = this._type || 'no type';
    
      return type;
    }
  • 17.3 Prefixing your comments with FIXME or TODO helps other developers quickly understand if you're pointing out a problem that needs to be revisited, or if you're suggesting a solution to the problem that needs to be implemented. These are different than regular comments because they are actionable. The actions are FIXME -- need to figure this out or TODO -- need to implement.

  • 17.3 問題を指摘して再考を促す場合や、問題の解決策を提案する場合など、コメントの前に FIXMETODO を付けることで他のデベロッパの素早い理解を助けることができます。これらは、何らかのアクションを伴うという意味で通常のコメントとは異なります。アクションとは FIXME -- 解決策が必要 もしくは TODO -- 実装が必要 です。

  • 17.4 Use // FIXME: to annotate problems.

  • 17.4 問題に対する注釈として // FIXME: を使用してください。

    class Calculator extends Abacus {
      constructor() {
        super();
    
        // FIXME: shouldn't use a global here
        // FIXME: グローバル変数を使用するべきではない。
        total = 0;
      }
    }
  • 17.5 Use // TODO: to annotate solutions to problems.

  • 17.5 問題の解決策に対する注釈として // TODO: を使用してください。

    class Calculator extends Abacus {
      constructor() {
        super();
    
        // TODO: total should be configurable by an options param
        // TODO: total はオプションパラメータとして設定されるべき。
        this.total = 0;
      }
    }

⬆ ページのTopへ戻る

空白(Whitespace)

  • 18.1 Use soft tabs set to 2 spaces.

  • 18.1 タブにはスペース2つを設定してください。

    // bad
    function() {
    ∙∙∙∙const name;
    }
    
    // bad
    function() {
    ∙const name;
    }
    
    // good
    function() {
    ∙∙const name;
    }
  • 18.2 Place 1 space before the leading brace.

  • 18.2 重要な中括弧({})の前にはスペースを1つ入れてください。

    // bad
    function test(){
      console.log('test');
    }
    
    // good
    function test() {
      console.log('test');
    }
    
    // bad
    dog.set('attr',{
      age: '1 year',
      breed: 'Bernese Mountain Dog',
    });
    
    // good
    dog.set('attr', {
      age: '1 year',
      breed: 'Bernese Mountain Dog',
    });
  • 18.3 Place 1 space before the opening parenthesis in control statements (if, while etc.). Place no space before the argument list in function calls and declarations.

  • 18.3 制御構文( if 文や while 文など)の丸括弧(())の前にはスペースを1つ入れてください。関数宣言や関数呼び出し時の引数リストの前にはスペースは入れないでください。

    // bad
    if(isJedi) {
      fight ();
    }
    
    // good
    if (isJedi) {
      fight();
    }
    
    // bad
    function fight () {
      console.log ('Swooosh!');
    }
    
    // good
    function fight() {
      console.log('Swooosh!');
    }
  • 18.4 Set off operators with spaces.

  • 18.4 演算子の間はスペースを入れてください。

    // bad
    const x=y+5;
    
    // good
    const x = y + 5;
  • 18.5 End files with a single newline character.

  • 18.5 ファイルの最後は改行文字を1つ入れてください。

    // bad
    (function(global) {
      // ...stuff...
    })(this);
    // bad
    (function(global) {
      // ...stuff...
    })(this);↵
    ↵
    // good
    (function(global) {
      // ...stuff...
    })(this);↵
  • 18.6 Use indentation when making long method chains. Use a leading dot, which emphasizes that the line is a method call, not a new statement.

  • 18.6 長くメソッドを連結する場合はインデントを利用してください。行がメソッド呼び出しではなく、新しい文であることを強調するために先頭にドット(.)を配置してください。

    // bad
    $('#items').find('.selected').highlight().end().find('.open').updateCount();
    
    // bad
    $('#items').
      find('.selected').
        highlight().
        end().
      find('.open').
        updateCount();
    
    // good
    $('#items')
      .find('.selected')
        .highlight()
        .end()
      .find('.open')
        .updateCount();
    
    // bad
    const leds = 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);
    
    // good
    const leds = stage.selectAll('.led')
        .data(data)
      .enter().append('svg:svg')
        .classed('led', true)
        .attr('width', (radius + margin) * 2)
      .append('svg:g')
        .attr('transform', 'translate(' + (radius + margin) + ',' + (radius + margin) + ')')
        .call(tron.led);
  • 18.7 Leave a blank line after blocks and before the next statement.

  • 18.7 文の前とブロックの後には改行を残してください。

    // bad
    if (foo) {
      return bar;
    }
    return baz;
    
    // good
    if (foo) {
      return bar;
    }
    
    return baz;
    
    // bad
    const obj = {
      foo() {
      },
      bar() {
      },
    };
    return obj;
    
    // good
    const obj = {
      foo() {
      },
    
      bar() {
      },
    };
    
    return obj;
    
    // bad
    const arr = [
      function foo() {
      },
      function bar() {
      },
    ];
    return arr;
    
    // good
    const arr = [
      function foo() {
      },
    
      function bar() {
      },
    ];
    
    return arr;
  • 18.8 Do not pad your blocks with blank lines.

  • 18.8 ブロックに空行を挟み込まないでください。

    // bad
    function bar() {
    
      console.log(foo);
    
    }
    
    // also bad
    if (baz) {
    
      console.log(qux);
    } else {
      console.log(foo);
    
    }
    
    // good
    function bar() {
      console.log(foo);
    }
    
    // good
    if (baz) {
      console.log(qux);
    } else {
      console.log(foo);
    }
  • 18.9 Do not add spaces inside parentheses.

  • 18.9 丸括弧()の内側にスペースを追加しないでください。

    // bad
    function bar( foo ) {
      return foo;
    }
    
    // good
    function bar(foo) {
      return foo;
    }
    
    // bad
    if ( foo ) {
      console.log(foo);
    }
    
    // good
    if (foo) {
      console.log(foo);
    }
  • 18.10 Do not add spaces inside brackets.

  • 18.10 角括弧([])の内側にスペースを追加しないでください。

    // bad
    const foo = [ 1, 2, 3 ];
    console.log(foo[ 0 ]);
    
    // good
    const foo = [1, 2, 3];
    console.log(foo[0]);
  • 18.11 Add spaces inside curly braces.

  • 18.11 中括弧({})の内側にスペースを追加してください。

    // bad
    const foo = {clark: 'kent'};
    
    // good
    const foo = { clark: 'kent' };

⬆ ページのTopへ戻る

カンマ(Commas)

  • 19.1 Leading commas: Nope.

  • 19.1 先頭のカンマ やめてください:<

    // bad
    const story = [
        once
      , upon
      , aTime
    ];
    
    // good
    const story = [
      once,
      upon,
      aTime,
    ];
    
    // bad
    const hero = {
        firstName: 'Ada'
      , lastName: 'Lovelace'
      , birthYear: 1815
      , superPower: 'computers'
    };
    
    // good
    const hero = {
      firstName: 'Ada',
      lastName: 'Lovelace',
      birthYear: 1815,
      superPower: 'computers',
    };
  • 19.2 Additional trailing comma: Yup.

  • 19.2 末尾のカンマ いいね:)

Why? This leads to cleaner git diffs. Also, transpilers like Babel will remove the additional trailing comma in the transpiled code which means you don't have to worry about the trailing comma problem in legacy browsers.

なぜ? これはクリーンなgitの差分につながります。また、Babelの様なトランスパイラはトランスパイルする際に末尾の余計なカンマを除去します。これは、レガシーブラウザでの余計なカンマ問題を心配する必要がないことを意味します。

// bad - git diff without trailing comma
const hero = {
     firstName: 'Florence',
-    lastName: 'Nightingale'
+    lastName: 'Nightingale',
+    inventorOf: ['coxcomb graph', 'modern nursing']
};

// good - git diff with trailing comma
const hero = {
     firstName: 'Florence',
     lastName: 'Nightingale',
+    inventorOf: ['coxcomb chart', 'modern nursing'],
};

// bad
const hero = {
  firstName: 'Dana',
  lastName: 'Scully'
};

const heroes = [
  'Batman',
  'Superman'
];

// good
const hero = {
  firstName: 'Dana',
  lastName: 'Scully',
};

const heroes = [
  'Batman',
  'Superman',
];

⬆ ページのTopへ戻る

セミコロン(Semicolons)

  • 20.1 Yup.

  • 20.1 もちろん使いましょう。

    // bad
    (function() {
      const name = 'Skywalker'
      return name
    })()
    
    // good
    (() => {
      const name = 'Skywalker';
      return name;
    })();
    
    // good (guards against the function becoming an argument when two files with IIFEs are concatenated)
    // good (即時関数を伴う2つのファイルを連結した場合に、引数となる部分を保護します。)
    ;(() => {
      const name = 'Skywalker';
      return name;
    })();

    Read more.

⬆ ページのTopへ戻る

型変換と強制(Type Casting & Coercion)

  • 21.1 Perform type coercion at the beginning of the statement.

  • 21.1 文の先頭で型の強制を行います。

  • 21.2 Strings:

  • 21.2 文字列の場合:

    //  => this.reviewScore = 9;
    
    // bad
    const totalScore = this.reviewScore + '';
    
    // good
    const totalScore = String(this.reviewScore);
  • 21.3 Numbers: Use Number for type casting and parseInt always with a radix for parsing strings.

  • 21.3 数値の場合: 型変換には Number を使用してください。 parseInt を使用する場合、常に型変換のための基数を引数に渡してください。

    const inputValue = '4';
    
    // bad
    const val = new Number(inputValue);
    
    // bad
    const val = +inputValue;
    
    // bad
    const val = inputValue >> 0;
    
    // bad
    const val = parseInt(inputValue);
    
    // good
    const val = Number(inputValue);
    
    // good
    const val = parseInt(inputValue, 10);
  • 21.4 If for whatever reason you are doing something wild and parseInt is your bottleneck and need to use Bitshift for performance reasons, leave a comment explaining why and what you're doing.

  • 21.4 何らかの理由により parseInt がボトルネックとなっており、パフォーマンス的な理由でビットシフトを使用す必要がある場合、 やろうとしている事について、why(なぜ)とwhat(何を)の説明をコメントとして残してください。

    // good
    /**
     * parseInt was the reason my code was slow.
     * Bitshifting the String to coerce it to a
     * Number made it a lot faster.
     * parseIntがボトルネックとなっていたため、
     * ビットシフトで文字列を数値へ強制的に変換することで
     * パフォーマンスを改善させます。
     */
    const val = inputValue >> 0;
  • 21.5 Note: Be careful when using bitshift operations. Numbers are represented as 64-bit values, but Bitshift operations always return a 32-bit integer (source). Bitshift can lead to unexpected behavior for integer values larger than 32 bits. Discussion. Largest signed 32-bit Int is 2,147,483,647:

  • 21.5 注意: ビットシフトを使用する場合の注意事項。数値は64ビット倍精度として表現されていますが、ビットシフト演算した場合は常に32ビット単精度で返されます(エビデンス)。 32ビット以上の数値をビットシフトする場合、予期せぬ振る舞いを起こす可能性があります(議論)。符号付き32ビット整数の最大値は2,147,483,647です。

    2147483647 >> 0 //=> 2147483647
    2147483648 >> 0 //=> -2147483648
    2147483649 >> 0 //=> -2147483647
  • 21.6 Booleans:

  • 21.6 真偽値の場合:

    const age = 0;
    
    // bad
    const hasAge = new Boolean(age);
    
    // good
    const hasAge = Boolean(age);
    
    // good
    const hasAge = !!age;

⬆ ページのTopへ戻る

命名規則(Naming Conventions)

  • 22.1 Avoid single letter names. Be descriptive with your naming.

  • 22.1 1文字の名前は避けてください。名前から意図が読み取れるようにしてください。

    // bad
    function q() {
      // ...stuff...
    }
    
    // good
    function query() {
      // ..stuff..
    }
  • 22.2 Use camelCase when naming objects, functions, and instances.

  • 22.2 オブジェクト、関数、インスタンスにはキャメルケース(小文字から始まる)を使用してください。

    // bad
    const OBJEcttsssss = {};
    const this_is_my_object = {};
    function c() {}
    
    // good
    const thisIsMyObject = {};
    function thisIsMyFunction() {}
  • 22.3 Use PascalCase when naming constructors or classes.

  • 22.3 クラスやコンストラクタにはパスカルケース(大文字から始まる)を使用してください。

    // bad
    function user(options) {
      this.name = options.name;
    }
    
    const bad = new user({
      name: 'nope',
    });
    
    // good
    class User {
      constructor(options) {
        this.name = options.name;
      }
    }
    
    const good = new User({
      name: 'yup',
    });
  • 22.4 Use a leading underscore _ when naming private properties.

  • 22.4 プライベートなプロパティ名は先頭にアンダースコア _ を使用してください。

    // bad
    this.__firstName__ = 'Panda';
    this.firstName_ = 'Panda';
    
    // good
    this._firstName = 'Panda';
  • 22.5 Don't save references to this. Use arrow functions or Function#bind.

  • 22.5 this への参照を保存するの避けてください。アロー関数かFunction#bindを利用してください。

    // bad
    function foo() {
      const self = this;
      return function() {
        console.log(self);
      };
    }
    
    // bad
    function foo() {
      const that = this;
      return function() {
        console.log(that);
      };
    }
    
    // good
    function foo() {
      return () => {
        console.log(this);
      };
    }
  • 22.6 If your file exports a single class, your filename should be exactly the name of the class.

  • 22.6 ファイルを1つのクラスとしてexportする場合、ファイル名はクラス名と完全に一致させなければなりません。

    // file contents
    class CheckBox {
      // ...
    }
    export default CheckBox;
    
    // in some other file
    // bad
    import CheckBox from './checkBox';
    
    // bad
    import CheckBox from './check_box';
    
    // good
    import CheckBox from './CheckBox';
  • 22.7 Use camelCase when you export-default a function. Your filename should be identical to your function's name.

  • 22.7 Default exportが関数の場合、キャメルケース(小文字から始まる)を利用してください。ファイル名は関数名と同じにしなければなりません。

    function makeStyleGuide() {
    }
    
    export default makeStyleGuide;
  • 22.8 Use PascalCase when you export a singleton / function library / bare object.

  • 22.8 シングルトン / function library / 単なるオブジェクトをexportする場合、パスカルケース(大文字から始まる)を利用してください。

    const AirbnbStyleGuide = {
      es6: {
      }
    };
    
    export default AirbnbStyleGuide;

⬆ ページのTopへ戻る

アクセッサ(Accessors)

  • 23.1 Accessor functions for properties are not required.

  • 23.1 プロパティのためのアクセサ(Accessor)関数は必須ではありません。

  • 23.2 If you do make accessor functions use getVal() and setVal('hello').

  • 23.2 アクセサ関数が必要な場合、getVal()setVal('hello') としてください。

    // bad
    dragon.age();
    
    // good
    dragon.getAge();
    
    // bad
    dragon.age(25);
    
    // good
    dragon.setAge(25);
  • 23.3 If the property is a boolean, use isVal() or hasVal().

  • 23.3 プロパティが boolean の場合、isVal()hasVal() としてください。

    // bad
    if (!dragon.age()) {
      return false;
    }
    
    // good
    if (!dragon.hasAge()) {
      return false;
    }
  • 23.4 It's okay to create get() and set() functions, but be consistent.

  • 23.4 一貫していれば、get()set() という関数を作成することも可能です。

    class Jedi {
      constructor(options = {}) {
        const lightsaber = options.lightsaber || 'blue';
        this.set('lightsaber', lightsaber);
      }
    
      set(key, val) {
        this[key] = val;
      }
    
      get(key) {
        return this[key];
      }
    }

⬆ ページのTopへ戻る

イベント(Events)

  • 24.1 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:

  • 24.1 DOMイベントやBackbone eventsのような独自の)イベントへペイロードの値を渡す場合は、生の値の代わりにハッシュ引数を渡してください。 こうすることで、後の開発者がイベントに関連する全てのハンドラを見つけて更新することなく、イベント・ぺイロードに値を追加することが出来ます。例えば、下の例より

    // bad
    $(this).trigger('listingUpdated', listing.id);
    
    ...
    
    $(this).on('listingUpdated', function(e, listingId) {
      // do something with listingId
    });

    prefer: こちらの方が好まれます:

    // good
    $(this).trigger('listingUpdated', { listingId: listing.id });
    
    ...
    
    $(this).on('listingUpdated', function(e, data) {
      // do something with data.listingId
    });

⬆ ページのTopへ戻る

jQuery

  • 25.1 Prefix jQuery object variables with a $.

  • 25.1 jQueryオブジェクトの変数は、先頭に $ を付与してください。

    // bad
    const sidebar = $('.sidebar');
    
    // good
    const $sidebar = $('.sidebar');
    
    // good
    const $sidebarBtn = $('.sidebar-btn');
  • 25.2 Cache jQuery lookups.

  • 25.2 jQueryの検索結果をキャッシュしてください。

    // bad
    function setSidebar() {
      $('.sidebar').hide();
    
      // ...stuff...
    
      $('.sidebar').css({
        'background-color': 'pink'
      });
    }
    
    // good
    function setSidebar() {
      const $sidebar = $('.sidebar');
      $sidebar.hide();
    
      // ...stuff...
    
      $sidebar.css({
        'background-color': 'pink'
      });
    }
  • 25.3 For DOM queries use Cascading $('.sidebar ul') or parent > child $('.sidebar > ul'). jsPerf

  • 25.3 DOMの検索には、 $('.sidebar ul')$('.sidebar > ul') のカスケードを使用してください。 jsPerf

  • 25.4 Use find with scoped jQuery object queries.

  • 25.4 jQueryオブジェクトの検索には、スコープ付きの find を使用してください。

    // bad
    $('ul', '.sidebar').hide();
    
    // bad
    $('.sidebar').find('ul').hide();
    
    // good
    $('.sidebar ul').hide();
    
    // good
    $('.sidebar > ul').hide();
    
    // good
    $sidebar.find('ul').hide();

⬆ ページのTopへ戻る

ECMAScript 5 互換性(ECMAScript 5 Compatibility)

⬆ ページのTopへ戻る

ECMAScript 6 Styles

  • 27.1 This is a collection of links to the various es6 features.
  • 27.1 これはES6仕様についてリンクを集めたものです。
  1. Arrow Functions
  2. Classes
  3. Object Shorthand
  4. Object Concise
  5. Object Computed Properties
  6. Template Strings
  7. Destructuring
  8. Default Parameters
  9. Rest
  10. Array Spreads
  11. Let and Const
  12. Iterators and Generators
  13. Modules

⬆ ページのTopへ戻る

テスト(Testing)

  • 28.1 Yup.

  • 28.1 もちろん 👍

    function () {
      return true;
    }
  • 28.2 No, but seriously:

  • Whichever testing framework you use, you should be writing tests!

  • Strive to write many small pure functions, and minimize where mutations occur.

  • Be cautious about stubs and mocks - they can make your tests more brittle.

  • We primarily use mocha at Airbnb. tape is also used occasionally for small, separate modules.

  • 100% test coverage is a good goal to strive for, even if it's not always practical to reach it.

  • Whenever you fix a bug, write a regression test. A bug fixed without a regression test is almost certainly going to break again in the future.

  • 28.2 もちろん、真剣に:

  • どのみちテストフレームワークを利用してテストを書くことになります!

  • 小さな機能の関数を多く書き、異変が起こる箇所を最小化することに努めます。

  • スタブとモックについては注意してください。テストを脆いものにすることがあります。

  • Airbnbでは mocha を利用しています。小さく分割された個々の小さなモジュールでは tape を使うこともあります。

  • 例え到達することが現実的でない場合であっても、100%のテストカバレッジを目標とすることは良いことです。

  • バグ修正するたびに リグレッションテストを書きます。 リグレッションテストがないバグ修正は、将来必ず壊れるでしょう。

⬆ ページのTopへ戻る

パフォーマンス(Performance)

⬆ ページのTopへ戻る

参考文献(Resources)

Learning ES6

Read This

Tools

Other Style Guides

Other Styles

Further Reading

Books

Blogs

Podcasts

⬆ ページのTopへ戻る

共鳴者(In the Wild)

This is a list of organizations that are using this style guide. Send us a pull request and we'll add you to the list.

これはこのスタイルガイドを使用している組織の一覧表です。このリストに追加して欲しい場合は、pull requestかissueを挙げてください。

⬆ ページのTopへ戻る

翻訳(Translation)

This style guide is also available in other languages:

このスタイルガイドは他の言語でも利用できます。

JavaScriptスタイルガイドへの手引き(The JavaScript Style Guide Guide)

Javascriptスタイルガイドについてのchat(Chat With Us About JavaScript)

貢献者(Contributors)

License

(The MIT License)

Copyright (c) 2014 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.

MITライセンス

著作権(c) 2014 Airbnb
翻訳 2015 mitsuruog

このソフトウェアおよび関連する文書ファイル(以下「本ソフトウェア」という。)の複製物を取得するあらゆる者に対し、 以下の条件にしたがって本ソフトウェアを制限なしに扱うことを無償で許諾する。 そこには、本ソフトウェアの複製を使用し、複製し、改変し、結合し、公表し、頒布し、サブライセンスし、 および/または販売する権利、また、本ソフトウェアを与えられた者に上記のようにすることを許諾する権利を含むがそれらに限られない。

上記の著作権表示および本許諾表示は「本ソフトウェア」のすべての複製物または重要部分の中に含めなければならない。

「本ソフトウェア」は「現状のまま」で提供され、明示または黙示を問わず、 商品性、特定目的への適合性および非侵害を含むがそれに限られない、あらゆる種類の保証も伴わないものとする。 著作者または著作権者は、契約、不法行為またはその他の行為であるかにかかわらず、 ソフトウェアまたはソフトウェアの使用もしくはその他の取り扱いから、またはそれらに関連して生じた、 いかなるクレーム、損害賠償その他の責任を負わない。

⬆ ページのTopへ戻る

補足(Amendments)

We encourage you to fork this guide and change the rules to fit your team's style guide. Below, you may list some amendments to the style guide. This allows you to periodically update your style guide without having to deal with merge conflicts.

我々はこのガイドをforkして、あなたのチームに適したスタイルガイドとして変更することを勧めます。以下にあなたがスタイルガイドに加えた変更をリストにしてください。 こうすることで、マージの煩わしさに気を取られることなく、あなたのスタイルガイドを定期的に更新することができます。

};