Make docComment template indent whitespace-only

Arthur Ozga · Arthur Ozga · commit b7d09ef0152d · 2017-03-08T12:41:20.000-08:00
diff --git a/src/harness/fourslash.ts b/src/harness/fourslash.ts
@@ -2248,22 +2248,23 @@ namespace FourSlash {
 
             if (expected === undefined) {
                 if (actual) {
-                    this.raiseError(name + " failed - expected no template but got {newText: \"" + actual.newText + "\" caretOffset: " + actual.caretOffset + "}");
+                    this.raiseError(`${name} failed - expected no template but got {newText: "${actual.newText}", caretOffset: ${actual.caretOffset}}`);
                 }
 
                 return;
             }
             else {
                 if (actual === undefined) {
-                    this.raiseError(name + " failed - expected the template {newText: \"" + actual.newText + "\" caretOffset: " + actual.caretOffset + "} but got nothing instead");
+                    this.raiseError(`${name} failed - expected the template {newText: "${expected.newText}", caretOffset: "${expected.caretOffset}"} but got nothing instead`);
+                    
                 }
 
                 if (actual.newText !== expected.newText) {
-                    this.raiseError(name + " failed - expected insertion:\n" + this.clarifyNewlines(expected.newText) + "\nactual insertion:\n" + this.clarifyNewlines(actual.newText));
+                    this.raiseError(`${name} failed - expected insertion:\n"${this.clarifyNewlines(expected.newText)}"\nactual insertion:\n"${this.clarifyNewlines(actual.newText)}"`);
                 }
 
                 if (actual.caretOffset !== expected.caretOffset) {
-                    this.raiseError(name + " failed - expected caretOffset: " + expected.caretOffset + ",\nactual caretOffset:" + actual.caretOffset);
+                    this.raiseError(`${name} failed - expected caretOffset: ${expected.caretOffset}\nactual caretOffset:${actual.caretOffset}`);
                 }
             }
         }
diff --git a/src/services/jsDoc.ts b/src/services/jsDoc.ts
@@ -178,7 +178,8 @@ namespace ts.JsDoc {
         const posLineAndChar = sourceFile.getLineAndCharacterOfPosition(position);
         const lineStart = sourceFile.getLineStarts()[posLineAndChar.line];
 
-        const indentationStr = sourceFile.text.substr(lineStart, posLineAndChar.character);
+        // replace non-whitespace characters in prefix with spaces.
+        const indentationStr = sourceFile.text.substr(lineStart, posLineAndChar.character).replace(/\S/i, () => " ");
         const isJavaScriptFile = hasJavaScriptFileExtension(sourceFile.fileName);
 
         let docParams = "";
diff --git a/tests/cases/fourslash/docCommentTemplateIndentation.ts b/tests/cases/fourslash/docCommentTemplateIndentation.ts
@@ -1,13 +1,13 @@
 /// <reference path='fourslash.ts' />
 
 // @Filename: indents.ts
-/////*0*/
+////    a   /*2*/
 ////    /*1*/
-////        /*2*/function foo() { }
+/////*0*/        function foo() { }
 
 const noIndentEmptyScaffolding = "/**\r\n * \r\n */";
 const oneIndentEmptyScaffolding = "/**\r\n     * \r\n     */";
-const twoIndentEmptyScaffolding = "/**\r\n         * \r\n         */\r\n        ";
+const twoIndentEmptyScaffolding = "/**\r\n         * \r\n         */";
 const noIndentOffset = 8;
 const oneIndentOffset = noIndentOffset + 4;
 const twoIndentOffset = oneIndentOffset + 4;
@@ -19,4 +19,4 @@ goTo.marker("1");
 verify.DocCommentTemplate(oneIndentEmptyScaffolding, oneIndentOffset);
 
 goTo.marker("2");
-verify.DocCommentTemplate(twoIndentEmptyScaffolding, twoIndentOffset);
+verify.DocCommentTemplate(twoIndentEmptyScaffolding, twoIndentOffset);

Original file line number	Diff line number	Diff line change
`@@ -2248,22 +2248,23 @@ namespace FourSlash {`
`2248`	`2248`
`2249`	`2249`	`if (expected === undefined) {`
`2250`	`2250`	`if (actual) {`
`2251`		`- this.raiseError(name + " failed - expected no template but got {newText: \"" + actual.newText + "\" caretOffset: " + actual.caretOffset + "}");`
	`2251`	+ this.raiseError(`${name} failed - expected no template but got {newText: "${actual.newText}", caretOffset: ${actual.caretOffset}}`);
`2252`	`2252`	`}`
`2253`	`2253`
`2254`	`2254`	`return;`
`2255`	`2255`	`}`
`2256`	`2256`	`else {`
`2257`	`2257`	`if (actual === undefined) {`
`2258`		`- this.raiseError(name + " failed - expected the template {newText: \"" + actual.newText + "\" caretOffset: " + actual.caretOffset + "} but got nothing instead");`
	`2258`	+ this.raiseError(`${name} failed - expected the template {newText: "${expected.newText}", caretOffset: "${expected.caretOffset}"} but got nothing instead`);
	`2259`	`+`
`2259`	`2260`	`}`
`2260`	`2261`
`2261`	`2262`	`if (actual.newText !== expected.newText) {`
`2262`		`- this.raiseError(name + " failed - expected insertion:\n" + this.clarifyNewlines(expected.newText) + "\nactual insertion:\n" + this.clarifyNewlines(actual.newText));`
	`2263`	+ this.raiseError(`${name} failed - expected insertion:\n"${this.clarifyNewlines(expected.newText)}"\nactual insertion:\n"${this.clarifyNewlines(actual.newText)}"`);
`2263`	`2264`	`}`
`2264`	`2265`
`2265`	`2266`	`if (actual.caretOffset !== expected.caretOffset) {`
`2266`		`- this.raiseError(name + " failed - expected caretOffset: " + expected.caretOffset + ",\nactual caretOffset:" + actual.caretOffset);`
	`2267`	+ this.raiseError(`${name} failed - expected caretOffset: ${expected.caretOffset}\nactual caretOffset:${actual.caretOffset}`);
`2267`	`2268`	`}`
`2268`	`2269`	`}`
`2269`	`2270`	`}`