seo-defect-checker

0.1.0 • Public • Published

A module to check whether site is SEO friendly or not.


Basic usage

const checker = require('./checker');
checker.check('./sample/sample.html');

API

checker.check(input, output, rules)

Parameter

  • input: can be either filePath or stream
  • output: can be either file output path or stream, default to console
  • rules: array of rules, it omitted will use predefined 7 rules

User is free to compose rules in any order

const Rules = require('./predefined-rules');
 
var rules = [
    Rules.MoreThan15StrongTagRule,
    Rules.ImgTagWithoutAltRule,
    Rules.MissingDescriptionInHeadTagRule
];
checker.check('./sample/sample.html', console, rules);

Default Rules.

const Rules = require('./predefined-rules');
Rules.ImgTagWithoutAltRule,
Rules.ATagWithoutRelRule,
Rules.MissingTitleInHeadTagRule,
Rules.MissingDescriptionInHeadTagRule,
Rules.MissingKeywordsInHeadTagRule,
Rules.MoreThan15StrongTagRule,
Rules.MultipleH1TagRule

Custom rules

For e.g. Checking if <meta name=“robots” /> exists

const {
    TagCountRule,
    TagWithoutAttributeRule,
    TagCountExceedThresholdRule 
= require('./rules');
 
const customRules = new TagCountRule((count) => {
    return "Your msg"
}, 'meta[name="robots"]', (c) => {
    return c > 0
});

For more information take a look at rules.js

Readme

Keywords

none

Package Sidebar

Install

npm i seo-defect-checker

Weekly Downloads

2

Version

0.1.0

License

MIT

Unpacked Size

186 kB

Total Files

18

Last publish

Collaborators

  • thinhlam