Introduction to go-mod-upgrade
The project "go-mod-upgrade" is a convenient tool designed for developers working with the Go programming language. Its primary function is to aid in updating outdated dependencies within Go modules interactively.
Purpose
The rationale behind developing this tool stems from the complexities encountered when updating Go dependencies. While the Go programming language provides a method for listing available updates for direct dependencies, executing these updates can be cumbersome and not straightforward. The command go list -u -f '{{if (and (not (or .Main .Indirect)) .Update)}}{{.Path}}: {{.Version}} -> {{.Update.Version}}{{end}}' -m all 2> /dev/null identifies outdated dependencies but doesn't facilitate easy updating of multiple dependencies at once. This tool attempts to simplify this process, making it akin to the functionality provided by "yarn upgrade-interactive" for JavaScript, tailored specifically for Go.
Installation
Users can easily access pre-compiled binaries suitable for Windows, OS X, and Linux from the releases page. For those who prefer using the Go toolchain, installation is as simple as executing the command:
go install github.com/oligot/go-mod-upgrade@latest
Usage
Once installed, developers can employ go-mod-upgrade within any Go project that uses modules. The tool highlights each module's name with color codes to indicate the type of update available:
- Green denotes a minor update.
- Yellow indicates a patch update.
- Red signifies a prerelease update.
These color-coded indicators help developers quickly identify the nature of available updates.
Moreover, go-mod-upgrade offers several global command-line interface options to enhance its functionality:
- Page Size Option: Customize the display page size for updates.
- Force Update Mode: Update all modules automatically without interaction.
- Verbose Mode: Get detailed information during the upgrade process.
- Hooks: Execute specific commands for each updated module.
- Ignore Option: Skip updates for modules matching a specified pattern.
- Help and Version Commands: Assist users with general help or provide version details.
By incorporating these features, "go-mod-upgrade" delivers a powerful yet user-friendly approach to maintaining Go projects up-to-date, ensuring smooth workflow without manual intervention for every dependency update.