Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,13 @@ Walk an AST from SWC and visit each node type.

## Requirements

- Node.js 22.x or 24.x.
- AST is as defined by [`@swc/types`](https://github.com/swc-project/swc/tree/main/packages/types).

## Version Notes

- For v1 to v2 breaking changes, see [`docs/v1-v2-migration.md`](./docs/v1-v2-migration.md).

## Example

`swc-walk` wraps [`acorn-walk`](https://github.com/acornjs/acorn/blob/master/acorn-walk/README.md) walkers.
Expand Down
46 changes: 46 additions & 0 deletions docs/v1-v2-migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# v1 to v2 Migration

This guide summarizes breaking changes introduced in v2.

## Breaking changes

1. `Span` typing changed.
2. Node.js 20 support was removed.

## Span typing changes

In v2, node span typing was aligned with runtime behavior:

- Nodes that usually have a `span` still expose `span`, but it is typed as `Span | undefined`.
- Some node kinds may still omit `span` at runtime.

Update code that assumes `span` is always defined.

Before (v1):

```ts
function handle(node: Node) {
return node.span.start
}
```

After (v2):

```ts
function handle(node: Node) {
if (node.span) {
return node.span.start
}

return undefined
}
```

## Node.js version support

v2 supports:

- Node.js 22.x
- Node.js 24.x

If you are on Node.js 20, upgrade your runtime before adopting v2.
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "swc-walk",
"version": "2.0.0-rc.1",
"version": "2.0.0",
"description": "Walk an AST from SWC and visit each node type.",
"main": "dist/esm/walk.js",
"type": "module",
Expand All @@ -22,7 +22,7 @@
"default": "./dist/esm/baseVisitor.js"
},
"require": {
"types": "./dist/cjs/baseVisistor.d.cts",
"types": "./dist/cjs/baseVisitor.d.cts",
"default": "./dist/cjs/baseVisitor.cjs"
},
"default": "./dist/esm/baseVisitor.js"
Expand Down
Loading