textlint-rule-no-dead-link

textlint rule to make sure every link in a document is available.

The primary target of this rule is Markdown documents, but it also works on plain text documents (See tests).

Installation

$ npm install textlint-rule-no-dead-link

Usage

$ npm install textlint textlint-rule-no-dead-link
$ textlint --rule textlint-rule-no-dead-link text-to-check.txt

Features

Dead Link Detection

Shows an error if a link is dead (i.e. its server returns one of the "non-ok" responses).

Obsolete Link Detection

Shows an error if a link is obsolete or moved to another location (i.e. its server returns one of the "redirect" responses).

This error is fixable and textlint will automatically replace the obsolete links with their new ones if you run it with --fix option.

Relative Link Resolution

Sometimes your files contain relative URIs, which don't have domain information in an URI string. In this case, we have to somehow resolve the relative URIs and convert them into absolute URIs.

The resolution strategy is as follows:

1. If baseURI is specified, use that path to resolve relative URIs (See the below section for details).
2. If not, try to get the path of the file being linted and use its parent folder as the base path.
3. If that's not available (e.g., when you are performing linting from API), put an error Unable to resolve the relative URI.

Options

Please write your configurations in .textlintrc.

The default options are:

{
  "rules": {
    "no-dead-link": {
      "checkRelative": true,
      "baseURI": null,
      "ignore": [],
      "preferGET": []
    }
  }
}

checkRelative

This rule checks the availability of relative URIs by default. You can turn off the checks by passing false to this option.

baseURI

The base URI to be used for resolving relative URIs.

Though its name, you can pass either an URI starting with http or https, or an file path starting with /.

Examples:

"no-dead-link": {
  "baseURI": "http://example.com/"
}

"no-dead-link": {
  "baseURI": "/Users/textlint/path/to/parent/folder/"
}

ignore

An array of URIs to be ignored. These URIs will be skipped from the availability checks.

Example:

"no-dead-link": {
  "ignore": [
    "http://example.com/not-exist/index.html",
    "http://example.com/*"  # Glob format
  ]
}

preferGET

An array of origins to lets the rule connect to the origin's URL by GET instead of default HEAD request.

Although the rule will fall back to GET method when HEAD request is failed (status code is not between 200 and 300), in order to shorten time to run your test, you can use this option when you are sure that target origin always returns 5xx for HEAD request.

Example:

"no-dead-link": {
  "preferGET": [
    "http://example.com"
  ]
}

Tests

npm test

Contribution

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

MIT License (http://nodaguti.mit-license.org/)