netlify-plugin-seo-lint
v0.4.0
Published
Netlify plugin to add SEO linting to builds
Downloads
3
Maintainers
Readme
netlify-plugin-seo-lint
This plugin adds SEO checks to the files generated in your Netlify build, using @nickreese/seo-lint.
Installation
Add the plugin to your netlify.toml
:
[[plugins]]
package = "netlify-plugin-seo-lint"
[plugins.inputs]
threshold = "warning"
Install to your devDependencies
with npm:
npm i -D netlify-plugin-seo-lint
The plugin will run as part of your build, running SEO lint checks against the publish directory. The build will fail if any linting issues exceed the configured threshold
.
Configuration
The following configuration options can be used:
host
: The host used to determine internal links. Defaults to Netlify'sURL
inproduction
context, orDEPLOY_PRIME_URL
in other contexts. See Netlify's build environment variables and deploy contexts.threshold
: The minimum priority that should be considered a build failure. Can be eithererror
orwarning
which will be compared against the test's level, or an integer which will be compared against the test's priority. Defaults toerror
.verbose
: Output all errors/warnings, even those below the threshold. Defaults totrue
.internalLinksLowerCase
: Whether internal links should be checked to be lower case. Defaults totrue
.internalLinksTrailingSlash
: Wether internal links should contain a trailing slash. Defaults totrue
.