Получить разрешенный тип (и теги jsdo c) инициализатора переменной с помощью API компилятора TypeScript - PullRequest
Новая
       23

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

2 голосов
/ 28 мая 2020

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

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

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

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

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

1 Ответ

0 голосов
/ 01 июня 2020

Получение типа 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 do c

Честно говоря, я не уверен, как правильно получить теги JS do c, но я обнаружил, что он работает для получения контекстного типа объектного буквального выражения (я думаю, это означает, что он получает тип определения), а затем оттуда получает свойство 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());
...