AngularJSプロジェクトにおけるjscsスタイル設定

[HAKASHUN]

.jscs.json

{
  "disallowKeywords": ["with"],
  "disallowMixedSpacesAndTabs": true,
  "disallowMultipleLineStrings": true,
  "disallowNewlineBeforeBlockStatements": true,
  "disallowSpaceAfterObjectKeys": true,
  "disallowSpaceAfterPrefixUnaryOperators": ["!"],
  "disallowSpaceBeforeBinaryOperators": [","],
  "disallowSpacesInAnonymousFunctionExpression": {
    "beforeOpeningRoundBrace": true
  },
  "disallowSpacesInFunctionDeclaration": {
    "beforeOpeningRoundBrace": true
  },
  "disallowSpacesInNamedFunctionExpression": {
    "beforeOpeningRoundBrace": true
  },
  "disallowSpacesInsideParentheses": true,
  "disallowTrailingComma": true,
  "disallowTrailingWhitespace": true,
  "requireSpaceAfterKeywords": ["if", "else", "for", "while", "do", "switch", "return", "try", "catch"],
  "requireSpacesInFunction": {
    "beforeOpeningCurlyBrace": true
  },
  "validateParameterSeparator": ", "
}

.jscs.json.todo

{
  "requireCurlyBraces": ["if", "else", "for", "while", "do", "try", "catch"],
  "requireSpaceAfterBinaryOperators": ["?", ":", "+", "-", "/", "*", "%", "==", "===", "!=", "!==", ">", ">=", "<", "<=", "&&", "||"],
  "requireSpaceBeforeBinaryOperators": ["?", ":", "+", "-", "/", "*", "%", "==", "===", "!=", "!==", ">", ">=", "<", "<=", "&&", "||"],
  "disallowImplicitTypeConversion": ["string"],
  "disallowMultipleLineBreaks": true,
  "disallowKeywordsOnNewLine": ["else"],
  "requireLineFeedAtFileEnd": true,
  "validateJSDoc": {
    "checkParamNames": true,
    "requireParamTypes": true
  }
}

[HAKASHUN]

"disallowKeywords": ["with"]

• with文を使ってはいけない

// ダメ
with (x) {
   prop++;
}

[HAKASHUN]

"disallowMixedSpacesAndTabs": true

• spaceとtabを混在してはいけない
• spaceを使うこと

[HAKASHUN]

"disallowMultipleLineStrings": true

• 文字列を複数行で書かない

// ダメ
var x = "multi \
       line";

// オッケー
var x = "multi" +
       "line";
var y = "single line";

[HAKASHUN]

"disallowNewlineBeforeBlockStatements": true

• {}ブロックにおいて、{が行の先頭にくるように記述しない

ダメ

function bad()
{
    var obj =
    {
        val: true
    };

    return {
        data: obj
    };
}

if (cond)
{
    foo();
}

for (var e in elements)
{
    bar(e);
}

while (cond)
{
    foo();
}

オッケー

function good(){
    var obj = {
        val: true
    };

    return {
        data: obj
    };
}

if (cond){
    foo();
}

for (var e in elements){
    bar(e);
}

while (cond){
    foo();
}

[HAKASHUN]

"disallowSpaceAfterObjectKeys": true

• オブジェクト定義において、key名の後はスペースをいれれはいけない

// ダメ
var x = {a : 1};

// オッケー
var x = {a: 1};

[HAKASHUN]

"disallowSpaceAfterPrefixUnaryOperators": ["!"]

• オペレータ!を用いるときは、その後ろにスペースを入れてはならない

// ダメ
x = ! y;

//オッケー
x = !y;

[HAKASHUN]

"disallowSpaceBeforeBinaryOperators": [","]

• 配列やオブジェクトなど、,を用いる際は、その前にスペースがあってはならない

// ダメ
var hoge = [1 , 2 , 3];
// オッケー
var hoge = [1, 2, 3];

[HAKASHUN]

"disallowSpacesInAnonymousFunctionExpression": { "beforeOpeningRoundBrace": true }

• 無名関数の定義の際に、functionに続く(の前にスペースを入れてはいけない

// ダメ
function () {}

// オッケー
function() {}

[HAKASHUN]

"disallowSpacesInFunctionDeclaration": { "beforeOpeningRoundBrace": true }

• 関数定義の際に、functionに続く(の前にスペースを入れてはいけない

// ダメ
function () {}

// オッケー
function() {}

[HAKASHUN]

"disallowSpacesInNamedFunctionExpression": { "beforeOpeningRoundBrace": true }

• 名前つき関数定義の際に、functionに続く(の前にスペースを入れてはいけない

// ダメ
function a () {}

// オッケー
function a() {}

[HAKASHUN]

"disallowSpacesInsideParentheses": true

• (を用いる際に、その後ろにスペースを入れてはいけない
• )を用いる際に、その前にスペースを入れてはいけない

// ダメ
var x = ( 1 + 2 ) * 3;

// オッケー
var x = (1 + 2) * 3;

[HAKASHUN]

"disallowTrailingComma": true

• 配列やオブジェクトの最後が,で終わってはいけない

// ダメ
var foo = [1, 2, 3, ];
var bar = {a: "a", b: "b", }

// オッケー
var foo = [1, 2, 3];
var bar = {a: "a", b: "b"}

[HAKASHUN]

"disallowTrailingWhitespace": true

• すべての行は、スペースで終わってはいけない

// ダメ
var foo = "blah blah"; //<-- whitespace character here

// オッケー
var foo = "blah blah";

[HAKASHUN]

"requireSpaceAfterKeywords"

• 以下を用いる際は、そのキーワードの後ろに必ずスペースを入れなくてはならない

"if", "else", "for", "while", "do", "switch", "return", "try", "catch"

// ダメ
if(x) {
  x++;
}

//オッケー
if (x) {
  x++;
}

// ダメ
return0;

// オッケー
return 0;

[HAKASHUN]

"requireSpacesInFunction": { "beforeOpeningCurlyBrace": true }

• function定義の際に、{の前には必ずスペースを入れなくてはならない

// ダメ
function a(){}

//オッケー
function a() {}

[HAKASHUN]

"validateParameterSeparator": ", "

• functionの引数定義の際には、引数同士を", "でつながなくてはいけない

// ダメ
function a(b , c) {}
function a(b,c) {}

// オッケー
function a(b, c) {}

[HAKASHUN]

"requireCurlyBraces": ["if", "else", "for", "while", "do", "try", "catch"]

• 以下を用いる際は、必ず{}を使わなければならない

"if", "else", "for", "while", "do", "try", "catch"

• {}を省略した書き方はしてはならない

// ダメ
if (x) x++;

// オッケー
if (x) {
   x++;
}

[HAKASHUN]

requireSpaceAfterBinaryOperators, requireSpaceBeforeBinaryOperators

• 以下のオペレータを用いるときは、その前後にスペースを入れなくてはならない

"?", ":", "+", "-", "/", "*", "%", "==", "===", "!=", "!==", ">", ">=", "<", "<=", "&&", "||"

// ダメ
x +y;
x+y;

// オッケー
x + y;

[HAKASHUN]

"disallowImplicitTypeConversion": ["string"]

• string型への暗黙の型変換を禁止する

// ダメ
x = '' + y;

// オッケー
x = String(y);

[HAKASHUN]

"disallowMultipleLineBreaks": true

• 空行が2行以上連続してはいけない

ダメ

var x = 1;

x++;

オッケー

var x = 1;

x++;

[HAKASHUN]

"disallowKeywordsOnNewLine": ["else"]

• elseから行がはじまってはならない

// ダメ
if (x < 0) {
    x++;
}
else {
    x--;
}

// オッケー
if (x < 0) {
    x++;
} else {
    x--;
}

[HAKASHUN]

"requireLineFeedAtFileEnd": true

• ファイル末尾には改行を置かなければならない

[HAKASHUN]

"validateJSDoc": { "checkParamNames": true, "requireParamTypes": true }

• この機能は現在はjscsにはありません
• JSCS-JSDocというプラグインに移行したそうです。

checkParamNames

• jsdocにおける@paramにて、そのparam名の明記を徹底すること

requireParamTypes

• jsdocにおける@paramにて、そのparamTypeの明記を徹底すること

[HAKASHUN]

11月に更新されていました

https://github.com/angular/angular.js/commits/master/.jscs.json

jscs定義が更新されていたので差分をまとめます。

[HAKASHUN]

追加されたルール

"disallowSpaceAfterPrefixUnaryOperators"

後ろにスペースを入れてはならないオペレータが増えました

Before

"disallowSpaceAfterPrefixUnaryOperators": ["!"]

After

"disallowSpaceAfterPrefixUnaryOperators": ["++", "--", "+", "-", "~", "!"]

"disallowSpaceBeforePostfixUnaryOperators": ["++", "--"],

新しく追加された定義です。

++と--を変数の後ろに定義する際は、変数との間にスペースを入れては行けません。

// ダメ
x = y ++; y = z --;

// オッケー
x = y++; y = z--;

"disallowSpacesInsideArrayBrackets": true

// ダメ
var x = [ [ 1 ] ];

// オッケー
var x = [[1]];

"requireCommaBeforeLineBreak": true

オブジェクトを定義する際は、プロパティ定義の末尾にカンマをつけなくてはいけません。

// ダメ
var x = {
    one: 1
    , two: 2
};

// オッケー
var x = {
    one: 1,
    two: 2
};
var y = { three: 3, four: 4};

"requireSpaceBeforeBlockStatements": true

制御フローのためのブロック文定義の際には、{の目に半角スペースをいれなければなりません

// ダメ
if (cond){
    foo();
}

for (var e in elements){
    bar(e);
}

while (cond){
    foo();
}

// オッケー
if (cond) {
    foo();
}

for (var e in elements) {
    bar(e);
}

while (cond) {
    foo();
}

"requireSpacesInConditionalExpression"

三項演算子を定義する際に用いる、?と:の残後には必ず半角スペースをいれなければなりません。

// ダメ
var a = b? c : d;
var a = b ?c : d;
var a = b ? c: d;
var a = b ? c :d;

// オッケー
var a = b ? c : d;
var a= b ? c : d;

"validateLineBreaks": "LF"

改行を意味するコードはLFでなくてはなりません。

// ダメ
var x = 1;<CRLF>
x++;

// オッケー
var x = 1;<LF>
x++;

[HAKASHUN]

削除されたルール

• "requireCurlyBraces": ["if", "else", "for", "while", "do", "try", "catch"]
• "disallowImplicitTypeConversion": ["string"]
• "disallowMultipleLineBreaks": true
• "disallowKeywordsOnNewLine": ["else"]