woodpile

KO | EN

gitlite — search

#python #react #go #android #machine-learning #nodejs #macos #java #windows #vue #pytorch #security #mcp #openai

(★ 80)

SWC AST visitor in Javascript

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci_main.yml
- - Cargo.toml
- - Cargo.toml
- index.ts
.gitignore
Cargo.toml
LICENSE
package-lock.json
package.json
README.md
rust-toolchain

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

### Woodpile

Woodpile is a utility library to traverse [SWC](https://github.com/swc-project/swc) ASTs in Javascript. It is a thin interop layer to the SWC's rust implementation of its visitor macro, attempt to provide consistent, synchronized mechanism to traverse ASTs in Javascript as well. This package could be useful for ducktyping, or prototyping SWC plugin in Javascript as its interface aims to provide similar experience as SWC's visitor macro.

For those reason, this package aims correctness over performance. There are inevitable costs to exchange data between Javascript to Rust, and vice versa. If you want to achieve peak performace, you should use SWC's visitor macro directly.

### Usage

`visit` is a main interface to traverse AST.

Currently, `visit` accepts an object with visitor properties have corresponding callbacks to traverse. `visit` property's callback will be called with corresponding node.

```ts
const { visit } = require('woodpile');
const { parseSync } = require('@swc/core');

const ast = parseSync('console.log("Hello, World!")');

visit(ast, {
    visit: {
        // Callbacks with visit${NodeName} will be called recursively for the node
        visitProgram: (node, self) => {
            console.log('visitProgram', node);
        },
        visitExpr: (node) => {
            console.log('visitExpr', node);
        }
    },
});
```

It is possible to return node in each callback which attempts to replace given node. The return value of `visit` will reflect updated AST. Note it won't replace input ast similar to `visit_mut` in swc's visitor. However, it doesn't check if the returned node is valid or not but will hard fail if the returned node is not valid.

```ts
const updatedNode = visit(ast, {
    visit: {
        visitProgram: (node, self) => {
            const updatedNode = {
              ...node
            };
            return updatedNode;
        },
    },
});
```

Callback also passes `self` as a second parameter. This is a context to the visitor object itself.

There is also `visitWithPath` property. This visitor's callback will supply `path` to the current node. This is useful to determin what kind of parent nodes are there from existing node. The parent nodes passed into path is not a full AST node, but a subset of the nodes indicates its types.

```ts
visit(ast, {
    visitWithPath: {
        visitExpr: (node, path, self) => {
        },
    }
})
```

There are also another utility function `compat`, attempts to provide conversion to the estree-compatble AST from SWC. Note this is the _closest attempt_ to generate compatible AST, likely will have some differences.

```ts
const { compat } = require('woodpile');
const { parseSync } = require('@swc/core');

const ast = parseSync('console.log("Hello, World!")');

const compat_ast = compat(ast, {
  source: "" // optional, original source code to the input ast
  flavor: "babel" | "acorn" // optional, default to babel
})
```

woodpile

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

woodpile

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README