https://github.com/adamshannag/goant
run command line tools based on go annotations
https://github.com/adamshannag/goant
annotations go tool
Last synced: 1 day ago
JSON representation
run command line tools based on go annotations
- Host: GitHub
- URL: https://github.com/adamshannag/goant
- Owner: AdamShannag
- License: mit
- Created: 2025-08-29T17:06:44.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2025-08-30T17:23:45.000Z (10 months ago)
- Last Synced: 2025-10-01T17:43:42.197Z (9 months ago)
- Topics: annotations, go, tool
- Language: Go
- Homepage:
- Size: 22.5 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# Goant
Goant is a lightweight tool for scanning Go projects for annotated types or interfaces and running commands dynamically
based on those annotations. It works with any tool that can be triggered from the command line.
## Installation
You can install and run Goant in two ways:
### 1. Install via `go install`
```bash
go install github.com/AdamShannag/goant/cmd/goant@v0.3.0
```
Then run it directly:
```bash
goant -keyword=myAnnotation -cmd="your command here"
```
### 2. Run directly with `go run`
```bash
go run github.com/AdamShannag/goant/cmd/goant@v0.3.0 -keyword=myAnnotation -cmd="your command here"
```
## Flags
* `-root` – Root directory to start scanning Go files (default: `.`).
* `-keyword` – Comment keyword to search for, e.g. `gomock`.
* `-cmd` – Command template with placeholders.
* `-dry` – Print the commands that would be executed without actually running them.
* `-s` – Suppress all output.
* `-skip` – Comma-separated list of directories to skip.
* `-version` – Print Goant version and exit.
## Example
Suppose you have an interface annotated like this:
```go
// gomock:package=user_mock out=.gen/mocks/user_mock/mock_repo.go
type Repository interface {
Create(ctx context.Context, user domain.User) (domain.User, error)
}
```
Run Goant:
```bash
goant -keyword=gomock -cmd="go run go.uber.org/mock/mockgen@v0.1.0 -destination=@out -package=@package -source=@path @type"
```
Goant will substitute placeholders:
* `@out` → `.gen/mocks/user_mock/mock_repo.go`
* `@package` → `user_mock`
* `@path` → `./internal/repository/user/repository.go`
* `@type` → `Repository`
And then execute the generated command.
## Placeholders
### Automatic placeholders
These are resolved automatically by Goant:
- `@path` – Relative path to the Go file.
- `@type` – Name of the type.
### Custom placeholders
Any additional parameters provided in the annotation are also available as placeholders.
For example, if your annotation includes out=... and package=..., then @out and @package become available in the command
template.
You are free to define any parameter names in the annotation, and Goant will substitute
them accordingly.
## Multiple Annotations
Goant supports having **multiple annotations on a single type or interface**. Each annotation is independent and can be
associated with different tools or commands. You can also repeat the **same annotation keyword** with different
parameters. In this case, Goant will run each
annotation separately using its respective parameters.
Example:
```go
// gomock:package=user_mock out=.gen/mocks/user_mock/mock_repo.go
// myTool:echo=hello
// myTool:echo=world
type Repository interface {
Create(ctx context.Context, user domain.User) (domain.User, error)
}
```
* The first annotation uses the `gomock` keyword with parameters for mock generation.
* The second and third annotations both use the `myTool` keyword but with different `echo` values. Goant will run **each
annotation separately**, substituting the appropriate parameters.
This allows you to define multiple commands for the same type, either using **different keywords** or the **same keyword
with different parameter sets**.
## License
[MIT](LICENSE)
## Contribution
Contributions are welcome! If you have ideas, bug reports, or improvements, please open an issue or submit a pull
request.