refactor(tsfmt): move unique operation to custom provider side

Author: vvakame

lib/index.ts

@@ -2,13 +2,13 @@
 
 import * as ts from "typescript";
 import formatter from "./formatter";
-import {createDefaultFormatCodeOptions, createDefaultAdditionalFormatCodeOptions} from "./utils";
+import {createDefaultFormatCodeOptions} from "./utils";
 
 import * as fs from "fs";
 
 import base from "./provider/base";
 import editorconfig from "./provider/editorconfig";
-import tslintjson from "./provider/tslintjson";
+import tslintjson, {postProcess as tslintPostProcess} from "./provider/tslintjson";
 
 export interface Options {
     dryRun?: boolean;
@@ -21,6 +21,10 @@ export interface Options {
     tsfmt: boolean;
 }
 
+export interface PostProcess {
+    (fileName: string, formattedCode: string, opts: Options, formatOptions: ts.FormatCodeOptions): string;
+}
+
 export interface ResultMap {
     [fileName: string]: Result;
 }
@@ -34,11 +38,6 @@ export interface Result {
     dest: string;
 }
 
-export interface AdditionalFormatOptions {
-    noConsecutiveBlankLines: boolean;
-    noTrailingWhitespace: boolean;
-}
-
 export function processFiles(files: string[], opts: Options): Promise<ResultMap> {
     "use strict";
 
@@ -89,16 +88,17 @@ export function processString(fileName: string, content: string, opts: Options):
     "use strict";
 
     let formatOptions = createDefaultFormatCodeOptions();
-    let additionalOptions = createDefaultAdditionalFormatCodeOptions();
     let optGenPromises: (ts.FormatCodeOptions | Promise<ts.FormatCodeOptions>)[] = [];
+    let postProcesses: PostProcess[] = [];
     if (opts.tsfmt) {
         optGenPromises.push(base(fileName, opts, formatOptions));
     }
     if (opts.editorconfig) {
         optGenPromises.push(editorconfig(fileName, opts, formatOptions));
     }
     if (opts.tslint) {
-        optGenPromises.push(tslintjson(fileName, opts, formatOptions, additionalOptions));
+        optGenPromises.push(tslintjson(fileName, opts, formatOptions));
+        postProcesses.push(tslintPostProcess);
     }
 
     return Promise
@@ -110,13 +110,9 @@ export function processString(fileName: string, content: string, opts: Options):
                 formattedCode += "\n";
             }
 
-            if (additionalOptions.noTrailingWhitespace) {
-                formattedCode = formattedCode.replace(/^\s+$/mg, "");
-            }
-
-            if (additionalOptions.noConsecutiveBlankLines) {
-                formattedCode = formattedCode.replace(/\n\n^$/mg, "");
-            }
+            postProcesses.forEach(postProcess => {
+                formattedCode = postProcess(fileName, formattedCode, opts, formatOptions) || formattedCode;
+            });
 
             // TODO replace newline code. NewLineCharacter params affect to only "new" newline. maybe.
             let message: string;

lib/provider/tslintjson.ts

@@ -5,7 +5,7 @@ import * as ts from "typescript";
 import * as path from "path";
 import * as fs from "fs";
 
-import {Options, AdditionalFormatOptions} from "../";
+import {Options} from "../";
 import {getConfigFileName} from "../utils";
 
 interface TslintSettings {
@@ -15,7 +15,6 @@ interface TslintSettings {
             1: string;
         };
         "no-consecutive-blank-lines": boolean,
-        "no-trailing-whitespace": boolean,
         whitespace: {
             0: boolean;
             1: string;
@@ -28,7 +27,11 @@ interface TslintSettings {
     };
 }
 
-export default function makeFormatCodeOptions(fileName: string, opts: Options, formatOptions: ts.FormatCodeOptions, additionalOptions: AdditionalFormatOptions): ts.FormatCodeOptions {
+export interface AdditionalFormatOptions {
+    noConsecutiveBlankLines: boolean;
+}
+
+export default function makeFormatCodeOptions(fileName: string, opts: Options, formatOptions: ts.FormatCodeOptions): ts.FormatCodeOptions {
     "use strict";
 
     let baseDir = opts.baseDir ? path.resolve(opts.baseDir) : path.dirname(path.resolve(fileName));
@@ -65,13 +68,39 @@ export default function makeFormatCodeOptions(fileName: string, opts: Options, f
         }
     }
 
+    return formatOptions;
+}
+
+export function postProcess(fileName: string, formattedCode: string, opts: Options, formatOptions: ts.FormatCodeOptions): string {
+    "use strict";
+
+    let baseDir = opts.baseDir ? path.resolve(opts.baseDir) : path.dirname(path.resolve(fileName));
+    let configFileName = getConfigFileName(baseDir, "tslint.json");
+    if (!configFileName) {
+        return formattedCode;
+    }
+
+    let config: TslintSettings = JSON.parse(<any>fs.readFileSync(configFileName, "utf-8"));
+    if (!config.rules) {
+        return formattedCode;
+    }
+
+    let additionalOptions = createDefaultAdditionalFormatCodeOptions();
     if (config.rules["no-consecutive-blank-lines"] === true) {
         additionalOptions.noConsecutiveBlankLines = true;
     }
 
-    if (config.rules["no-trailing-whitespace"] === true) {
-        additionalOptions.noTrailingWhitespace = true;
+    if (additionalOptions.noConsecutiveBlankLines) {
+        formattedCode = formattedCode.replace(/\n+^$/mg, "\n");
     }
 
-    return formatOptions;
+    return formattedCode;
+}
+
+function createDefaultAdditionalFormatCodeOptions(): AdditionalFormatOptions {
+    "use strict";
+
+    return {
+        noConsecutiveBlankLines: false
+    };
 }

lib/utils.ts

@@ -5,8 +5,6 @@ import * as ts from "typescript";
 import * as fs from "fs";
 import * as path from "path";
 
-import {AdditionalFormatOptions} from "./";
-
 export function createDefaultFormatCodeOptions(): ts.FormatCodeOptions {
     "use strict";
 
@@ -41,12 +39,3 @@ export function getConfigFileName(baseDir: string, configFileName: string): stri
 
     return getConfigFileName(path.resolve(baseDir, "../"), configFileName);
 }
-
-export function createDefaultAdditionalFormatCodeOptions(): AdditionalFormatOptions {
-    "use strict";
-
-    return {
-        noConsecutiveBlankLines: false,
-        noTrailingWhitespace: false
-    };
-}

test/expected/tslint/no-consecutive-blank-lines/main.json

@@ -0,0 +1,15 @@
+{
+  "IndentSize": 4,
+  "TabSize": 4,
+  "NewLineCharacter": "\r\n",
+  "ConvertTabsToSpaces": true,
+  "InsertSpaceAfterCommaDelimiter": true,
+  "InsertSpaceAfterSemicolonInForStatements": true,
+  "InsertSpaceBeforeAndAfterBinaryOperators": true,
+  "InsertSpaceAfterKeywordsInControlFlowStatements": true,
+  "InsertSpaceAfterFunctionKeywordForAnonymousFunctions": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
+  "PlaceOpenBraceOnNewLineForFunctions": false,
+  "PlaceOpenBraceOnNewLineForControlBlocks": false
+}

test/expected/tslint/no-consecutive-blank-lines/main.ts

@@ -0,0 +1,6 @@
+class Sample {
+
+    test() {
+        return "";
+    }
+}

test/expected/tslint/no-trailing-whitespace/main.json

@@ -0,0 +1,15 @@
+{
+  "IndentSize": 4,
+  "TabSize": 4,
+  "NewLineCharacter": "\r\n",
+  "ConvertTabsToSpaces": true,
+  "InsertSpaceAfterCommaDelimiter": true,
+  "InsertSpaceAfterSemicolonInForStatements": true,
+  "InsertSpaceBeforeAndAfterBinaryOperators": true,
+  "InsertSpaceAfterKeywordsInControlFlowStatements": true,
+  "InsertSpaceAfterFunctionKeywordForAnonymousFunctions": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
+  "PlaceOpenBraceOnNewLineForFunctions": false,
+  "PlaceOpenBraceOnNewLineForControlBlocks": false
+}

test/expected/tslint/no-trailing-whitespace/main.ts

@@ -0,0 +1,5 @@
+class Sample {
+    test() {
+        return "";
+    }
+}

test/fixture/tslint/no-consecutive-blank-lines/main.ts

@@ -0,0 +1,15 @@
+class Sample {
+
+
+
+
+	test() {
+		return "";      			
+	}
+}
+
+
+
+
+
+

test/fixture/tslint/no-consecutive-blank-lines/tslint.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "no-consecutive-blank-lines": true
+    }
+}

test/fixture/tslint/no-trailing-whitespace/main.ts

@@ -0,0 +1,5 @@
+class Sample {
+	test() {
+		return "";      			
+	}
+}

test/fixture/tslint/no-trailing-whitespace/tslint.json

@@ -0,0 +1,5 @@
+{
+    "rules": {
+        "no-trailing-whitespace": true
+    }
+}