forked from refaktor/ryegen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdoc.go
14 lines (11 loc) · 797 Bytes
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/*
Package ryegen allows the use of Go libraries from the Rye programming language (https://ryelang.org/).
It is an automatic binding generation utility that allows the creation of custom Rye interpreters, which include the functionality of specific Go libraries.
# Architecture pipeline (for developers)
Each element in the pipeline has distinct sub-packages that do a specific part. These are then "glued" together in the [Run] function.
1. [config]: Parse user-supplied 'config.toml' and 'bindings.txt' files
2. [repo] and [parser]: Fetch the target package and parse 'go.mod'/imports. Fetch dependencies recursively
3. [ir]: Parse relevant package code AST and transform it into an intermediate representation
3. [binder]: Use IR data to construct the final bindings.
*/
package ryegen