javascript
1.0.0
JavaScript に対するほぼ合理的なアプローチ
注: このガイドは Babel を使用していることを前提としており、babel-preset-airbnb または同等のものを使用する必要があります。また、airbnb-browser-shims または同等のものを使用して、アプリにシム/ポリフィルをインストールしていることも前提としています。
このガイドは他の言語でも利用できます。翻訳を見る
その他のスタイルガイド
1.1プリミティブ: プリミティブ型にアクセスすると、その値が直接操作されます。
stringnumberbooleannullundefinedsymbolbigint const foo = 1 ;
let bar = foo ;
bar = 9 ;
console . log ( foo , bar ) ; // => 1, 91.2 Complex : 複合型にアクセスするときは、その値への参照を操作します。
objectarrayfunction const foo = [ 1 , 2 ] ;
const bar = foo ;
bar [ 0 ] = 9 ;
console . log ( foo [ 0 ] , bar [ 0 ] ) ; // => 9, 9⬆トップに戻る
2.1 すべての参照にconst使用します。 var使用は避けてください。 eslint: prefer-const 、 no-const-assign
なぜ？これにより、参照を再割り当てできなくなります。これにより、バグが発生したり、コードが理解しにくくなる可能性があります。
// bad
var a = 1 ;
var b = 2 ;
// good
const a = 1 ;
const b = 2 ; 2.2 参照を再割り当てする必要がある場合は、 varの代わりにletを使用します。 eslint: no-var
なぜ？
letvarのような関数スコープではなくブロックスコープです。
// bad
var count = 1 ;
if ( true ) {
count += 1 ;
}
// good, use the let.
let count = 1 ;
if ( true ) {
count += 1 ;
} 2.3 letとconst両方ともブロック スコープであるのに対し、 varは関数スコープであることに注意してください。
// const and let only exist in the blocks they are defined in.
{
let a = 1 ;
const b = 1 ;
var c = 1 ;
}
console . log ( a ) ; // ReferenceError
console . log ( b ) ; // ReferenceError
console . log ( c ) ; // Prints 1上記のコードでは、 aとb参照すると ReferenceError が生成され、 cには数値が含まれていることがわかります。これは、 aとbブロック スコープであるのに対し、 cはそれを含む関数にスコープされているためです。
⬆トップに戻る
3.1 オブジェクトの作成にはリテラル構文を使用します。 eslint: no-new-object
// bad
const item = new Object ( ) ;
// good
const item = { } ;3.2 動的プロパティ名を持つオブジェクトを作成する場合は、計算されたプロパティ名を使用します。
なぜ？これらを使用すると、オブジェクトのすべてのプロパティを 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.3 オブジェクトメソッドの短縮表現を使用します。 eslint: object-shorthand
// bad
const atom = {
value : 1 ,
addValue : function ( value ) {
return atom . value + value ;
} ,
} ;
// good
const atom = {
value : 1 ,
addValue ( value ) {
return atom . value + value ;
} ,
} ; 3.4 プロパティ値の省略表現を使用します。 eslint: object-shorthand
なぜ？より短くて説明的です。
const lukeSkywalker = 'Luke Skywalker' ;
// bad
const obj = {
lukeSkywalker : lukeSkywalker ,
} ;
// good
const obj = {
lukeSkywalker ,
} ;3.5 オブジェクト宣言の先頭で短縮プロパティをグループ化します。
なぜ？どのプロパティが短縮表現を使用しているかを区別するのが簡単です。
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 ,
} ; 3.6 無効な識別子であるプロパティのみを引用します。 eslint: quote-props
なぜ？一般に、主観的には読みやすいと考えられます。これにより、構文の強調表示が改善され、多くの JS エンジンによって最適化されやすくなります。
// bad
const bad = {
'foo' : 3 ,
'bar' : 4 ,
'data-blah' : 5 ,
} ;
// good
const good = {
foo : 3 ,
bar : 4 ,
'data-blah' : 5 ,
} ; 3.7 hasOwnProperty 、 propertyIsEnumerable 、 isPrototypeOfなどのObject.prototypeメソッドを直接呼び出さないでください。 eslint: no-prototype-builtins
なぜ？これらのメソッドは、問題のオブジェクトのプロパティによってシャドウされる可能性があります -
{ hasOwnProperty: false }考慮してください - または、オブジェクトが null オブジェクト (Object.create(null)) である可能性があります。 ES2022 をサポートする最新のブラウザー、または https://npmjs.com/object.hasown などのポリフィルを使用する場合は、Object.hasOwnObject.prototype.hasOwnProperty.callの代替として使用することもできます。
// bad
console . log ( object . hasOwnProperty ( key ) ) ;
// good
console . log ( Object . prototype . hasOwnProperty . call ( object , key ) ) ;
// better
const has = Object . prototype . hasOwnProperty ; // cache the lookup once, in module scope.
console . log ( has . call ( object , key ) ) ;
// best
console . log ( Object . hasOwn ( object , key ) ) ; // only supported in browsers that support ES2022
/* or */
import has from 'has' ; // https://www.npmjs.com/package/has
console . log ( has ( object , key ) ) ;
/* or */
console . log ( Object . hasOwn ( object , key ) ) ; // https://www.npmjs.com/package/object.hasown 3.8 浅いコピー オブジェクトには、 Object.assignよりもオブジェクト スプレッド構文を優先します。オブジェクト残りパラメータ構文を使用して、特定のプロパティが省略された新しいオブジェクトを取得します。 eslint: prefer-object-spread
// very bad
const original = { a : 1 , b : 2 } ;
const copy = Object . assign ( original , { c : 3 } ) ; // this mutates `original` ಠ_ಠ
delete copy . a ; // so does this
// bad
const original = { a : 1 , b : 2 } ;
const copy = Object . assign ( { } , original , { c : 3 } ) ; // copy => { a: 1, b: 2, c: 3 }
// good
const original = { a : 1 , b : 2 } ;
const copy = { ... original , c : 3 } ; // copy => { a: 1, b: 2, c: 3 }
const { a , ... noA } = copy ; // noA => { b: 2, c: 3 }⬆トップに戻る
4.1 配列の作成にはリテラル構文を使用します。 eslint: no-array-constructor
// bad
const items = new Array ( ) ;
// good
const items = [ ] ;4.2 配列に項目を追加するには、直接代入の代わりに Array#push を使用します。
const someStack = [ ] ;
// bad
someStack [ someStack . length ] = 'abracadabra' ;
// good
someStack . push ( 'abracadabra' ) ; 4.3 配列...を使用して配列をコピーします。
// bad
const len = items . length ;
const itemsCopy = [ ] ;
let i ;
for ( i = 0 ; i < len ; i += 1 ) {
itemsCopy [ i ] = items [ i ] ;
}
// good
const itemsCopy = [ ... items ] ; 4.4 反復可能なオブジェクトを配列に変換するには、 Array.fromの代わりに Spreads ...を使用します。
const foo = document . querySelectorAll ( '.foo' ) ;
// good
const nodes = Array . from ( foo ) ;
// best
const nodes = [ ... foo ] ; 4.5 配列のようなオブジェクトを配列に変換するには、 Array.fromを使用します。
const arrLike = { 0 : 'foo' , 1 : 'bar' , 2 : 'baz' , length : 3 } ;
// bad
const arr = Array . prototype . slice . call ( arrLike ) ;
// good
const arr = Array . from ( arrLike ) ; 4.6 反復可能オブジェクトのマッピングには、spread ...の代わりにArray.from使用します。これにより、中間配列の作成が回避されます。
// bad
const baz = [ ... foo ] . map ( bar ) ;
// good
const baz = Array . from ( foo , bar ) ; 4.7 配列メソッドのコールバックで return ステートメントを使用します。 8.2 に従って、関数本体が副作用のない式を返す単一のステートメントで構成されている場合は、return を省略しても問題ありません。 eslint: array-callback-return
// good
[ 1 , 2 , 3 ] . map ( ( x ) => {
const y = x + 1 ;
return x * y ;
} ) ;
// good
[ 1 , 2 , 3 ] . map ( ( x ) => x + 1 ) ;
// bad - no returned value means `acc` becomes undefined after the first iteration
[ [ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ] . reduce ( ( acc , item , index ) => {
const flatten = acc . concat ( item ) ;
} ) ;
// good
[ [ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ] . reduce ( ( acc , item , index ) => {
const flatten = acc . concat ( item ) ;
return flatten ;
} ) ;
// bad
inbox . filter ( ( msg ) => {
const { subject , author } = msg ;
if ( subject === 'Mockingbird' ) {
return author === 'Harper Lee' ;
} else {
return false ;
}
} ) ;
// good
inbox . filter ( ( msg ) => {
const { subject , author } = msg ;
if ( subject === 'Mockingbird' ) {
return author === 'Harper Lee' ;
}
return false ;
} ) ;4.8 配列に複数の行がある場合、配列括弧を開いた後、配列括弧を閉じる前に改行を使用する
// bad
const arr = [
[ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ,
] ;
const objectInArray = [ {
id : 1 ,
} , {
id : 2 ,
} ] ;
const numberInArray = [
1 , 2 ,
] ;
// good
const arr = [ [ 0 , 1 ] , [ 2 , 3 ] , [ 4 , 5 ] ] ;
const objectInArray = [
{
id : 1 ,
} ,
{
id : 2 ,
} ,
] ;
const numberInArray = [
1 ,
2 ,
] ;⬆トップに戻る
5.1 オブジェクトの複数のプロパティにアクセスして使用する場合は、オブジェクトの構造化を使用します。 eslint: prefer-destructuring
なぜ？分割すると、これらのプロパティの一時参照を作成したり、オブジェクトに繰り返しアクセスしたりする必要がなくなります。オブジェクトへのアクセスを繰り返すと、より反復的なコードが作成され、より多くの読み取りが必要となり、間違いが発生する可能性が高くなります。オブジェクトを分割すると、何が使用されているかを判断するためにブロック全体を読み取る必要がなく、ブロック内で使用されるオブジェクト構造を定義する単一のサイトも提供されます。
// bad
function getFullName ( user ) {
const firstName = user . firstName ;
const lastName = user . lastName ;
return ` ${ firstName } ${ lastName } ` ;
}
// good
function getFullName ( user ) {
const { firstName , lastName } = user ;
return ` ${ firstName } ${ lastName } ` ;
}
// best
function getFullName ( { firstName , lastName } ) {
return ` ${ firstName } ${ lastName } ` ;
} 5.2 配列の分割を使用する。 eslint: prefer-destructuring
const arr = [ 1 , 2 , 3 , 4 ] ;
// bad
const first = arr [ 0 ] ;
const second = arr [ 1 ] ;
// good
const [ first , second ] = arr ;5.3 複数の戻り値には、配列の構造化ではなく、オブジェクトの構造化を使用します。
なぜ？呼び出しサイトを中断することなく、時間の経過とともに新しいプロパティを追加したり、順序を変更したりできます。
// 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 , top } = processInput ( input ) ;⬆トップに戻る
6.1 文字列には一重引用符''を使用します。エスリント: quotes
// bad
const name = "Capt. Janeway" ;
// bad - template literals should contain interpolation or newlines
const name = `Capt. Janeway` ;
// good
const name = 'Capt. Janeway' ;6.2 1 行が 100 文字を超える文字列は、文字列連結を使用して複数行にまたがって記述しないでください。
なぜ？文字列が壊れると操作が難しくなり、コードが検索しにくくなります。
// 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.3 プログラムで文字列を構築する場合は、連結の代わりにテンプレート文字列を使用します。 eslint： prefer-template template-curly-spacing
なぜ？テンプレート文字列を使用すると、適切な改行と文字列補間機能を備えた、読みやすく簡潔な構文が得られます。
// bad
function sayHi ( name ) {
return 'How are you, ' + name + '?' ;
}
// bad
function sayHi ( name ) {
return [ 'How are you, ' , name , '?' ] . join ( ) ;
}
// bad
function sayHi ( name ) {
return `How are you, ${ name } ?` ;
}
// good
function sayHi ( name ) {
return `How are you, ${ name } ?` ;
}eval()決して使用しないでください。それはあまりにも多くの脆弱性を生み出します。 eslint: no-eval 6.5 文字列内の文字を不必要にエスケープしないでください。 eslint: no-useless-escape
なぜ？バックスラッシュ
