realize

Go to file

alessio 98439141b7 name convention		2016-09-01 18:05:40 +02:00
realize	name convention	2016-09-01 18:05:40 +02:00
.gitignore	glide files in .gitignore	2016-08-24 15:22:17 +02:00
.travis.yml	before install	2016-08-17 21:56:44 +02:00
LICENSE	realize dev	2016-07-12 10:18:02 +02:00
README.md	output support doc	2016-08-31 14:14:09 +02:00
main.go	output file, code clean	2016-08-31 14:08:15 +02:00

README.md

Realize

A Go build system with file watchers, output streams and live reload. Run, build and watch file changes with custom paths

Features

Build, Install, Test, Fmt and Run at the same time
Live reload on file changes (re-build, re-install and re-run)
Watch custom paths
Watch specific file extensions
Multiple projects support
Output streams
Execution times
Highly customizable
Fast run

Installation and usage

Run this to get/install:
```
$ go get github.com/tockins/realize
```

From project/projects root execute:

$ realize add

It will create a realize.config.yaml file if it doesn't exist already and adds the working directory as the project.

Otherwise if a config file already exists it adds another project to the existing config file.

The add command supports the following custom parameters:

--name="Project Name"   -> Name, if not specified takes the working directory name
--path="server"         -> Base Path, if not specified takes the working directory name    
--build                 -> Enables the build   
--test                  -> Enables the tests   
--no-bin                -> Disables the installation
--no-run                -> Disables the run
--no-fmt                -> Disables the fmt (go fmt)

Examples:

$ realize add

$ realize add --path="mypath"

$ realize add --name="My Project" --build

$ realize add --name="My Project" --path="/projects/package" --build

$ realize add --name="My Project" --path="projects/package" --build --no-run

$ realize add --path="/Users/alessio/go/src/github.com/tockins/realize-examples/coin/"

If you want, you can specify additional arguments for your project.

The additional arguments must go after the options of "Realize"

$ realize add --path="/print/printer" --no-run yourParams --yourFlags // correct

$ realize add yourParams --yourFlags --path="/print/printer" --no-run // wrong

Remove a project by its name
```
$ realize remove --name="Project Name"
```
Lists all projects
```
$ realize list
```

Build, Run and watch file changes. Realize will re-build and re-run your projects on each change.

$ realize run

Fast run launches a project from its working directory without a config file

$ realize fast

The fast command supports the following custom parameters:

--build                 -> Enables the build   
--test                  -> Enables the tests   
--no-bin                -> Disables the installation
--no-run                -> Disables the run
--no-fmt                -> Disables the fmt (go fmt)
--config                -> Take the defined settings if exist a config file

The "fast" command supports addittional arguments as the "add" command.

$ realize fast --no-run yourParams --yourFlags // correct

$ realize fast yourParams --yourFlags --no-run // wrong

$ realize fast --path="/Users/alessio/go/src/github.com/tockins/realize-examples/coin/"

Color reference

Blue: outputs of the project
Red: errors
Magenta: times or changed files
Green: successfully completed action

Config file example

For more examples check Realize Examples

projects:
   - app_name: App One     -> name
     app_path: one         -> root path
     app_run: true         -> enable/disable go run (require app_bin)
     app_bin: true         -> enable/disable go install
     app_build: false      -> enable/disable go build
     app_fmt: true         -> enable/disable go fmt
     app_test: true        -> enable/disable go test
     app_params:           -> the project will be launched with these parameters
       - --flag1
       - param1
     app_watcher:
       preview: true       -> prints the observed files on startup
       paths:              -> paths to observe for live reload
       - /
       ignore_paths:       -> paths to ignore
       - vendor
       - bin
       exts:               -> file extensions to observe for live reload
       - .go
       output:             -> enable/disable the output destinations 
             cli: true         -> cli output
             file: true        -> creates an output file inside the project

Next release

Milestone 1.1

Testing on windows
Custom paths for the commands fast/add
Save output on a file
Enable the fields Before/After
Web panel - Maybe