https://github.com/grab/go-showdeps
https://github.com/grab/go-showdeps
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/grab/go-showdeps
- Owner: grab
- License: mit
- Created: 2022-11-03T07:42:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-03T10:24:10.000Z (about 3 years ago)
- Last Synced: 2025-01-14T09:36:35.661Z (about 1 year ago)
- Language: Go
- Size: 642 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
go-showdeps
An interactive terminal UI for navigating your Go project's dependencies.
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
## About The Project
[go-showdeps](https://github.com/grab/go-showdeps) is an interactive terminal UI for navigating your Go project's dependencies. It can be configured to highlight and rank packages according to custom rules.
## Getting Started
### Prerequisites
* Go 1.16+
### Installation
1. Install using Go
```sh
go install github.com/grab/go-showdeps@latest
```
## Usage
### Demo
### Quickstart
Run `go-showdeps` from the root of your Go project.
```
Usage of go-showdeps:
-c string
The path of the configuration file (shorthand)
-config-file string
The path of the configuration file
-path-prefix string
The prefix to strip from package names. Requires StripPath
-strip-path
If set, will strip PathPrefix from package names
Environment variables:
CONFIG string
STRIP_PATH bool
PATH_PREFIX string
```
### Configuration
Custom rules can be configured by creating a configuration file in the following locations (in order of priority):
1. A YAML file specified on the command-line via the `-c`/`--config-file` flag.
2. A `.go-showdeps.yml` file in the current directory.
3. `$HOME/.go-showdeps.yml`
Example configuration file:
```yaml
---
rules:
- regex: internal/
label: Internal package
color: '#aa0000'
priority: 9
- regex: ^github
label: Package from GitHub
color: '#007700'
priority: 1
```
## Go Modules
[go-showdeps](https://github.com/grab/go-showdeps) expects to run with Go modules enabled for best results. However, if you experience slowness in large projects it may be possible to speed it up by setting `GO111MODULE=off`.
## Roadmap
See the [open issues](https://github.com/grab/go-showdeps/issues) for a full list of proposed features (and known issues).
## Contributing
If you have a suggestion that would make this project better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
## License
Distributed under the MIT License. See [LICENSE](https://github.com/grab/go-showdeps/blob/main/LICENSE) for more information.
## Contact
Project Link: [https://github.com/grab/go-showdeps](https://github.com/grab/go-showdeps)
[contributors-shield]: https://img.shields.io/github/contributors/grab/go-showdeps.svg?style=for-the-badge
[contributors-url]: https://github.com/grab/go-showdeps/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/grab/go-showdeps.svg?style=for-the-badge
[forks-url]: https://github.com/grab/go-showdeps/network/members
[stars-shield]: https://img.shields.io/github/stars/grab/go-showdeps.svg?style=for-the-badge
[stars-url]: https://github.com/grab/go-showdeps/stargazers
[issues-shield]: https://img.shields.io/github/issues/grab/go-showdeps.svg?style=for-the-badge
[issues-url]: https://github.com/grab/go-showdeps/issues
[license-shield]: https://img.shields.io/github/license/grab/go-showdeps.svg?style=for-the-badge
[license-url]: https://github.com/grab/go-showdeps/blob/master/LICENSE