Add "format" rule category (#2832)

palantir · Feb 23, 2019 · e9b8877 · e9b8877
1 parent 9000479
commit e9b8877
Show file tree

Hide file tree

Showing 21 changed files with 26 additions and 20 deletions.
diff --git a/docs/rules/index.md b/docs/rules/index.md
@@ -31,3 +31,9 @@ _These rules make code maintenance easier_:
 _These rules enforce consistent style across your codebase_:
 
 {% include rule_list.html ruleType="style" %}
+
+### Format
+
+_These rules enforce consistent use of whitespace and punctuation_:
+
+{% include rule_list.html ruleType="format" %}
diff --git a/src/language/rule/rule.ts b/src/language/rule/rule.ts
@@ -96,7 +96,7 @@ export interface IRuleMetadata {
     codeExamples?: ICodeExample[];
 }
 
-export type RuleType = "functionality" | "maintainability" | "style" | "typescript";
+export type RuleType = "functionality" | "maintainability" | "style" | "typescript" | "format";
 
 export type RuleSeverity = "warning" | "error" | "off";
 

diff --git a/src/rules/alignRule.ts b/src/rules/alignRule.ts
@@ -70,7 +70,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             maxLength: 5,
         },
         optionExamples: [[true, "parameters", "statements"]],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/arrowParensRule.ts b/src/rules/arrowParensRule.ts
@@ -41,7 +41,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             enum: [BAN_SINGLE_ARG_PARENS],
         },
         optionExamples: [true, [true, BAN_SINGLE_ARG_PARENS]],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/eoflineRule.ts b/src/rules/eoflineRule.ts
@@ -31,7 +31,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         options: null,
         optionExamples: [true],
         hasFix: true,
-        type: "maintainability",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/importSpacingRule.ts b/src/rules/importSpacingRule.ts
@@ -30,7 +30,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         optionsDescription: "Not configurable.",
         options: null,
         optionExamples: [true],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
 

diff --git a/src/rules/indentRule.ts b/src/rules/indentRule.ts
@@ -69,7 +69,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             [true, OPTION_USE_TABS, OPTION_INDENT_SIZE_2],
         ],
         hasFix: true,
-        type: "maintainability",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/jsdocFormatRule.ts b/src/rules/jsdocFormatRule.ts
@@ -51,7 +51,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             },
         },
         optionExamples: [true, [true, OPTION_CHECK_MULTILINE_START]],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/linebreakStyleRule.ts b/src/rules/linebreakStyleRule.ts
@@ -37,7 +37,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             enum: [OPTION_LINEBREAK_STYLE_LF, OPTION_LINEBREAK_STYLE_CRLF],
         },
         optionExamples: [[true, OPTION_LINEBREAK_STYLE_LF], [true, OPTION_LINEBREAK_STYLE_CRLF]],
-        type: "maintainability",
+        type: "format",
         typescriptOnly: false,
         hasFix: true,
     };

diff --git a/src/rules/maxLineLengthRule.ts b/src/rules/maxLineLengthRule.ts
@@ -77,7 +77,7 @@ export class Rule extends Lint.Rules.AbstractRule {
                 },
             ],
         ],
-        type: "maintainability",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/newParensRule.ts b/src/rules/newParensRule.ts
@@ -28,7 +28,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         optionsDescription: "Not configurable.",
         options: null,
         optionExamples: [true],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/newlineBeforeReturnRule.ts b/src/rules/newlineBeforeReturnRule.ts
@@ -31,7 +31,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         optionsDescription: "Not configurable.",
         options: {},
         optionExamples: [true],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/noConsecutiveBlankLinesRule.ts b/src/rules/noConsecutiveBlankLinesRule.ts
@@ -44,7 +44,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             minimum: "1",
         },
         optionExamples: [true, [true, 2]],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/noIrregularWhitespaceRule.ts b/src/rules/noIrregularWhitespaceRule.ts
@@ -28,7 +28,7 @@ export class Rule extends Lint.Rules.AbstractRule {
         optionsDescription: "Not configurable.",
         options: null,
         optionExamples: [true],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/noTrailingWhitespaceRule.ts b/src/rules/noTrailingWhitespaceRule.ts
@@ -62,7 +62,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             },
         },
         optionExamples: [true, [true, OPTION_IGNORE_COMMENTS], [true, OPTION_IGNORE_JSDOC]],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/numberLiteralFormatRule.ts b/src/rules/numberLiteralFormatRule.ts
@@ -35,7 +35,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             Helps keep a consistent style with numeric literals.
             Non-standard literals are more difficult to scan through and can be a symptom of typos.
         `,
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/quotemarkRule.ts b/src/rules/quotemarkRule.ts
@@ -79,7 +79,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             [true, OPTION_SINGLE, OPTION_AVOID_ESCAPE, OPTION_AVOID_TEMPLATE],
             [true, OPTION_SINGLE, OPTION_JSX_DOUBLE],
         ],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/semicolonRule.ts b/src/rules/semicolonRule.ts
@@ -76,7 +76,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             [true, OPTION_ALWAYS, OPTION_IGNORE_INTERFACES],
             [true, OPTION_ALWAYS, OPTION_IGNORE_BOUND_CLASS_METHODS],
         ],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/trailingCommaRule.ts b/src/rules/trailingCommaRule.ts
@@ -128,7 +128,7 @@ export class Rule extends Lint.Rules.AbstractRule {
                 },
             ],
         ],
-        type: "maintainability",
+        type: "format",
         typescriptOnly: false,
     };
     /* tslint:enable:object-literal-sort-keys */

diff --git a/src/rules/typedefWhitespaceRule.ts b/src/rules/typedefWhitespaceRule.ts
@@ -90,7 +90,7 @@ export class Rule extends Lint.Rules.AbstractRule {
                 },
             ],
         ],
-        type: "typescript",
+        type: "format",
         typescriptOnly: true,
         hasFix: true,
     };

diff --git a/src/rules/whitespaceRule.ts b/src/rules/whitespaceRule.ts
@@ -75,7 +75,7 @@ export class Rule extends Lint.Rules.AbstractRule {
             maxLength: 11,
         },
         optionExamples: [[true, "check-branch", "check-operator", "check-typecast"]],
-        type: "style",
+        type: "format",
         typescriptOnly: false,
         hasFix: true,
     };