https://github.com/n25a/doc-hunt

Check godoc in your project
https://github.com/n25a/doc-hunt

go godoc golang

Last synced: 3 months ago
JSON representation

Check godoc in your project

• Host: GitHub
• URL: https://github.com/n25a/doc-hunt
• Owner: n25a
• License: mit
• Created: 2022-09-08T11:47:05.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-09-10T09:14:02.000Z (about 3 years ago)
• Last Synced: 2024-06-20T12:37:57.778Z (over 1 year ago)
• Topics: go, godoc, golang
• Language: Go
• Homepage:
• Size: 16.6 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![alt text](https://raw.githubusercontent.com/n25a/doc-hunt/1f3b6c85b8d1d7050299e08d05df1bc835bab243/images/logo.png)

# Doc-Hunt

Doc-Hunt is godoc checker in project.

## Usage

You can install it by following command.

```bash

go get github.com/n25a/doc-hunt

```

Then, you can run it by following command.

```bash

doc-hunt hunt --dir "/path/to/project"

```

## Options

You can use these flags to execute doc-hunt files or directory.

|      flag      |        description         |

|:--------------:|:--------------------------:|

| --exclude-path | Set directories to ignore  |

| --exclude-file |    Set files to ignore     |

## Reports

Doc-Hunt print a report in terminal.

If your code have some problems, it will print a report like this:

![alt text](https://raw.githubusercontent.com/n25a/doc-hunt/1f3b6c85b8d1d7050299e08d05df1bc835bab243/images/failed.png)

If your code have no problems, it will print a report like this:

![alt text](https://raw.githubusercontent.com/n25a/doc-hunt/1f3b6c85b8d1d7050299e08d05df1bc835bab243/images/Success.png)