microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-06-30 04:16:48 -05:00
Code Issues Packages Projects Releases 212 Wiki Activity

Merge pull request #32138 from microsoft/jsdoc-match-backticks

Browse Source 
Jsdoc: allow backticks to escape `@`
This commit is contained in:
Nathan Shively-Sanders
2019-06-27 10:11:43 -07:00
committed by GitHub
parent 9832899372 2362dd4fac
commit e6b347ad42
5 changed files with 129 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/compiler/parser.ts
View File

@@ -6431,6 +6431,7 @@ namespace ts {
BeginningOfLine,
SawAsterisk,
SavingComments,
SavingBackticks, // NOTE: Only used when parsing tag comments
}
const enum PropertyLikeParse {
@@ -6691,18 +6692,23 @@ namespace ts {
case SyntaxKind.NewLineTrivia:
if (state >= JSDocState.SawAsterisk) {
state = JSDocState.BeginningOfLine;
// don't use pushComment here because we want to keep the margin unchanged
comments.push(scanner.getTokenText());
}
indent = 0;
break;
case SyntaxKind.AtToken:
if (state === JSDocState.SavingBackticks) {
comments.push(scanner.getTokenText());
break;
}
scanner.setTextPos(scanner.getTextPos() - 1);
// falls through
case SyntaxKind.EndOfFileToken:
// Done
break loop;
case SyntaxKind.WhitespaceTrivia:
if (state === JSDocState.SavingComments) {
if (state === JSDocState.SavingComments || state === JSDocState.SavingBackticks) {
pushComment(scanner.getTokenText());
}
else {
@@ -6724,6 +6730,15 @@ namespace ts {
}
pushComment(scanner.getTokenText());
break;
case SyntaxKind.BacktickToken:
if (state === JSDocState.SavingBackticks) {
state = JSDocState.SavingComments;
}
else {
state = JSDocState.SavingBackticks;
}
pushComment(scanner.getTokenText());
break;
case SyntaxKind.AsteriskToken:
if (state === JSDocState.BeginningOfLine) {
// leading asterisks start recording on the *next* (non-whitespace) token
@@ -6734,7 +6749,9 @@ namespace ts {
// record the * as a comment
// falls through
default:
state = JSDocState.SavingComments; // leading identifiers start recording as well
if (state !== JSDocState.SavingBackticks) {
state = JSDocState.SavingComments; // leading identifiers start recording as well
}
pushComment(scanner.getTokenText());
break;
}

30
tests/baselines/reference/jsdocParseMatchingBackticks.symbols Normal file
View File

@@ -0,0 +1,30 @@
=== tests/cases/conformance/jsdoc/jsdocParseMatchingBackticks.js ===
/**
* `@param` initial at-param is OK in title comment
* @param {string} x hi there `@param`
* @param {string} y hi there `@ * param
* this is the margin
* so we'll drop everything before it
`@param` @param {string} z hello???
* `@param` @param {string} alpha hello???
* `@ * param` @param {string} beta hello???
* @param {string} gamma
*/
export function f(x, y, z, alpha, beta, gamma) {
>f : Symbol(f, Decl(jsdocParseMatchingBackticks.js, 0, 0))
>x : Symbol(x, Decl(jsdocParseMatchingBackticks.js, 11, 18))
>y : Symbol(y, Decl(jsdocParseMatchingBackticks.js, 11, 20))
>z : Symbol(z, Decl(jsdocParseMatchingBackticks.js, 11, 23))
>alpha : Symbol(alpha, Decl(jsdocParseMatchingBackticks.js, 11, 26))
>beta : Symbol(beta, Decl(jsdocParseMatchingBackticks.js, 11, 33))
>gamma : Symbol(gamma, Decl(jsdocParseMatchingBackticks.js, 11, 39))
return x + y + z + alpha + beta + gamma
>x : Symbol(x, Decl(jsdocParseMatchingBackticks.js, 11, 18))
>y : Symbol(y, Decl(jsdocParseMatchingBackticks.js, 11, 20))
>z : Symbol(z, Decl(jsdocParseMatchingBackticks.js, 11, 23))
>alpha : Symbol(alpha, Decl(jsdocParseMatchingBackticks.js, 11, 26))
>beta : Symbol(beta, Decl(jsdocParseMatchingBackticks.js, 11, 33))
>gamma : Symbol(gamma, Decl(jsdocParseMatchingBackticks.js, 11, 39))
}

35
tests/baselines/reference/jsdocParseMatchingBackticks.types Normal file
View File

@@ -0,0 +1,35 @@
=== tests/cases/conformance/jsdoc/jsdocParseMatchingBackticks.js ===
/**
* `@param` initial at-param is OK in title comment
* @param {string} x hi there `@param`
* @param {string} y hi there `@ * param
* this is the margin
* so we'll drop everything before it
`@param` @param {string} z hello???
* `@param` @param {string} alpha hello???
* `@ * param` @param {string} beta hello???
* @param {string} gamma
*/
export function f(x, y, z, alpha, beta, gamma) {
>f : (x: string, y: string, z: string, alpha: string, beta: string, gamma: string) => string
>x : string
>y : string
>z : string
>alpha : string
>beta : string
>gamma : string
return x + y + z + alpha + beta + gamma
>x + y + z + alpha + beta + gamma : string
>x + y + z + alpha + beta : string
>x + y + z + alpha : string
>x + y + z : string
>x + y : string
>x : string
>y : string
>z : string
>alpha : string
>beta : string
>gamma : string
}

20
tests/cases/conformance/jsdoc/jsdocParseMatchingBackticks.ts Normal file
View File

@@ -0,0 +1,20 @@
// @noEmit: true
// @allowJs: true
// @checkJs: true
// @strict: true
// @Filename: jsdocParseMatchingBackticks.js
/**
* `@param` initial at-param is OK in title comment
* @param {string} x hi there `@param`
* @param {string} y hi there `@ * param
* this is the margin
* so we'll drop everything before it
`@param` @param {string} z hello???
* `@param` @param {string} alpha hello???
* `@ * param` @param {string} beta hello???
* @param {string} gamma
*/
export function f(x, y, z, alpha, beta, gamma) {
return x + y + z + alpha + beta + gamma
}

25
tests/cases/fourslash/quickInfoJSDocBackticks.ts Normal file
View File

@@ -0,0 +1,25 @@
///<reference path="fourslash.ts" />
// @noEmit: true
// @allowJs: true
// @checkJs: true
// @strict: true
// @Filename: jsdocParseMatchingBackticks.js
/////**
//// * `@param` initial at-param is OK in title comment
//// * @param {string} x hi there `@param`
//// * @param {string} y hi there `@ * param
//// * this is the margin
//// */
////export function f(x, y) {
//// return x/*x*/ + y/*y*/
////}
////f/*f*/
goTo.marker("f");
verify.quickInfoIs("function f(x: string, y: string): string", "`@param` initial at-param is OK in title comment");
goTo.marker("x");
verify.quickInfoIs("(parameter) x: string", "hi there `@param`");
goTo.marker("y");
verify.quickInfoIs("(parameter) y: string", "hi there `@ * param\nthis is the margin");