A library to validate SEO tags for html payloads.
- Validates the basic seo friendly rules.
- Customisable config file to add other rules for validation.
- Check for a
titletag. - Check if every
imgtag has analtattribute. - Check for
metatag withnameattribute and valuedescription. - Check for
metatag withnameattribute and valuekeywords. - Check if the number of
h1tags exceed count of1. - Check if the number of
strongtags exceed count of15.
//Function for html payload validation.
const validator = require('seo-tags-validator');
validator(htmlBody,tagstoValidate);
The validator function accepts two arguments:
- The html payload to be validated.
- The tags to be validated as an array. If empty validates the html payload against all the rules.
//Function for html file validation.
const validatorFs = require('seo-tags-validator');
validatorFs(htmlFilePath,tagsToValidate);
The validatorFs function accepts two arguments:
- The html file path to be validated.
- The tags to be validated as an array. If empty validates the html payload against all the rules.
const validator = require('seo-tags-validator');
validator(`<html><head><meta name="description" content=""/></head><body><img /></body></html>`);
WARNING : No <title> tag(s)
WARNING : Line: 1 <img> tag doesn't have attribute: "alt" or is empty
INFO : No <a> tags
INFO : No <h1> tag(s)
INFO : No <strong> tag(s)
WARNING : Line: 1 <meta> tag with attribute: "name" and value "description" doesn't have content attribute
WARNING : <meta> tag with attribute: "name" and value: "keywords" doesn't exist
The config file can be appended with other customisable rules. Below is the template for the rules currently supported.
| Rule | Description |
|---|---|
| { "tag": "title" } | To check if the tag title exists in the html payload |
| {"tag": "img","attribute": "alt"} | To check if every tag img has the attribute alt
|
| {"tag":"h1","count":1} | To check if the tag h1 exceeds the given count
|
| {"tag": "meta","attribute":{"key":"name","value":"keywords"} } | This rule is specific for meta tags: But can be used for checking if tag meta has attribute name and value keywords
|
Replace the tags and attributes with any of your specific requirements.