https://github.com/Munter/netlify-plugin-checklinks

Netlify build plugin check your links and asset references
https://github.com/Munter/netlify-plugin-checklinks

Last synced: about 2 months ago
JSON representation

Netlify build plugin check your links and asset references

• Host: GitHub
• URL: https://github.com/Munter/netlify-plugin-checklinks
• Owner: Munter
• License: bsd-3-clause
• Created: 2019-10-21T20:16:56.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-06T20:49:36.000Z (over 1 year ago)
• Last Synced: 2024-04-24T04:11:57.377Z (5 months ago)
• Language: JavaScript
• Size: 12.4 MB
• Stars: 87
• Watchers: 5
• Forks: 9
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Netlify Checklinks Build Plugin

[![NPM version](https://badge.fury.io/js/netlify-plugin-checklinks.svg)](http://badge.fury.io/js/netlify-plugin-checklinks)

[![Build Status](https://travis-ci.org/Munter/netlify-plugin-checklinks.svg?branch=master)](https://travis-ci.org/Munter/netlify-plugin-checklinks)

[![Coverage Status](https://img.shields.io/coveralls/Munter/netlify-plugin-checklinks.svg)](https://coveralls.io/r/Munter/netlify-plugin-checklinks?branch=master)

[![Dependency Status](https://david-dm.org/Munter/netlify-plugin-checklinks.svg)](https://david-dm.org/Munter/netlify-plugin-checklinks) [![Greenkeeper badge](https://badges.greenkeeper.io/Munter/netlify-plugin-checklinks.svg)](https://greenkeeper.io/)

Checklinks helps you keep all your asset references correct and avoid embarrassing broken links to your internal pages, or even to external pages you link out to.

Checklinks will traverse your pages dependency graph and report on any missing assets. It will find broken links, broken fragment links, inefficient redirect chains and potential mixed content warnings.

Under the hood the [hyperlink](https://www.npmjs.com/package/hyperlink) package is doing all the work. If you

need more granular control or want to add a different [TAP-reporter](https://www.npmjs.com/search?q=tap%20reporter) you can opt to use hyperlink directly in your own build tooling instead of using this plugin.

## Installation

You can install this plugin in the Netlify UI from this [direct in-app installation link](https://app.netlify.com/plugins/netlify-plugin-checklinks/install) or from the [Plugins directory](https://app.netlify.com/plugins).

For file-based installation, add the following lines to your `netlify.toml` file:

```toml

[[plugins]]

package = "netlify-plugin-checklinks"

```

Note: The `[[plugins]]` line is required for each plugin, even if you have other plugins in your `netlify.toml` file already.

To complete file-based installation, from your project's base directory, use npm, yarn, or any other Node.js package manager to add the plugin to `devDependencies` in `package.json`.

```bash

npm install -D netlify-plugin-checklinks

```

## Configuration

Checklinks works out of the box, but can be improved upon with some improved knowledge about your site.

These are the configuration options with their default values:

```toml

[[plugins]]

package = "netlify-plugin-checklinks"

  [plugins.inputs]

  # An array of glob patterns for pages on your site

  # Recursive traversal will start from these

  entryPoints = [

    "*.html",

  ]

  # Recurse through all the links and asset references on your page, starting

  # at the entrypoints

  recursive = true

  # Checklinks outputs TAP (https://testanything.org/tap-version-13-specification.html)

  # by default. Enabling pretty mode makes the output easier on the eyes.

  pretty = true

  # You can mark some check as skipped, which will block checklinks

  # from ever attempting to execute them.

  # skipPatterns is an array of strings you can match against failing reports

  skipPatterns = []

  # You can mark some check as todo, which will execute the check, but allow failures.

  # todoPatterns is an array of strings you can match against failing reports

  todoPatterns = []

  # Report on all broken links to external pages.

  # Enabling this will make your tests more brittle, since you can't control

  # external pages.

  checkExternal = false

  # Enable to check references to source maps, source map sources etc.

  # Many build tools don't emit working references, so this is disabled by default

  followSourceMaps = false

```

## License

[BSD 3-Clause License]()