maxmustermann/TypeScript
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Remove trailing whitespace from JSDoc comments

Browse source
This commit is contained in:
Tim Schaub 2018-07-27 17:28:49 -06:00
parent 25fb5419c0
commit 960800d1fe
20 changed files with 71 additions and 64 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/compiler/parser.ts
View file

@ -6400,7 +6400,7 @@ namespace ts {
switch (token()) {
case SyntaxKind.AtToken:
if (state === JSDocState.BeginningOfLine || state === JSDocState.SawAsterisk) {
removeTrailingNewlines(comments);
removeTrailingWhitespace(comments);
addTag(parseTag(indent));
// NOTE: According to usejsdoc.org, a tag goes to end of line, except the last tag.
// Real-world comments may break this rule, so "BeginningOfLine" will not be a real line beginning
@ -6460,7 +6460,7 @@ namespace ts {
nextJSDocToken();
}
removeLeadingNewlines(comments);
removeTrailingNewlines(comments);
removeTrailingWhitespace(comments);
return createJSDocComment();
});
@ -6470,8 +6470,8 @@ namespace ts {
}
}
function removeTrailingNewlines(comments: string[]) {
while (comments.length && (comments[comments.length - 1] === "\n" || comments[comments.length - 1] === "\r")) {
function removeTrailingWhitespace(comments: string[]) {
while (comments.length && comments[comments.length - 1].trim() === "") {
comments.pop();
}
}
@ -6632,7 +6632,7 @@ namespace ts {
}
removeLeadingNewlines(comments);
removeTrailingNewlines(comments);
removeTrailingWhitespace(comments);
return comments.length === 0 ? undefined : comments.join("");
}

2
tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.asteriskAfterPreamble.json
View file

@ -2,5 +2,5 @@
"kind": "JSDocComment",
"pos": 0,
"end": 23,
"comment": "* @type {number} "
"comment": "* @type {number}"
}

2
tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.threeAsterisks.json
View file

@ -2,5 +2,5 @@
"kind": "JSDocComment",
"pos": 0,
"end": 7,
"comment": "* "
"comment": "*"
}

42
tests/cases/fourslash/commentsCommentParsing.ts
View file

@ -208,8 +208,8 @@ verify.quickInfoAt("1q", "function simple(): void");
verify.signatureHelp({ marker: "2", docComment: "" });
verify.quickInfoAt("2q", "function multiLine(): void");
verify.signatureHelp({ marker: "3", docComment: "this is eg of single line jsdoc style comment " });
verify.quickInfoAt("3q", "function jsDocSingleLine(): void", "this is eg of single line jsdoc style comment ");
verify.signatureHelp({ marker: "3", docComment: "this is eg of single line jsdoc style comment" });
verify.quickInfoAt("3q", "function jsDocSingleLine(): void", "this is eg of single line jsdoc style comment");
verify.signatureHelp({ marker: "4", docComment: "this is multiple line jsdoc stule comment\nNew line1\nNew Line2" });
verify.quickInfoAt("4q", "function jsDocMultiLine(): void", "this is multiple line jsdoc stule comment\nNew line1\nNew Line2");
@ -217,23 +217,23 @@ verify.quickInfoAt("4q", "function jsDocMultiLine(): void", "this is multiple li
verify.signatureHelp({ marker: "5", docComment: "this is multiple line jsdoc stule comment\nNew line1\nNew Line2\nShoul mege this line as well\nand this too\nAnother this one too" });
verify.quickInfoAt("5q", "function jsDocMultiLineMerge(): void", "this is multiple line jsdoc stule comment\nNew line1\nNew Line2\nShoul mege this line as well\nand this too\nAnother this one too");
verify.signatureHelp({ marker: "6", docComment: "jsdoc comment " });
verify.quickInfoAt("6q", "function jsDocMixedComments1(): void", "jsdoc comment ");
verify.signatureHelp({ marker: "6", docComment: "jsdoc comment" });
verify.quickInfoAt("6q", "function jsDocMixedComments1(): void", "jsdoc comment");
verify.signatureHelp({ marker: "7", docComment: "jsdoc comment \nanother jsDocComment" });
verify.quickInfoAt("7q", "function jsDocMixedComments2(): void", "jsdoc comment \nanother jsDocComment");
verify.signatureHelp({ marker: "7", docComment: "jsdoc comment\nanother jsDocComment" });
verify.quickInfoAt("7q", "function jsDocMixedComments2(): void", "jsdoc comment\nanother jsDocComment");
verify.signatureHelp({ marker: "8", docComment: "jsdoc comment \n* triplestar jsDocComment" });
verify.quickInfoAt("8q", "function jsDocMixedComments3(): void", "jsdoc comment \n* triplestar jsDocComment");
verify.signatureHelp({ marker: "8", docComment: "jsdoc comment\n* triplestar jsDocComment" });
verify.quickInfoAt("8q", "function jsDocMixedComments3(): void", "jsdoc comment\n* triplestar jsDocComment");
verify.signatureHelp({ marker: "9", docComment: "jsdoc comment \nanother jsDocComment" });
verify.quickInfoAt("9q", "function jsDocMixedComments4(): void", "jsdoc comment \nanother jsDocComment");
verify.signatureHelp({ marker: "9", docComment: "jsdoc comment\nanother jsDocComment" });
verify.quickInfoAt("9q", "function jsDocMixedComments4(): void", "jsdoc comment\nanother jsDocComment");
verify.signatureHelp({ marker: "10", docComment: "jsdoc comment \nanother jsDocComment" });
verify.quickInfoAt("10q", "function jsDocMixedComments5(): void", "jsdoc comment \nanother jsDocComment");
verify.signatureHelp({ marker: "10", docComment: "jsdoc comment\nanother jsDocComment" });
verify.quickInfoAt("10q", "function jsDocMixedComments5(): void", "jsdoc comment\nanother jsDocComment");
verify.signatureHelp({ marker: "11", docComment: "another jsDocComment\njsdoc comment " });
verify.quickInfoAt("11q", "function jsDocMixedComments6(): void", "another jsDocComment\njsdoc comment ");
verify.signatureHelp({ marker: "11", docComment: "another jsDocComment\njsdoc comment" });
verify.quickInfoAt("11q", "function jsDocMixedComments6(): void", "another jsDocComment\njsdoc comment");
verify.signatureHelp({ marker: "12", docComment: "" });
verify.quickInfoAt("12q", "function noHelpComment1(): void");
@ -282,7 +282,7 @@ const multiplyTags: ReadonlyArray<FourSlashInterface.JSDocTagInfo> = [
{ name: "param", text: "c" },
{ name: "param", text: "d" },
{ name: "anotherTag", text: undefined },
{ name: "param", text: "e LastParam " },
{ name: "param", text: "e LastParam" },
{ name: "anotherTag", text: undefined },
];
verify.signatureHelp({ marker: "19", docComment: "This is multiplication function", parameterDocComment: "first number", tags: multiplyTags });
@ -303,8 +303,8 @@ verify.quickInfoAt("21aq", "(parameter) c: number");
verify.signatureHelp({ marker: "22", docComment: "This is multiplication function", tags: multiplyTags });
verify.quickInfoAt("22aq", "(parameter) d: any");
verify.signatureHelp({ marker: "23", docComment: "This is multiplication function", parameterDocComment: "LastParam ", tags: multiplyTags });
verify.quickInfoAt("23aq", "(parameter) e: any", "LastParam ");
verify.signatureHelp({ marker: "23", docComment: "This is multiplication function", parameterDocComment: "LastParam", tags: multiplyTags });
verify.quickInfoAt("23aq", "(parameter) e: any", "LastParam");
goTo.marker('24');
verify.completionListContains("aOrb", "(parameter) aOrb: any", "");
@ -420,7 +420,7 @@ verify.signatureHelp({ marker: "38", docComment: concatDoc, parameterDocComment:
verify.quickInfoAt("38aq", "(parameter) bar: string", "is second string");
goTo.marker('39');
verify.completionListContains("a", "(parameter) a: number", "this is inline comment for a \nit is first parameter");
verify.completionListContains("a", "(parameter) a: number", "this is inline comment for a\nit is first parameter");
verify.completionListContains("b", "(parameter) b: number", "this is inline comment for b");
verify.completionListContains("c", "(parameter) c: number", "it is third parameter");
verify.completionListContains("d", "(parameter) d: number", "");
@ -430,7 +430,7 @@ const jsdocTestTags: ReadonlyArray<FourSlashInterface.JSDocTagInfo> = [
{ name: "param", text: "a it is first parameter" },
{ name: "param", text: "c it is third parameter" },
];
verify.signatureHelp({ marker: "40", docComment: jsdocTestDocComment, parameterDocComment: "this is inline comment for a \nit is first parameter", tags: jsdocTestTags });
verify.signatureHelp({ marker: "40", docComment: jsdocTestDocComment, parameterDocComment: "this is inline comment for a\nit is first parameter", tags: jsdocTestTags });
verify.quickInfos({
"40q": [
"function jsDocParamTest(a: number, b: number, c: number, d: number): number",
@ -438,7 +438,7 @@ verify.quickInfos({
],
"40aq": [
"(parameter) a: number",
"this is inline comment for a \nit is first parameter"
"this is inline comment for a\nit is first parameter"
]
});
@ -453,7 +453,7 @@ verify.quickInfoAt("43aq", "(parameter) d: number");
goTo.marker('44');
verify.completionListContains("jsDocParamTest", "function jsDocParamTest(a: number, b: number, c: number, d: number): number", jsdocTestDocComment);
verify.completionListContains("x", "var x: any", "This is a comment ");
verify.completionListContains("x", "var x: any", "This is a comment");
verify.completionListContains("y", "var y: any", "This is a comment");
verify.signatureHelp({ marker: "45", docComment: "This is function comment\nAnd properly aligned comment" });

12
tests/cases/fourslash/commentsFunctionExpression.ts
View file

@ -61,12 +61,12 @@ verify.signatureHelp(
// no documentation from nested lambda
verify.quickInfos({
7: "function anotherFunc(a: number): string",
8: ["(local var) lambdaVar: (b: string) => string", "inner docs \ndocumentation"],
9: ["(parameter) b: string", "inner parameter "],
8: ["(local var) lambdaVar: (b: string) => string", "inner docs\ndocumentation"],
9: ["(parameter) b: string", "inner parameter"],
10: "(local var) localVar: string",
11: "(local var) localVar: string",
12: ["(parameter) b: string", "inner parameter "],
13: ["(local var) lambdaVar: (b: string) => string", "inner docs \ndocumentation"],
12: ["(parameter) b: string", "inner parameter"],
13: ["(local var) lambdaVar: (b: string) => string", "inner docs\ndocumentation"],
14: [
"var assigned: (s: string) => number",
"Summary on expression\nOn variable"
@ -74,14 +74,14 @@ verify.quickInfos({
});
goTo.marker('15');
verify.completionListContains('s', '(parameter) s: string', "On parameter \nparam on expression\nthe first parameter!");
verify.completionListContains('s', '(parameter) s: string', "On parameter\nparam on expression\nthe first parameter!");
verify.quickInfoAt("16", "var assigned: (s: string) => number", "Summary on expression\nOn variable");
goTo.marker('17');
verify.completionListContains("assigned", "var assigned: (s: string) => number", "Summary on expression\nOn variable");
verify.signatureHelp({
marker: "18",
docComment: "Summary on expression\nOn variable",
parameterDocComment: "On parameter \nparam on expression\nthe first parameter!",
parameterDocComment: "On parameter\nparam on expression\nthe first parameter!",
tags: [
{ name: "param", text: "s param on expression" },
{ name: "returns", text: "return on expression" },

2
tests/cases/fourslash/commentsLinePreservation.ts
View file

@ -141,7 +141,7 @@ verify.quickInfos({
7: ["(parameter) param1: string", "param information first line\n\nparam information third line"],
k: ["function k(param1: string): void", "This is firstLine\nThis is second Line"],
8: ["(parameter) param1: string", "hello "],
8: ["(parameter) param1: string", "hello"],
l: ["function l(param1: string): void", "This is firstLine\nThis is second Line"],
9: ["(parameter) param1: string", "first Line text\nblank line that shouldnt be shown when starting this \nsecond time information about the param again"],

4
tests/cases/fourslash/completionForStringLiteral_details.ts
View file

@ -24,5 +24,5 @@ goTo.marker("type");
verify.completionListContains("a", "a", "", "string");
goTo.marker("prop");
verify.completionListContains("x", "(property) I.x: number", "Prop doc ", "property");
verify.completionListContains("m", "(method) I.m(): void", "Method doc ", "method");
verify.completionListContains("x", "(property) I.x: number", "Prop doc", "property");
verify.completionListContains("m", "(method) I.m(): void", "Method doc", "method");

2
tests/cases/fourslash/completionInJsDocQualifiedNames.ts
View file

@ -12,4 +12,4 @@
////const x = 0;
goTo.marker();
verify.completionListContains("T", "type T = number", "tee ", "type");
verify.completionListContains("T", "type T = number", "tee", "type");

16
tests/cases/fourslash/completionsInJsxTag.ts
View file

@ -11,17 +11,17 @@
//// foo: string
//// }
//// }
////}
////class Foo {
//// render() {
//// <div /*1*/ ></div>;
//// <div /*2*/ />
//// }
////}
////class Foo {
//// render() {
//// <div /*1*/ ></div>;
//// <div /*2*/ />
//// }
////}
goTo.marker("1");
verify.completionListCount(1);
verify.completionListContains("foo", "(JSX attribute) foo: string", "Doc ", "JSX attribute");
verify.completionListContains("foo", "(JSX attribute) foo: string", "Doc", "JSX attribute");
goTo.marker("2");
verify.completionListCount(1);
verify.completionListContains("foo", "(JSX attribute) foo: string", "Doc ", "JSX attribute");
verify.completionListContains("foo", "(JSX attribute) foo: string", "Doc", "JSX attribute");

4
tests/cases/fourslash/completionsJsxAttribute.ts
View file

@ -16,7 +16,7 @@
////<div /**/></div>;
goTo.marker();
verify.completionEntryDetailIs("foo", "(JSX attribute) foo: string", "Doc ", "JSX attribute", []);
verify.completionEntryDetailIs("foo", "(JSX attribute) foo: string", "Doc", "JSX attribute", []);
edit.insert("f");
verify.completionEntryDetailIs("foo", "(JSX attribute) foo: string", "Doc ", "JSX attribute", []);
verify.completionEntryDetailIs("foo", "(JSX attribute) foo: string", "Doc", "JSX attribute", []);

2
tests/cases/fourslash/jsDocForTypeAlias.ts
View file

@ -4,4 +4,4 @@
////type /**/T = number
goTo.marker();
verify.quickInfoIs("type T = number", "DOC ");
verify.quickInfoIs("type T = number", "DOC");

2
tests/cases/fourslash/jsDocFunctionSignatures9.ts
View file

@ -19,5 +19,5 @@ verify.verifyQuickInfoDisplayParts('function',
{"text": " ", "kind": "space"},
{"text": "void", "kind": "keyword"}
],
[{"text": "first line of the comment\n\nthird line ", "kind": "text"}],
[{"text": "first line of the comment\n\nthird line", "kind": "text"}],
[]);

2
tests/cases/fourslash/quickInfoFromContextualType.ts
View file

@ -7,4 +7,4 @@
////}
////const i: I = { /**/x: 0 };
verify.quickInfoAt("", "(property) I.x: number", "Documentation ");
verify.quickInfoAt("", "(property) I.x: number", "Documentation");

6
tests/cases/fourslash/quickInfoImportedTypes.ts
View file

@ -21,14 +21,14 @@
verify.quickInfoAt("1", [
"(alias) interface Foo",
"import Foo",
].join("\n"), "This is an interface ");
].join("\n"), "This is an interface");
verify.quickInfoAt("2", [
"(alias) type Bar = 1 | 2",
"import Bar",
].join("\n"), "One or two ");
].join("\n"), "One or two");
verify.quickInfoAt("3", [
"(alias) class Baz<T extends {}>",
"import Baz",
].join("\n"), "This is a class ");
].join("\n"), "This is a class");

4
tests/cases/fourslash/quickInfoImportedTypesWithMergedMeanings.ts
View file

@ -18,11 +18,11 @@ verify.quickInfoAt("1", [
"(alias) type Original<T> = () => T",
"(alias) namespace Original",
"export Original",
].join("\n"), "some docs ");
].join("\n"), "some docs");
verify.quickInfoAt("2", [
"(alias) function Alias(): void",
"(alias) type Alias<T> = () => T",
"(alias) namespace Alias",
"import Alias",
].join("\n"), "some docs ");
].join("\n"), "some docs");

7
tests/cases/fourslash/quickInfoJsDocTags1.ts Normal file
View file

@ -0,0 +1,7 @@
/// <reference path='fourslash.ts'/>
// @Filename: quickInfoJsDocTags1.ts
/////** Doc */
////const /**/x = 0;
verify.quickInfoAt("", "const x: 0", "Doc");

8
tests/cases/fourslash/quickInfoMappedSpreadTypes.ts
View file

@ -18,13 +18,13 @@
////f4./*f4*/bar;
goTo.marker("f");
verify.quickInfoIs("(property) Foo.bar: number", "Doc ");
verify.quickInfoIs("(property) Foo.bar: number", "Doc");
goTo.marker("f2");
verify.quickInfoIs("(property) bar: string", "Doc ");
verify.quickInfoIs("(property) bar: string", "Doc");
goTo.marker("f3");
verify.quickInfoIs("(property) Foo.bar: number", "Doc ");
verify.quickInfoIs("(property) Foo.bar: number", "Doc");
goTo.marker("f4");
verify.quickInfoIs("(property) bar: string", "Doc ");
verify.quickInfoIs("(property) bar: string", "Doc");

2
tests/cases/fourslash/quickInfoSpecialPropertyAssignment.ts
View file

@ -7,4 +7,4 @@
//// }
////}
verify.quickInfoAt("", "(property) C.x: number", "Doc ");
verify.quickInfoAt("", "(property) C.x: number", "Doc");

4
tests/cases/fourslash/quickInfoUnion_discriminated.ts
View file

@ -27,8 +27,8 @@
////};
verify.quickInfos({
uKind: ['(property) A.kind: "a"', "Kind A "],
uProp: ["(property) A.prop: number", "Prop A "],
uKind: ['(property) A.kind: "a"', "Kind A"],
uProp: ["(property) A.prop: number", "Prop A"],
u2Kind: '(property) kind: "bogus"',
u2Prop: "(property) prop: number",
});

2
tests/cases/fourslash/regexDetection.ts
View file

@ -7,7 +7,7 @@ verify.not.quickInfoExists();
goTo.marker("2");
verify.quickInfoIs("const Math: Math",
"An intrinsic object that provides basic mathematics functionality and constants. ");
"An intrinsic object that provides basic mathematics functionality and constants.");
goTo.marker("3");
verify.not.quickInfoExists();