如何在 typescript 编译器 api 中向现有 object 文字表达式添加赋值属性？

Question

我想使用 typescript AST 添加bar: true to x object。

此代码 cerates bar: true ：

 factory.createPropertyAssignment(
   factory.createIdentifier("bar"),
   factory.createTrue()
 );

我知道我需要返回这个 function 才能将其添加到 AST。 如果我这样做，那么问题是代码将覆盖foo: true 。

任何想法如何添加bar: true而不会丢失foo: true ？

编码：

import * as ts from "typescript";

const code = `
const x = {
  foo: true
})
`;

const node = ts.createSourceFile("x.ts", code, ts.ScriptTarget.Latest);

const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });

export const add = (context) => (rootNode) => {
  function visit(node) {
    const { factory } = context;

    // if (node.kind === ts.SyntaxKind.ObjectLiteralExpression) {
    //   return factory.createPropertyAssignment(
    //     factory.createIdentifier("bar"),
    //     factory.createTrue()
    //   );
    // }

    return ts.visitEachChild(node, visit, context);
  }

  return ts.visitNode(rootNode, visit);
};

const result = ts.transform(node, [add]);

// console.log({ result });
const transformedSourceFile = result.transformed[0];

const out = printer.printFile(transformedSourceFile);

console.log({ out });

代码框.io

Answer 1

您将从 ObjectLiteralExpression 节点的访问者返回 PropertyAssignment 节点，该节点替换了完整的 Object 文字。

相反，您可以更新此节点的属性成员以包含您的新属性：

export const add = (context) => (rootNode) => {
  function visit(node) {
    const { factory } = context;

    if (node.kind === ts.SyntaxKind.ObjectLiteralExpression) {
      // Update node.properties ------>
      node.properties.push(
        factory.createPropertyAssignment(
          factory.createIdentifier("bar"),
          factory.createTrue()
        )
      );
      return node;
    }

    return ts.visitEachChild(node, visit, context);
  }

  return ts.visitNode(rootNode, visit);
};

Answer 2

如果您在 typescript 中执行此操作， node.properties是只读的。 当你想改变当前节点并返回它时，类型安全的方法是使用factory.update*()方法：

export const add: ts.TransformerFactory<ts.SourceFile> = (context) => (rootNode) => {
    function visit(node: ts.Node): ts.VisitResult<ts.Node> {
        const { factory } = context;

        // using the provided typeguard to narrow the node kind
        if (ts.isObjectLiteralExpression(node)) {
            return factory.updateObjectLiteralExpression(node, [
                    // include the existing properties
                    ...node.properties,
                    // add your generated property
                    factory.createPropertyAssignment(
                        factory.createIdentifier("bar"),
                        factory.createTrue()
                    )
                ]
            );
        }
        return ts.visitEachChild(node, visit, context);
    }

    return ts.visitNode(rootNode, visit);
};