Получить разрешенный тип (и теги jsdoc) инициализатора переменной с помощью API компилятора TypeScript

Начиная с ts.Node для инициализатора p.prop1 ниже, существует ли простой способ получить информацию о разрешенном типе (включая теги документов / комментарии) для Props.prop1 с помощью средства проверки типов?

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

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

Мне известны такие API, как getTypeAtLocation, getDeclaredTypeOfSymbol, getApparentType и getPropertyOfType, но я не мог понять, как их объединить (или какие другие API могут потребоваться), чтобы делать то, что я хочу. Вызов typeChecker.getSymbolAtLocation(node) на узле инициализатора prop1 возвращает символ, который не имеет полной информации о типе.

(В конечном итоге мне нужны теги JSDoc, которые, если у вас есть права ts.Symbol, можно получить с помощью symbol.getJsDocTags().)


typescript typescript-compiler-api
person ecraig12345    schedule 28.05.2020    source источник

Ответы (1)


arrow_upward
0
arrow_downward

Получение типа 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());
person David Sherret    schedule 01.06.2020