microsoft / microsoft/TypeScript

No supported way to get js doc tags from extraneous comments

Ouverte
#42,895 7 commentaires 1 réaction 1 personne assignée Voir sur GitHub

@sandersn y travaille déjà.

Depuis le 23/2/2021.

Experience Enhancement Help Wanted Needs Investigation
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

🔎 Search Terms

ts.getJSDocTags
JSDoc tag not found

🕗 Version & Regression Information

Seen in TS 4.0 and 4.1

  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about the compiler API
💻 Code

Consider the input file:

/** @foo */

/** @bar */

var x;

As far as I can tell, there's no supported compiler API to access the @foo jsdoc tag. I've resorted to casting ts.Node to {jsDoc?: ts.JSDoc[]}.

🙁 Actual behavior

ts.getJSDocTags and friends only give the @bar JSDoc tag

🙂 Expected behavior

That method, or another, to return both the @foo and @bar tags.

Full compiler code sample to repro
import * as ts from 'typescript';

const filename = 'some_code.ts';
const program = ts.createProgram(['some_code.ts'], {noEmit: true});
program.emit();
const sourceFile = program.getSourceFile(filename);
if (!sourceFile) {
  throw new Error('could not get source file');
}

console.log(`getJSDocTags:`);
console.log([...getAllTags(sourceFile, (node) => ts.getJSDocTags(node))].map(
    (t) => t.tagName.text));
console.log(`Accessing jsDoc directly:`);
console.log(
    [...getAllTags(sourceFile, accessJsDoc)].map((t) => t.tagName.text));

function accessJsDoc(node: ts.Node): ts.JSDocTag[] {
  const tags = [];
  for (const jsDoc of (node as {jsDoc?: ts.JSDoc[]}).jsDoc ?? []) {
    for (const tag of jsDoc.tags ?? []) {
      tags.push(tag);
    }
  }
  return tags;
}

type TagGetter = (node: ts.Node) => Iterable<ts.JSDocTag>;
function getAllTags(
    node: ts.Node, getter: TagGetter, tags = new Set<ts.JSDocTag>()) {
  for (const tag of getter(node)) {
    tags.add(tag);
  }
  ts.forEachChild(node, (child) => {
    getAllTags(child, getter, tags);
  });
  return tags;
}

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.