Skip to content

n25a/doc-hunt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

alt text

Doc-Hunt

Doc-Hunt is godoc checker in project.

Usage

You can install it by following command.

go get github.com/n25a/doc-hunt

Then, you can run it by following command.

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

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