A non-opinionated golang code generator
A Yeoman generator for the golang programming language.
What is golang ?
See the Golang documentation
Why a generator ?
The Golang team defined guidelines to organize code and structure an application.
The generator builds a standard directory hierarchy complying with those guidelines.
Usage
- Install yeoman
$ npm install -g yo
- Install the generator
$ npm install generator-go
- Run the generator
$ yo go
That's all folks !
This will generate a minimalist directory hierarchy, a makefile and a .gitignore in your $GOPATH folder.
$GOPATH folder
└── src
└── github.com
└── myapp
├── hello
│ ├── hello.go # source file
│ └── hello_test.go # test file
├── main.go # app entrypoint
├── Makefile
├── README.md
└── .gitignore
Once built, go into application folder. You can then
Run your application with
$ make run
Compile sources and build binary with
$ make install
Run all tests suite with
$ make test
And clean up with
$ make clean
How to contribute
-
Fork the project
-
Clone your forked project locally
$ git clone https://github.com/your_repo/generator-go.git
$ cd generator-go
-
Modify sources
-
Symlink the package folder
$ sudo npm link
- Test your generator
$ yo go
- Submit a pull request
This project welcomes all contributors, feel free to apply !
Dependencies
This project depends on
