Skip to content

Commit da5924e

Browse files
committed
docs: Small improvements to README.md files
1 parent 052655b commit da5924e

File tree

7 files changed

+50
-21
lines changed

7 files changed

+50
-21
lines changed

README.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ This is a monorepo with packages to **boost the [DX]** of working with [AST] _(u
2121

2222
In order to work with AST, the following processes are recognized:
2323

24-
1. [Analyzing](#analyze) the [AST] object(s).
25-
1. [Building](#build) programmatically the [AST] node(s), or an entire object.
2624
1. [Parsing](#parse) _stringified_ code syntax into [AST] object.
2725
1. [Traversing](#traverse) the [AST] object.
26+
1. [Analyzing](#analyze) the [AST] object(s).
27+
1. [Building](#build) programmatically the [AST] node(s), or an entire object.
2828
1. [Printing](#print) the [AST] object back into _stringified_ code syntax.
2929

3030
> [!IMPORTANT]
@@ -35,6 +35,23 @@ In order to work with AST, the following processes are recognized:
3535
>
3636
> Not all of these packages are part of this monorepo.
3737
38+
### Parse
39+
40+
Getting the [AST] object from stringified code syntax.
41+
42+
| Name | Languages | In this repository? |
43+
| ------------------- | -------------------- | ------------------- |
44+
| [`@swc/core`] | ![icon-js]![icon-ts] ||
45+
| [`svelte/compiler`] | ![icon-svelte] ||
46+
47+
### Traverse
48+
49+
In other words, _walk_ on the AST object.
50+
51+
| Name | Languages | In this repository? |
52+
| --------------- | ---------------------------------- | ------------------- |
53+
| [`zimmerframe`] | ![icon-js]![icon-ts]![icon-svelte] ||
54+
3855
### Analyze
3956

4057
Analyze the received [AST] object(s). Contains type-guards and utilities.
@@ -55,23 +72,6 @@ Sometimes you need to do some code transformation...
5572
| [`ts-ast-build`] | ![icon-ts] ||
5673
| [`svelte-ast-build`] | ![icon-svelte] ||
5774

58-
### Parse
59-
60-
Getting the [AST] object from stringified code syntax.
61-
62-
| Name | Languages | In this repository? |
63-
| ------------------- | -------------------- | ------------------- |
64-
| [`@swc/core`] | ![icon-js]![icon-ts] ||
65-
| [`svelte/compiler`] | ![icon-svelte] ||
66-
67-
### Traverse
68-
69-
In other words, _walk_ on the AST object.
70-
71-
| Name | Languages | In this repository? |
72-
| --------------- | ---------------------------------- | ------------------- |
73-
| [`zimmerframe`] | ![icon-js]![icon-ts]![icon-svelte] ||
74-
7575
### Print
7676

7777
Print the [AST] object or nodes into stringified code syntax.

pkgs/js-ast-analyze/README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
1-
# `ts-ast-analyze`
1+
# `js-ast-analyze`
22

33
![NPM Version](https://img.shields.io/npm/v/ts-ast-analyze?style=for-the-badge&logo=npm)
44

55
> [!CAUTION]
66
> 🚧 Work In Progress 🚧
77
8+
## Usage
9+
10+
[See documentation](https://xeho91.github.io/js-ast/js-ast-analyze.js-ast-analyze.html).
11+
812
---
913

1014
## Author

pkgs/js-ast-build/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
> [!CAUTION]
66
> 🚧 Work In Progress 🚧
77
8+
## Usage
9+
10+
[See documentation](https://xeho91.github.io/js-ast/js-ast-build.js-ast-analyze.html).
11+
12+
---
13+
814
## Author
915

1016
Mateusz "[xeho91](https://github.com/xeho91)" Kadlubowski

pkgs/svelte-ast-analyze/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@
44

55
Utilities for _analyzing_ the [Svelte] syntax [AST] nodes conveniently.
66

7+
> [!CAUTION]
8+
> 🚧 Work In Progress 🚧
9+
710
## Usage
811

9-
[See documentation](https://xeho91.github.io/js-ast/modules/svelte-ast-analyze.svelte-ast-analyze.html).
12+
[See documentation](https://xeho91.github.io/js-ast/svelte-ast-analyze.svelte-ast-analyze.html).
1013

1114
---
1215

pkgs/svelte-ast-build/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ Utilities to work and build [Svelte] syntax [AST] nodes conveniently.
77
> [!CAUTION]
88
> 🚧 Work In Progress 🚧
99
10+
## Usage
11+
12+
[See documentation](https://xeho91.github.io/js-ast/svelte-ast-build.svelte-ast-build.html).
13+
1014
---
1115

1216
## Author

pkgs/ts-ast-analyze/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
> [!CAUTION]
66
> 🚧 Work In Progress 🚧
77
8+
## Usage
9+
10+
[See documentation](https://xeho91.github.io/js-ast/svelte-ast-build.svelte-ast-build.html).
11+
12+
---
13+
814
## Author
915

1016
Mateusz "[xeho91](https://github.com/xeho91)" Kadlubowski

pkgs/ts-ast-build/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
> [!CAUTION]
66
> 🚧 Work In Progress 🚧
77
8+
## Usage
9+
10+
[See documentation](https://xeho91.github.io/js-ast/svelte-ast-build.svelte-ast-build.html).
11+
12+
---
13+
814
## Author
915

1016
Mateusz "[xeho91](https://github.com/xeho91)" Kadlubowski

0 commit comments

Comments
 (0)