feat(tsfmt): support comments in tsconfig.json & tsfmt.json & tslint.json

vvakame · vvakame · commit 5a4fdfd118b9 · 2016-08-12T21:13:43.000+09:00
diff --git a/lib/index.ts b/lib/index.ts
@@ -2,7 +2,9 @@
 
 import * as ts from "typescript";
 import formatter from "./formatter";
-import { createDefaultFormatCodeOptions } from "./utils";
+import { createDefaultFormatCodeOptions, parseJSON } from "./utils";
+
+export { parseJSON };
 
 import * as fs from "fs";
 
diff --git a/lib/provider/base.ts b/lib/provider/base.ts
@@ -6,7 +6,7 @@ import * as path from "path";
 import * as fs from "fs";
 
 import { Options } from "../";
-import { getConfigFileName } from "../utils";
+import { getConfigFileName, parseJSON } from "../utils";
 
 interface TsfmtSettings {
     // from FormatCodeOptions
@@ -51,7 +51,7 @@ export default function makeFormatCodeOptions(fileName: string, opts: Options, f
         console.log(`read ${configFileName} for ${fileName}`);
     }
 
-    let config: TsfmtSettings = JSON.parse(<any>fs.readFileSync(configFileName, "utf-8"));
+    let config: TsfmtSettings = parseJSON(fs.readFileSync(configFileName, "utf-8"));
     if (typeof config.insertSpaceAfterCommaDelimiter === "boolean") {
         formatOptions.InsertSpaceAfterCommaDelimiter = config.insertSpaceAfterCommaDelimiter;
     }
diff --git a/lib/provider/tsconfigjson.ts b/lib/provider/tsconfigjson.ts
@@ -6,7 +6,7 @@ import * as path from "path";
 import * as fs from "fs";
 
 import { Options } from "../";
-import { getConfigFileName } from "../utils";
+import { getConfigFileName, parseJSON } from "../utils";
 
 interface TsconfigSettings {
     compilerOptions: {
@@ -26,7 +26,7 @@ export default function makeFormatCodeOptions(fileName: string, opts: Options, f
         console.log(`read ${configFileName} for ${fileName}`);
     }
 
-    let config: TsconfigSettings = JSON.parse(<any>fs.readFileSync(configFileName, "utf-8"));
+    let config: TsconfigSettings = parseJSON(fs.readFileSync(configFileName, "utf-8"));
     if (!config.compilerOptions || !config.compilerOptions.newLine) {
         return formatOptions;
     }
diff --git a/lib/provider/tslintjson.ts b/lib/provider/tslintjson.ts
@@ -6,7 +6,7 @@ import * as path from "path";
 import * as fs from "fs";
 
 import { Options } from "../";
-import { getConfigFileName } from "../utils";
+import { getConfigFileName, parseJSON } from "../utils";
 
 interface TslintSettings {
     rules: {
@@ -43,7 +43,7 @@ export default function makeFormatCodeOptions(fileName: string, opts: Options, f
         console.log(`read ${configFileName} for ${fileName}`);
     }
 
-    let config: TslintSettings = JSON.parse(<any>fs.readFileSync(configFileName, "utf-8"));
+    let config: TslintSettings = parseJSON(fs.readFileSync(configFileName, "utf-8"));
     if (!config.rules) {
         return formatOptions;
     }
@@ -84,7 +84,7 @@ export function postProcess(fileName: string, formattedCode: string, opts: Optio
         return formattedCode;
     }
 
-    let config: TslintSettings = JSON.parse(<any>fs.readFileSync(configFileName, "utf-8"));
+    let config: TslintSettings = parseJSON(fs.readFileSync(configFileName, "utf-8"));
     if (!config.rules) {
         return formattedCode;
     }
diff --git a/lib/utils.ts b/lib/utils.ts
@@ -55,7 +55,7 @@ export function readFilesFromTsconfig(configPath: string): string[] {
     }
 
     let tsconfigDir = path.dirname(configPath);
-    let tsconfig: TsConfigJSON = JSON.parse(fs.readFileSync(configPath, "utf-8"));
+    let tsconfig: TsConfigJSON = parseJSON(fs.readFileSync(configPath, "utf-8"));
     if (tsconfig.files) {
         let files: string[] = tsconfig.files;
         return files.map(filePath => path.resolve(tsconfigDir, filePath));
@@ -99,3 +99,12 @@ export function readFilesFromTsconfig(configPath: string): string[] {
         });
     }
 }
+
+export function parseJSON(jsonText: string): any {
+    let result = ts.parseConfigFileTextToJson("tmp.json", jsonText);
+    if (result.error) {
+        throw new Error("JSON parse error");
+    }
+
+    return result.config;
+}
diff --git a/test/expected/tsconfig/a/main.json b/test/expected/tsconfig/a/main.json
@@ -0,0 +1,17 @@
+{
+  "IndentSize": 4,
+  "TabSize": 4,
+  "IndentStyle": 2,
+  "NewLineCharacter": "\r\n",
+  "ConvertTabsToSpaces": true,
+  "InsertSpaceAfterCommaDelimiter": true,
+  "InsertSpaceAfterSemicolonInForStatements": true,
+  "InsertSpaceBeforeAndAfterBinaryOperators": true,
+  "InsertSpaceAfterKeywordsInControlFlowStatements": true,
+  "InsertSpaceAfterFunctionKeywordForAnonymousFunctions": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces": false,
+  "PlaceOpenBraceOnNewLineForFunctions": false,
+  "PlaceOpenBraceOnNewLineForControlBlocks": false
+}
diff --git a/test/expected/tsconfig/a/main.ts b/test/expected/tsconfig/a/main.ts
@@ -0,0 +1,6 @@
+class Sample {
+    hello(word: string = "world"): string { return "Hello, " + word; }
+}
+
+var s: Sample = new Sample();
+if (s === s) { console.log(s.hello()); }
diff --git a/test/expected/tsfmt/e/main.json b/test/expected/tsfmt/e/main.json
@@ -0,0 +1,17 @@
+{
+  "IndentSize": 4,
+  "TabSize": 4,
+  "IndentStyle": 2,
+  "NewLineCharacter": "\r\n",
+  "ConvertTabsToSpaces": true,
+  "InsertSpaceAfterCommaDelimiter": true,
+  "InsertSpaceAfterSemicolonInForStatements": true,
+  "InsertSpaceBeforeAndAfterBinaryOperators": true,
+  "InsertSpaceAfterKeywordsInControlFlowStatements": true,
+  "InsertSpaceAfterFunctionKeywordForAnonymousFunctions": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces": false,
+  "PlaceOpenBraceOnNewLineForFunctions": false,
+  "PlaceOpenBraceOnNewLineForControlBlocks": false
+}
diff --git a/test/expected/tsfmt/e/main.ts b/test/expected/tsfmt/e/main.ts
@@ -0,0 +1,3 @@
+function hello(name: string) {
+    let str = `Hi! ${name}`;
+}
diff --git a/test/expected/tslint/b/main.json b/test/expected/tslint/b/main.json
@@ -0,0 +1,17 @@
+{
+  "IndentSize": 4,
+  "TabSize": 4,
+  "IndentStyle": 2,
+  "NewLineCharacter": "\r\n",
+  "ConvertTabsToSpaces": true,
+  "InsertSpaceAfterCommaDelimiter": true,
+  "InsertSpaceAfterSemicolonInForStatements": true,
+  "InsertSpaceBeforeAndAfterBinaryOperators": true,
+  "InsertSpaceAfterKeywordsInControlFlowStatements": true,
+  "InsertSpaceAfterFunctionKeywordForAnonymousFunctions": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
+  "InsertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces": false,
+  "PlaceOpenBraceOnNewLineForFunctions": false,
+  "PlaceOpenBraceOnNewLineForControlBlocks": false
+}
diff --git a/test/expected/tslint/b/main.ts b/test/expected/tslint/b/main.ts
@@ -0,0 +1,6 @@
+class Sample {
+    hello(word: string = "world"): string { return "Hello, " + word; }
+}
+
+var s: Sample = new Sample();
+if (s === s) { console.log(s.hello()); }
diff --git a/test/fixture/tsconfig/a/main.ts b/test/fixture/tsconfig/a/main.ts
@@ -0,0 +1,6 @@
+class Sample {
+hello(word:string="world"):string{return "Hello, " + word;}
+}
+
+var s:Sample=new Sample();
+if(s===s){console.log(s.hello());}
diff --git a/test/fixture/tsconfig/a/tsconfig.json b/test/fixture/tsconfig/a/tsconfig.json
@@ -0,0 +1,4 @@
+{
+    // comment
+    /* comment */
+}
diff --git a/test/fixture/tsfmt/e/main.ts b/test/fixture/tsfmt/e/main.ts
@@ -0,0 +1,3 @@
+function hello(name: string) {
+    let str = `Hi! ${name}`;
+}
diff --git a/test/fixture/tsfmt/e/tsfmt.json b/test/fixture/tsfmt/e/tsfmt.json
@@ -0,0 +1,4 @@
+{
+    // comment
+    /* comment */
+}
diff --git a/test/fixture/tslint/b/main.ts b/test/fixture/tslint/b/main.ts
@@ -0,0 +1,6 @@
+class Sample {
+hello(word:string="world"):string{return "Hello, " + word;}
+}
+
+var s:Sample=new Sample();
+if(s===s){console.log(s.hello());}
diff --git a/test/fixture/tslint/b/tslint.json b/test/fixture/tslint/b/tslint.json
@@ -0,0 +1,85 @@
+{
+    // comment
+    /* comment */
+    "rules": {
+        "ban": [true,
+            ["_", "extend"],
+            ["_", "isNull"],
+            ["_", "isDefined"]
+        ],
+        "class-name": true,
+        "comment-format": [true,
+            "check-space",
+            "check-lowercase"
+        ],
+        "curly": true,
+        "eofline": true,
+        "forin": true,
+        "indent": [true, 4],
+        "interface-name": true,
+        "jsdoc-format": true,
+        "label-position": true,
+        "label-undefined": true,
+        "max-line-length": [true, 140],
+        "no-arg": true,
+        "no-bitwise": true,
+        "no-console": [true,
+            "debug",
+            "info",
+            "time",
+            "timeEnd",
+            "trace"
+        ],
+        "no-construct": true,
+        "no-debugger": true,
+        "no-duplicate-key": true,
+        "no-duplicate-variable": true,
+        "no-empty": true,
+        "no-eval": true,
+        "no-string-literal": true,
+        "trailing-comma": [true, {
+            "singleline": "never",
+            "multiline": "always"
+        }],
+        "no-trailing-whitespace": true,
+        "no-unused-expression": true,
+        "no-unused-variable": true,
+        "no-unreachable": true,
+        "no-use-before-declare": true,
+        "one-line": [true,
+            "check-open-brace",
+            "check-catch",
+            "check-else",
+            "check-whitespace"
+        ],
+        "quotemark": [true, "double"],
+        "radix": true,
+        "semicolon": true,
+        "triple-equals": [true, "allow-null-check"],
+        "typedef": [true,
+            "callSignature",
+            "catchClause",
+            "indexSignature",
+            "parameter",
+            "propertySignature",
+            "variableDeclarator"
+        ],
+        "typedef-whitespace": [true,
+            ["callSignature", "noSpace"],
+            ["catchClause", "noSpace"],
+            ["indexSignature", "space"]
+        ],
+        "use-strict": [true,
+            "check-module",
+            "check-function"
+        ],
+        "variable-name": false,
+        "whitespace": [true,
+            "check-branch",
+            "check-decl",
+            "check-operator",
+            "check-separator",
+            "check-type"
+        ]
+    }
+}
diff --git a/test/indexSpec.ts b/test/indexSpec.ts
@@ -7,7 +7,7 @@ import path = require("path");
 import childProcess = require("child_process");
 import stream = require("stream");
 
-import lib = require("../lib/index");
+import lib = require("../lib/");
 
 function collectFileName(dirName: string): string[] {
     let fileName: string[] = [];
@@ -138,7 +138,7 @@ describe("tsfmt test", () => {
                                 fs.writeFileSync(expectedOptionsFileName, JSON.stringify(result.options, null, 2));
                             }
 
-                            let expectedOptions = JSON.parse(fs.readFileSync(expectedOptionsFileName, "utf-8"));
+                            let expectedOptions = lib.parseJSON(fs.readFileSync(expectedOptionsFileName, "utf-8"));
                             assert.deepEqual(expectedOptions, result.options);
 
                             let tslintConfigName = path.dirname(fileName) + "/tslint.json";

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import * as path from "path";`
`6`	`6`	`import * as fs from "fs";`
`7`	`7`
`8`	`8`	`import { Options } from "../";`
`9`		`-import { getConfigFileName } from "../utils";`
	`9`	`+import { getConfigFileName, parseJSON } from "../utils";`
`10`	`10`
`11`	`11`	`interface TsfmtSettings {`
`12`	`12`	`// from FormatCodeOptions`
`@@ -51,7 +51,7 @@ export default function makeFormatCodeOptions(fileName: string, opts: Options, f`
`51`	`51`	console.log(`read ${configFileName} for ${fileName}`);
`52`	`52`	`}`
`53`	`53`
`54`		`- let config: TsfmtSettings = JSON.parse(<any>fs.readFileSync(configFileName, "utf-8"));`
	`54`	`+ let config: TsfmtSettings = parseJSON(fs.readFileSync(configFileName, "utf-8"));`
`55`	`55`	`if (typeof config.insertSpaceAfterCommaDelimiter === "boolean") {`
`56`	`56`	`formatOptions.InsertSpaceAfterCommaDelimiter = config.insertSpaceAfterCommaDelimiter;`
`57`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+function hello(name: string) {`
	`2`	+ let str = `Hi! ${name}`;
	`3`	`+}`