Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asty-org/asty
Converts golang AST to JSON and JSON to AST
https://github.com/asty-org/asty
ast go golang json parser
Last synced: about 1 month ago
JSON representation
Converts golang AST to JSON and JSON to AST
- Host: GitHub
- URL: https://github.com/asty-org/asty
- Owner: asty-org
- License: apache-2.0
- Created: 2022-08-23T12:44:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-22T22:53:34.000Z (about 1 year ago)
- Last Synced: 2024-02-08T10:48:51.179Z (4 months ago)
- Topics: ast, go, golang, json, parser
- Language: Go
- Homepage: https://asty-org.github.io/
- Size: 1.08 MB
- Stars: 68
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Lists
- awesome-go - asty - Converts golang AST to JSON and JSON to AST. (Code Analysis / Routers)
- awesome-go - asty - Converts golang AST to JSON and JSON to AST. (Code Analysis / Routers)
- awesome-go-cn - asty - org/asty) (代码分析 / 路由器)
- awesome-go-stars - asty - Converts golang AST to JSON and JSON to AST. (Code Analysis / Routers)
- awesome-go-with-stars - asty - Converts golang AST to JSON and JSON to AST. (Code Analysis / Routers)
- repo-1316-awesome-go-cn - asty - org/asty) (代码分析 / 路由器)
- repo-1211-awesome-go-cn - asty - org/asty) (代码分析 / 路由器)
- Go-awesome - asty - Converts golang AST to JSON and JSON to AST. (Code Analysis / Routers)
- awesome-go-cn - asty - org/asty) (代码分析 / 路由器)
- awesome-go - asty - Converts golang AST to JSON and JSON to AST. (Code Analysis / Routers)
- awesome-go - asty - Converts golang AST to JSON and JSON to AST. (Code Analysis / Routers)
- awesome-go - asty - Converts golang AST to JSON and JSON to AST. (Code Analysis / Routers)
README
# asty
[](https://pkg.go.dev/github.com/asty-org/asty)
[](https://goreportcard.com/report/github.com/asty-org/asty)
[](https://github.com/asty-org/asty)
[](https://hub.docker.com/r/astyorg/asty)
[](https://github.com/avelino/awesome-go#code-analysis)
_Not another JSON parser!_
**AST → JSON** | **JSON → AST**
Marshals golang [AST](https://pkg.go.dev/go/ast) into JSON and unmarshals it back from JSON.
It allows building pattern matching, statistical analysis, language transformation, search/data-mine/anything algorithms
for golang with any other language (I like to do it with python. Check out [asty-python](https://github.com/asty-org/asty-python))
## Example
[Try it!](https://asty-org.github.io/)
Input golang source
```golang
package main
import "fmt"
func main() {
fmt.Println("hello world")
}
```
Ouput AST in JSON
```json
{
"NodeType": "File",
"Name": {
"NodeType": "Ident",
"Name": "main"
},
"Decls": [
{
"NodeType": "GenDecl",
"Tok": "import",
"Specs": [
{
"NodeType": "ImportSpec",
"Name": null,
"Path": {
"NodeType": "BasicLit",
"Kind": "STRING",
"Value": "\"fmt\""
}
}
]
},
{
"NodeType": "FuncDecl",
"Recv": null,
"Name": {
"NodeType": "Ident",
"Name": "main"
},
"Type": {
"NodeType": "FuncType",
"TypeParams": null,
"Params": {
"NodeType": "FieldList",
"List": null
},
"Results": null
},
"Body": {
"NodeType": "BlockStmt",
"List": [
{
"NodeType": "ExprStmt",
"X": {
"NodeType": "CallExpr",
"Fun": {
"NodeType": "SelectorExpr",
"X": {
"NodeType": "Ident",
"Name": "fmt"
},
"Sel": {
"NodeType": "Ident",
"Name": "Println"
}
},
"Args": [
{
"NodeType": "BasicLit",
"Kind": "STRING",
"Value": "\"hello world\""
}
]
}
}
]
}
}
]
}
```
## Install
Install `asty` under `$GOPATH/bin`
```bash
go install github.com/asty-org/asty
asty -h
```
## Building
Just `make`
If you want to do it differently use `go build`
## Usage
Convert AST to JSON
```bash
asty go2json -input -output
```
Convert JSON to AST
```bash
asty json2go -input -output
```
Use `asty help` for more information
Using with docker
```bash
docker run astyorg/asty go2json -input -output
```
## Development principles
- Make json output as close to real golang structures as possible. There is no additional logic introduced.
No normalization. No reinterpretation. The only things that were introduced are the names of some enum values.
- Make it very explicit. No reflection. No listing of fields. This is done to facilitate future maintenance.
If something will be changed in future versions of golang this code will probably break compile-time.
- Keep polymorphism in JSON structure. If some field references _expression_ then particular type will be
discriminated from object type name stored in separate field.
## Other solutions
- https://github.com/ReconfigureIO/goblin reinterpret some structures (trying to simplify).
Out of maintenance for a long time. Still works in some forks.
- https://github.com/CreativeInquiry/go2json tries to parse golang code with parser written in javascript.
Also lacks maintenance. Developed for particular use case of HaXe traspiler.
## Article
I wrote [an article](https://dev.to/evgenus/analyzing-ast-in-go-with-json-tools-36dg) about this project.