typescript - 使用 TypeScript 编译器 API 获取变量初始值设定项的解析类型(和 jsdoc 标签)

Question

从下面p.prop1的初始化器的ts.Node开始，有没有一种简单的方法来获取解析的类型信息(包括doc标签/评论) Props.prop1 使用类型检查器？

interface Props {
  /**
   * Doc comment
   * @tag
   */
  prop1: string;
}

const p: Props = { prop1: 'hello' };
//                 ^^^^^

我知道像 getTypeAtLocation、getDeclaredTypeOfSymbol、getApparentType 和 getPropertyOfType 这样的 API，但是我没有我无法弄清楚如何组合它们(或可能需要哪些其他 API)来完成我想做的事情。在 prop1 初始化器节点上调用 typeChecker.getSymbolAtLocation(node) 会返回一个没有完整类型信息的符号。

(最终我想要的是 JSDoc 标签，一旦您拥有正确的 ts.Symbol 就可以使用 symbol.getJsDocTags() 获取。)

Answer 1

获取对象文字表达式中prop1标识符的类型

要获取类型，您可以在类型检查器上使用getTypeAtLocation:

// prop1 is a variable containing the ts.Node (ts.Identifier) of
// the node you highlighted in your question
const prop1Type = typeChecker.getTypeAtLocation(prop1.name);

// outputs: string
console.log(typeChecker.typeToString(prop1Type));

获取其 JS 文档标签

老实说，我不确定获取 JS doc 标签的正确方法是什么，但我发现它可以从那里获取对象文字表达式的上下文类型(我认为这意味着它获取定义类型)获取 prop1 的属性:

const prop1Symbol = typeChecker.getSymbolAtLocation(prop1Symbol)!;
const propsType = typeChecker.getContextualType(prop1.parent)!;

// outputs the tag
console.log(propsType.getProperty(prop1Symbol.getName())!.getJsDocTags());

完整示例

import { createProjectSync, ts } from "@ts-morph/bootstrap";

// setup
const project = createProjectSync({ useInMemoryFileSystem: true });
const sourceFile = project.createSourceFile("file.ts", `
interface Props {
  /**
   * Doc comment
   * @tag
   */
  prop1: string;
}
const p: Props = { prop1: 'hello' };
`);
const typeChecker = project.createProgram().getTypeChecker();

// Get the prop1 identifier in the `p` variable declaration's initializer's
// object literal expression
const varStmt = sourceFile.statements.find(ts.isVariableStatement)!;
const varDecl = varStmt.declarationList.declarations[0];
const varDeclObjLit = varDecl.initializer as ts.ObjectLiteralExpression;
const prop1 = varDeclObjLit.properties[0] as ts.PropertyAssignment;

// outputs: string
const prop1Type = typeChecker.getTypeAtLocation(prop1.name);
console.log(typeChecker.typeToString(prop1Type));

// outputs the js doc tag
const prop1Symbol = typeChecker.getSymbolAtLocation(prop1.name)!;
const propsType = typeChecker.getContextualType(prop1.parent)!;
console.log(propsType.getProperty(prop1Symbol.getName())!.getJsDocTags());