Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/bmuschko/link-verifier

A tool for verifying links in text-based files
https://github.com/bmuschko/link-verifier

asciidoc checker go golang link markdown verification

Last synced: 7 days ago
JSON representation

A tool for verifying links in text-based files

Host: GitHub
URL: https://github.com/bmuschko/link-verifier
Owner: bmuschko
License: apache-2.0
Created: 2017-06-04T02:24:19.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-08-17T20:52:24.000Z (3 months ago)
Last Synced: 2024-08-17T21:35:24.230Z (3 months ago)
Topics: asciidoc, checker, go, golang, link, markdown, verification
Language: Go
Homepage:
Size: 150 KB
Stars: 27
Watchers: 2
Forks: 10
Open Issues: 3
Metadata Files:
- Readme: README.adoc
- License: LICENSE

Awesome Lists containing this project

README

= Link Verifier image:https://travis-ci.org/bmuschko/link-verifier.svg?branch=master["Build Status", link="https://travis-ci.org/bmuschko/link-verifier"] image:https://goreportcard.com/badge/github.com/bmuschko/link-verifier["Go Report Card", link="https://goreportcard.com/report/github.com/bmuschko/link-verifier"] image:https://codecov.io/gh/bmuschko/link-verifier/branch/master/graph/badge.svg["Codecov", link="https://codecov.io/gh/bmuschko/link-verifier"]

A tool for verifying links in text-based files. Written in Go, available as executable.

image:https://user-images.githubusercontent.com/440872/27007990-1184b292-4e34-11e7-8417-fc62542250b5.jpg["Logo"]

== Motivation

Ambitious tech writers use plain-text mark-up formats like link:http://asciidoc.org/[AsciiDoc] and
link:https://daringfireball.net/projects/markdown/[Markdown] for turning text into properly formatted blog posts, web
pages and documentation. Incorporating URLs to refer to external resources is part of the process. Before publishing
content it's important to verify that linked URLs are valid and can be resolved. Nothing feels more unprofessional than broken
links in a carefully crafted document.

Link verifier to the rescue! Automatically discover all mark-up files in a given directory and verify all links
found in the documents before publishing them.

== Installation

=== Prebuilt libraries

link:https://github.com/bmuschko/link-verifier/releases[Prebuilt libraries for various platforms] are available on GitHub.
Just download, exact the archive and execute the binary.

=== Building from source

Building from source requires that you have link:https://golang.org/doc/install[Go] installed on your machine.

```
go get -u -v github.com/bmuschko/link-verifier
```

Run the program with `link-verifier` from anywhere in the file system.

== Command line options

[cols="1,1,2", options="header"]
.Parameters
|===
|Option
|Description
|Default Value

|`dirs`
|The comma-separated root directories used to recursively search for files.
|[.]

|`includes`
|The comma-separated include patterns used to search for files.
|[\*.md,*.adoc]

|`ignore-status-codes`
|The comma-separated HTTP response status codes that will be ignored for validation. For example, some sites block crawlers and return with a specific response code.
|[]

|`fail`
|Fails the program if at least one discovered link cannot be resolved.
|true

|`timeout`
|The timeout in seconds used when calling the URL.
|5
|===

**Example**:

```
link-verifier --dirs data,content --include *.html,*.yml --fail=false
```

== Usage on CI

Integrating the tool with a build on CI is a breeze and can used as validation step before publishing mark-up files.

=== Travis CI

The following `.travis.yml` demonstrate the use of the prebuilt binary version on Linux 64 bit:

``` yaml
before_script:
- wget https://github.com/bmuschko/link-verifier/releases/download/v0.1/link-verifier-0.1-linux64.tar.gz -O /tmp/link-verifier.tar.gz
- tar -xvf /tmp/link-verifier.tar.gz
- export PATH=$PATH:$PWD/link-verifier/

script:
- ./link-verifier
```

== Contribute!

It's easy to contribute to this project. Install link:https://golang.org/doc/install[Go] >= 1.11. Then run the following commands to get the source code, resolve external dependencies
and build the project.

```
git clone https://github.com/bmuschko/link-verifier.git
cd link-verifier
go build
```