eslint-config-pixta v0.5.1

eslint-config-pixta

This package provides PIXTA's .eslintrc as an extensible shared config.

Usage

1. Execute npm install --save-dev eslint-config-pixta eslint-plugin-import
2. Add "extends": "pixta" to your .eslintrc

Sample

{
  "env": {
    "browser": true
  },
  "extends": [
    "pixta"
  ],
  "globals": {
    "gon": true
  }
}

Rules

Our style guide is based on:

• ESLint Recommended
• Airbnb JavaScript Style Guide

Only differences from base rules are shown below.

未使用引数の先頭には_を付ける (no-unused-vars)

デフォルト設定では、未使用の引数の存在をそもそも許さない。 ピクスタでは、インターフェースを明示するために未使用引数の利用を許す。 ただし、その際には先頭に_を付与しなくてはならない。

• no-unused-vars: ["error", { "argsIgnorePattern": "^_" }]

// bad
function foo(x, y) {
    return x + 1;
}

// good
function foo(x, _y) {
    return x + 1;
}

プライベートメソッドの先頭には_を付ける (no-underscore-dangle)

JavaScript のオブジェクトのメソッドには public/private を定義できない。 プライベートメソッドだと明示するために、先頭には_を付けることとする。

• "no-underscore-dangle": ["error", { "allowAfterThis": true }]

// bad
class Foo {
  bar () { // bar は private メソッドを想定
    ..
  }
}

// good
class Foo {
  _bar () { // bar は private メソッドを想定
    ..
  }
}