@@ -20,6 +20,7 @@ It implements the [**unist**][unist] spec.
20
20
## Contents
21
21
22
22
- [ Introduction] ( #introduction )
23
+ - [ Where this specification fits] ( #where-this-specification-fits )
23
24
- [ Types] ( #types )
24
25
- [ Nodes (abstract)] ( #nodes-abstract )
25
26
- [ Nodes] ( #nodes )
@@ -30,7 +31,12 @@ It implements the [**unist**][unist] spec.
30
31
31
32
## Introduction
32
33
33
- ** TODO** : introduction
34
+ This document defines a format for representing file systems as abstract syntax trees. Development of fst started in
35
+ January 2025. This specification is written in a [ TypeScript] [ ] -like grammar.
36
+
37
+ ### Where this specification fits
38
+
39
+ fst extends [ unist] [ ] , a format for syntax trees, to benefit from its [ ecosystem of utilities] ( #list-of-utilities ) .
34
40
35
41
## Types
36
42
@@ -60,6 +66,11 @@ See the [unist glossary][unist-glossary] for more terms.
60
66
61
67
See the [ unist list of utilities] [ unist-utilities ] for more utilities.
62
68
69
+ - [ ` fst-util-from-fs ` ] [ fst-util-from-fs ] — create trees from file systems
70
+ - [ ` unist-util-builder ` ] [ unist-util-builder ] — build trees
71
+ - [ ` unist-util-inspect ` ] [ unist-util-inspect ] — inspect trees
72
+ - [ ` unist-util-visit ` ] [ unist-util-visit ] — visit nodes using [ preorder] [ ] or [ postorder] [ ] traversal
73
+
63
74
## Contribute
64
75
65
76
See [ ` CONTRIBUTING.md ` ] ( CONTRIBUTING.md ) .
@@ -71,7 +82,13 @@ community you agree to abide by its terms.
71
82
72
83
[ fst-ideas ] : https://github.com/flex-development/fst/discussions/new?category=idea
73
84
74
- <!-- [fst-util-from-fs]: https://github.com/flex-development/fst-util-from-fs -->
85
+ [ fst-util-from-fs ] : https://github.com/flex-development/fst-util-from-fs
86
+
87
+ [ postorder ] : https://github.com/syntax-tree/unist#postorder
88
+
89
+ [ preorder ] : https://github.com/syntax-tree/unist#preorder
90
+
91
+ [ typescript ] : https://www.typescriptlang.org
75
92
76
93
<!-- [unist-child]: https://github.com/syntax-tree/unist#child -->
77
94
@@ -91,6 +108,12 @@ community you agree to abide by its terms.
91
108
92
109
<!-- [unist-tree]: https://github.com/syntax-tree/unist#tree -->
93
110
111
+ [ unist-util-builder ] : https://github.com/flex-development/unist-util-builder
112
+
113
+ [ unist-util-inspect ] : https://github.com/flex-development/unist-util-inspect
114
+
115
+ [ unist-util-visit ] : https://github.com/flex-development/unist-util-visit
116
+
94
117
[ unist-utilities ] : https://github.com/syntax-tree/unist#list-of-utilities
95
118
96
119
[ unist ] : https://github.com/syntax-tree/unist
0 commit comments