Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/euanwm/modcheck

Go Mod checking tool
https://github.com/euanwm/modcheck

Last synced: 3 days ago
JSON representation

Go Mod checking tool

Awesome Lists containing this project

README

        

# Modcheck
[![codecov](https://codecov.io/gh/euanwm/modcheck/graph/badge.svg?token=D6038IV9I9)](https://codecov.io/gh/euanwm/modcheck)

If you're reading this, then Godspeed.

## Why

I made this tool to assess the state of a project's dependencies quickly. I wanted to know if any dependencies were not being used or were not being used by any other dependencies. I also wanted to know how widespread the dependencies were on GitHub, the codebase's quality, and the number of outstanding issues.

## Installation

`go install github.com/euanwm/modcheck/cmd/modcheck@latest`

## Usage

`modcheck `

The modcheck tool can be used in two ways:

- `modcheck`: without arguments, it will check the go.mod file in the current directory
- `modcheck /path/to/folder/`: with a path to a folder containing a go.mod file, it will check that go.mod file.

## Example output

![modcheck example output](example.png)

## Development requirements

- [GNU Make](https://www.gnu.org/software/make/)
- [Go](https://golang.org/), +v1.21 and above