Crate grink 

grink

Grink is a tool to find and check web links in text files (for example, Markdown source files). It “greps links”, if you will.

Installation

cargo install grink

Usage

Grink reads all the files you specify, extracts anything that looks like a URL, and checks if it returns an OK status, reporting the error otherwise.

grink book/*.md

[ERROR] (HTTP status client error (404 Not Found) for url (https://example.com/bogus)) https://example.com/bogus - referrer: book/chapter1.md
Links: 8 (7 OK, 1 errors, 0 warnings, 0 ignored)

Ignoring certain domains

If you want Grink to ignore all links to certain domains (for example, because you know that domain always returns a bogus response status), put these domains in a file, one per line, like this:

bogus.com
sketchy.com
ignoreme.com

Then use the --ignore flag to pass that domains file to Grink:

grink --ignore domains.txt book/*.md

Links: 8 (5 OK, 0 errors, 0 warnings, 3 ignored)

Structs

Link

Enums

Status

Functions

read_ignore_domains

Returns a list of domains from ignore_file, one per line.

scan

Scans all the files in paths for HTTP URLs, and returns a stream of Link results as they are checked.