Skip to content

Remove trailing whitespace from JSDoc comments #26029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 28, 2018
Merged

Remove trailing whitespace from JSDoc comments #26029

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/compiler/parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -6460,7 +6460,7 @@ namespace ts {
nextJSDocToken();
}
removeLeadingNewlines(comments);
removeTrailingNewlines(comments);
removeTrailingWhitespace(comments);
return createJSDocComment();
});

Expand All @@ -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();
}
}
Expand Down Expand Up @@ -6632,7 +6632,7 @@ namespace ts {
}

removeLeadingNewlines(comments);
removeTrailingNewlines(comments);
removeTrailingWhitespace(comments);
return comments.length === 0 ? undefined : comments.join("");
}

Expand Down
2 changes: 1 addition & 1 deletion ...s/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.asteriskAfterPreamble.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"kind": "JSDocComment",
"pos": 0,
"end": 23,
"comment": "* @type {number} "
"comment": "* @type {number}"
}
2 changes: 1 addition & 1 deletion tests/baselines/reference/JSDocParsing/DocComments.parsesCorrectly.threeAsterisks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
"kind": "JSDocComment",
"pos": 0,
"end": 7,
"comment": "* "
"comment": "*"
}
42 changes: 21 additions & 21 deletions tests/cases/fourslash/commentsCommentParsing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,32 +208,32 @@ 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");

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");
Expand Down Expand Up @@ -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 });
Expand All @@ -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", "");
Expand Down Expand Up @@ -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", "");
Expand All @@ -430,15 +430,15 @@ 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",
jsdocTestDocComment
],
"40aq": [
"(parameter) a: number",
"this is inline comment for a \nit is first parameter"
"this is inline comment for a\nit is first parameter"
]
});

Expand All @@ -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" });
Expand Down
12 changes: 6 additions & 6 deletions tests/cases/fourslash/commentsFunctionExpression.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,27 +61,27 @@ 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"
]
});

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" },
Expand Down
2 changes: 1 addition & 1 deletion tests/cases/fourslash/commentsLinePreservation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand Down
4 changes: 2 additions & 2 deletions tests/cases/fourslash/completionForStringLiteral_details.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion tests/cases/fourslash/completionInJsDocQualifiedNames.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 8 additions & 8 deletions tests/cases/fourslash/completionsInJsxTag.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@
//// foo: string
//// }
//// }
////}
////class Foo {
//// render() {
//// <div /*1*/ ></div>;
//// <div /*2*/ />
//// }
////}
////class Foo {
//// render() {
//// <div /*1*/ ></div>;
//// <div /*2*/ />
//// }
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this change was due to mixed line endings in the file. I can remove this part of the change if needed.

////}

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 changes: 2 additions & 2 deletions tests/cases/fourslash/completionsJsxAttribute.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion tests/cases/fourslash/jsDocForTypeAlias.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
////type /**/T = number

goTo.marker();
verify.quickInfoIs("type T = number", "DOC ");
verify.quickInfoIs("type T = number", "DOC");
2 changes: 1 addition & 1 deletion tests/cases/fourslash/jsDocFunctionSignatures9.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion tests/cases/fourslash/quickInfoFromContextualType.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
////}
////const i: I = { /**/x: 0 };

verify.quickInfoAt("", "(property) I.x: number", "Documentation ");
verify.quickInfoAt("", "(property) I.x: number", "Documentation");
6 changes: 3 additions & 3 deletions tests/cases/fourslash/quickInfoImportedTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 2 additions & 2 deletions tests/cases/fourslash/quickInfoImportedTypesWithMergedMeanings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 7 additions & 0 deletions tests/cases/fourslash/quickInfoJsDocTags1.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/// <reference path='fourslash.ts'/>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new test is probably not necessary given the number of other tests updated here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor, but I thought a test with multiple trailing spaces would make sense.


// @Filename: quickInfoJsDocTags1.ts
/////** Doc */
////const /**/x = 0;

verify.quickInfoAt("", "const x: 0", "Doc");
8 changes: 4 additions & 4 deletions tests/cases/fourslash/quickInfoMappedSpreadTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion tests/cases/fourslash/quickInfoSpecialPropertyAssignment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
//// }
////}

verify.quickInfoAt("", "(property) C.x: number", "Doc ");
verify.quickInfoAt("", "(property) C.x: number", "Doc");
4 changes: 2 additions & 2 deletions tests/cases/fourslash/quickInfoUnion_discriminated.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 1 addition & 1 deletion tests/cases/fourslash/regexDetection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down