https://github.com/DAddYE/igo
Intermediate GoLang source representation
https://github.com/DAddYE/igo
Last synced: about 1 year ago
JSON representation
Intermediate GoLang source representation
- Host: GitHub
- URL: https://github.com/DAddYE/igo
- Owner: DAddYE
- Created: 2014-03-15T00:43:49.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-04-03T17:04:40.000Z (about 12 years ago)
- Last Synced: 2024-11-06T15:56:30.320Z (over 1 year ago)
- Language: Go
- Homepage: http://play.igolang.io
- Size: 889 KB
- Stars: 139
- Watchers: 9
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## iGo, Intermediate Golang
This project provides an intermediate source representation of `go` source files.
Most of the code comes directly from the standard library of `pkg/go` however the core part, `parser`
and `scanner` has been heavily modified, the *igo* `ast` instead is pretty much unchanged to allow
an easily swap with the original one.
The __aim__ of this project is to provide an alternative `go fmt` which means the you will be able
to write as you _like_ and then distribute in the standard __go way__ (`*.go formatted files`).
**It's in beta stage**
### How it works?
You can [TRY IT on play.igolang.io](http://play.igolang.io) or with the `cli`:
```
usage: igo [compile|parse|build] [flags] [path ...]
-comments=true: print comments
-dest="": destination directory
-tabs=true: indent with tabs
-tabwidth=8: tab width
$ igo parse # will convert any *.go file in *.igo
$ igo compile # will convert *.igo source code in *.go
```
Note that `build` currently is not yet implemented.
### Manually convert go code:
```python
import
"bytes"
"fmt"
"github.com/DAddYE/igo/from_go"
"go/parser"
"go/token"
"io/ioutil"
"log"
"testing"
func ExampleFromGo()
# Initialize the scanner.
fset := token.NewFileSet() # positions are relative to fset
const filename = "../ast/ast.go"
src, err := ioutil.ReadFile(filename)
if err != nil
log.Fatalf("%s", err)
file, err := parser.ParseFile(fset, filename, src, parser.ParseComments)
if err != nil
fmt.Println(err)
return
# Print the function body into buffer buf.
# The file set is provided to the printer so that it knows
# about the original source formatting and can add additional
# line breaks where they were present in the source.
var buf bytes.Buffer
from_go.Fprint(&buf, fset, file)
# Print the cleaned-up body text to stdout.
fmt.Println(&buf)
```
### Manually convert iGo code:
```python
import
"bytes"
"fmt"
"github.com/DAddYE/igo/parser"
"github.com/DAddYE/igo/to_go"
"github.com/DAddYE/igo/token"
"io/ioutil"
"log"
"testing"
func ExampleToGo()
# Initialize the scanner.
fset := token.NewFileSet() # positions are relative to fset
const filename = "../ast/ast.igo"
src, err := ioutil.ReadFile(filename)
if err != nil
log.Fatalf("%s", err)
file, err := parser.ParseFile(fset, filename, src, parser.ParseComments)
if err != nil
fmt.Println(err)
return
# Print the function body into buffer buf.
# The file set is provided to the printer so that it knows
# about the original source formatting and can add additional
# line breaks where they were present in the source.
var buf bytes.Buffer
to_go.Fprint(&buf, fset, file)
# Print the cleaned-up body text to stdout.
fmt.Println(&buf)
```
### How looks like?
Just browse `*.igo` files, but soon I'll make a `ebnf` notation.
### What will change?
Pretty much really few things, `golang` itself is almost perfect, this parser will allow you to skip
some annoyance. Nothing more.
### Editors
- [Vim](https://github.com/DAddYE/igo.vim)
- add yours ...
### What's left?
In my roadmap there is:
- [x] Builds (aka `igo build|run|test`)
- [ ] Add GoCode like for editors
- [ ] iGo format (aka `igo fmt`)
- [ ] iGo doc (aka `igo doc`)
- [ ] Expose `ast` (aka `little macros`)
- [ ] Expose `__filename__`, `__fname__`
### Other info
This project was partially influenced by [Nimrod](http://nimrod-lang.org) which I highly
suggest to [try](http://nimrod-lang.org).
### License MIT/BSD-style
Author Davide D'Agostino (@DAddYE) and `The Go Authors`