Question

从下面的ts.Node的初始化程序的p.prop1开始，有一种简单的方法可以使用类型检查器来获取Props.prop1的已解析类型信息（包括文档标签/注释）。？

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

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

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

（最终，我想要的是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());

使用TypeScript编译器API获取变量初始化程序的解析类型（和jsdoc标记）

1 个答案: