Fixed newline handling

Arthur Ozga · Arthur Ozga · commit 9d26b4eb4178 · 2015-08-03T15:09:49.000-07:00
diff --git a/src/harness/fourslash.ts b/src/harness/fourslash.ts
@@ -1941,7 +1941,7 @@ module FourSlash {
             }
         }
 
-        public verifyDocCommentTemplate(expected: ts.TextInsertion) {
+        public verifyDocCommentTemplate(expected?: ts.TextInsertion) {
             const name = "verifyDocCommentTemplate";
             let actual = this.languageService.getDocCommentTemplateAtPosition(this.activeFile.fileName, this.currentCaretPosition);
 
@@ -1953,16 +1953,18 @@ module FourSlash {
                     this.raiseError(name + ' failed - expected no template but got {newText: \"' + actual.newText + '\" offsetInNewText: ' + actual.offsetInNewText + '}');
                 }
             }
-            if (expected !== undefined && actual === undefined) {
-                this.raiseError(name + ' failed - expected the template {newText: \"' + actual.newText + '\" offsetInNewText: ' + actual.offsetInNewText + '} but got nothing instead');
-            }
+            else {
+                if (actual === undefined) {
+                    this.raiseError(name + ' failed - expected the template {newText: \"' + actual.newText + '\" offsetInNewText: ' + actual.offsetInNewText + '} but got nothing instead');
+                }
 
-            if (actual.newText !== expected.newText) {
-                this.raiseError(name + ' failed - expected insertion:\n' + expected.newText + '\nactual insertion:\n' + actual.newText);
-            }
+                if (actual.newText !== expected.newText) {
+                    this.raiseError(name + ' failed - expected insertion:\n' + expected.newText + '\nactual insertion:\n' + actual.newText);
+                }
 
-            if (actual.offsetInNewText !== expected.offsetInNewText) {
-                this.raiseError(name + ' failed - expected offsetInNewText: ' + expected.offsetInNewText + ',\nactual offsetInNewText:' + actual.offsetInNewText);
+                if (actual.offsetInNewText !== expected.offsetInNewText) {
+                    this.raiseError(name + ' failed - expected offsetInNewText: ' + expected.offsetInNewText + ',\nactual offsetInNewText:' + actual.offsetInNewText);
+                }
             }
         }
 
diff --git a/src/services/services.ts b/src/services/services.ts
@@ -6838,7 +6838,7 @@ namespace ts {
 
             let indentationStr = sourceFile.text.substr(lineStart, posLineAndChar.character).match(/\s*/).toString();
 
-            const newLine = host.getNewLine();
+            const newLine = host.getNewLine ? host.getNewLine() : "\r\n";
 
             let docParams = parameters.map((p, index) =>
                 indentationStr + " * @param " + (p.name.kind === SyntaxKind.Identifier ? (<Identifier>p.name).text : "param" + index.toString()) + newLine);
@@ -6850,7 +6850,7 @@ namespace ts {
                 /* closing comment */               indentationStr + " */" +
                 /* newline if at decl start */      (tokenStart === position ? newLine + indentationStr : "");
             
-            let cursorOffset = /* "/**" */ 3 + /* newLine */ + newLine.length + indentationStr.length + /* " * " */ 3;
+            let cursorOffset = /* "/**" */ 3 + /* newLine */ newLine.length + indentationStr.length + /* " * " */ 3;
 
             return {newText: result, offsetInNewText: cursorOffset };
         }
diff --git a/tests/cases/fourslash/docCommentTemplateFunctionWithParameters.ts b/tests/cases/fourslash/docCommentTemplateFunctionWithParameters.ts
@@ -5,9 +5,9 @@
 ////    /*1*/
 ////        function foo(x: number, y: string): boolean {}
 
-const noIndentScaffolding = "/**\n * \n * @param x\n * @param y\n */";
-const oneIndentScaffolding = "/**\n     * \n     * @param x\n     * @param y\n     */";
-const noIndentOffset = 7;
+const noIndentScaffolding = "/**\r\n * \r\n * @param x\r\n * @param y\r\n */";
+const oneIndentScaffolding = "/**\r\n     * \r\n     * @param x\r\n     * @param y\r\n     */";
+const noIndentOffset = 8;
 const oneIndentOffset = noIndentOffset + 4;
 
 goTo.marker("0");
diff --git a/tests/cases/fourslash/docCommentTemplateIndentation.ts b/tests/cases/fourslash/docCommentTemplateIndentation.ts
@@ -5,10 +5,10 @@
 ////    /*1*/
 ////        /*2*/function foo() { }
 
-const noIndentEmptyScaffolding = "/**\n * \n */";
-const oneIndentEmptyScaffolding = "/**\n     * \n     */";
-const twoIndentEmptyScaffolding = "/**\n         * \n         */\n        ";
-const noIndentOffset = 7;
+const noIndentEmptyScaffolding = "/**\r\n * \r\n */";
+const oneIndentEmptyScaffolding = "/**\r\n     * \r\n     */";
+const twoIndentEmptyScaffolding = "/**\r\n         * \r\n         */\r\n        ";
+const noIndentOffset = 8;
 const oneIndentOffset = noIndentOffset + 4;
 const twoIndentOffset = oneIndentOffset + 4;
 
diff --git a/tests/cases/fourslash/fourslash.ts b/tests/cases/fourslash/fourslash.ts
@@ -378,9 +378,8 @@ module FourSlashInterface {
             FourSlash.currentTestState.verifyNoMatchingBracePosition(bracePosition);
         }
 
-        // Will fix in fourslash-referencing
         public DocCommentTemplate(expectedText: string, expectedOffset: number, empty?: boolean) {
-            FourSlash.currentTestState.verifyDocCommentTemplate(empty ? undefined : { newText: expectedText, cursorOffset: expectedOffset });
+            FourSlash.currentTestState.verifyDocCommentTemplate(empty ? undefined : { newText: expectedText, offsetInNewText: expectedOffset });
         }
 
         public noDocCommentTemplate() {

Original file line number	Diff line number	Diff line change
`@@ -1941,7 +1941,7 @@ module FourSlash {`
`1941`	`1941`	`}`
`1942`	`1942`	`}`
`1943`	`1943`
`1944`		`- public verifyDocCommentTemplate(expected: ts.TextInsertion) {`
	`1944`	`+ public verifyDocCommentTemplate(expected?: ts.TextInsertion) {`
`1945`	`1945`	`const name = "verifyDocCommentTemplate";`
`1946`	`1946`	`let actual = this.languageService.getDocCommentTemplateAtPosition(this.activeFile.fileName, this.currentCaretPosition);`
`1947`	`1947`
`@@ -1953,16 +1953,18 @@ module FourSlash {`
`1953`	`1953`	`this.raiseError(name + ' failed - expected no template but got {newText: \"' + actual.newText + '\" offsetInNewText: ' + actual.offsetInNewText + '}');`
`1954`	`1954`	`}`
`1955`	`1955`	`}`
`1956`		`- if (expected !== undefined && actual === undefined) {`
`1957`		`- this.raiseError(name + ' failed - expected the template {newText: \"' + actual.newText + '\" offsetInNewText: ' + actual.offsetInNewText + '} but got nothing instead');`
`1958`		`- }`
	`1956`	`+ else {`
	`1957`	`+ if (actual === undefined) {`
	`1958`	`+ this.raiseError(name + ' failed - expected the template {newText: \"' + actual.newText + '\" offsetInNewText: ' + actual.offsetInNewText + '} but got nothing instead');`
	`1959`	`+ }`
`1959`	`1960`
`1960`		`- if (actual.newText !== expected.newText) {`
`1961`		`- this.raiseError(name + ' failed - expected insertion:\n' + expected.newText + '\nactual insertion:\n' + actual.newText);`
`1962`		`- }`
	`1961`	`+ if (actual.newText !== expected.newText) {`
	`1962`	`+ this.raiseError(name + ' failed - expected insertion:\n' + expected.newText + '\nactual insertion:\n' + actual.newText);`
	`1963`	`+ }`
`1963`	`1964`
`1964`		`- if (actual.offsetInNewText !== expected.offsetInNewText) {`
`1965`		`- this.raiseError(name + ' failed - expected offsetInNewText: ' + expected.offsetInNewText + ',\nactual offsetInNewText:' + actual.offsetInNewText);`
	`1965`	`+ if (actual.offsetInNewText !== expected.offsetInNewText) {`
	`1966`	`+ this.raiseError(name + ' failed - expected offsetInNewText: ' + expected.offsetInNewText + ',\nactual offsetInNewText:' + actual.offsetInNewText);`
	`1967`	`+ }`
`1966`	`1968`	`}`
`1967`	`1969`	`}`
`1968`	`1970`
Original file line number	Diff line number	Diff line change
`@@ -378,9 +378,8 @@ module FourSlashInterface {`
`378`	`378`	`FourSlash.currentTestState.verifyNoMatchingBracePosition(bracePosition);`
`379`	`379`	`}`
`380`	`380`
`381`		`- // Will fix in fourslash-referencing`
`382`	`381`	`public DocCommentTemplate(expectedText: string, expectedOffset: number, empty?: boolean) {`
`383`		`- FourSlash.currentTestState.verifyDocCommentTemplate(empty ? undefined : { newText: expectedText, cursorOffset: expectedOffset });`
	`382`	`+ FourSlash.currentTestState.verifyDocCommentTemplate(empty ? undefined : { newText: expectedText, offsetInNewText: expectedOffset });`
`384`	`383`	`}`
`385`	`384`
`386`	`385`	`public noDocCommentTemplate() {`