NeoSeo
SEO defects detector for node.js.
var NeoSeo = require('neo-seo')
var customConfigs = [
{
'ruleName': 'Rule: link with rel',
'tag': 'link',
'attributeName': 'rel',
'attributeType': 'with',
'minimum': 0
},
{
'ruleName': 'Rule: div with class d-flex'
'root': 'body',
'tag': 'div',
'attributeName': 'class',
'attributeValue': 'd-flex',
'attributeType': 'with',
'minimum': 2,
'maximum': 8
}
]
var disableList = [0, 1, 2]
var app = new NeoSeo(customConfigs, disableList)
// or use default settings
// var app = new NeoSeo()
var input = 'file_to_run_seo.html'
var output = 'export_report.txt'
app.getResult(input, output)Installation
This is a Node.js module available through the npm registry.
Before installing, download and install Node.js.
Installation is done using the
npm install command:
$ npm install neo-seoFeatures
- Input could be a file (HTML or txt), a Node Readable Stream, or a URL (http or https).
- Output coule be a file (string path), a Node Writable Stream, or a function such as Consoel.log.
- Build-in seven seo rules, and user could turn-off some of them.
- High flexibility custom rule by custom configuration setting.
- High test coverage
Docs
Input
- Use a file path as input:
var input = 'file_to_run_seo.html'
- Use a Node Readable Stream:
or
var input = fs.CreateReadStream()
var input = new stream.Readable() input.push('some data need to run seo') input.push(null)
- Use a URL
or
var input = 'http://some-url.to.run.seo/'
var input = 'https://https-url.to.run.seo/'
Output
- Use a file path as output:
var output = 'export_file.txt'
- Use a Node Writable Stream:
or
var output = fs.CreateWriteStream()
var output = process.stdout
- Use a Node function
var output = console.log
Rule Configuration Setting
-
Template
{ 'ruleName': 'The name of this rule', 'root': 'head', 'tag': 'meta', 'attributeName': 'name', 'attributeValue': 'descriptions', 'attributeType': 'with', 'minimum': null, 'maximum': 1 }
-
Property
-
ruleName: The name of this rule, which will show in the output message. User can use ruleName to disable default rules. (optional) -
root: The html section this rule will apply. For example,headmeans only search the head, andbodymeans only search the body.NULLmeans search the whole html file or data. (optional) -
tag: Which html tag we want to find. (required) -
attributeName: Which attribute in the tag we want to find. (optional) -
attributeValue: Which value of the attribute we want to find. (optional) -
attributeType: If we want to find the tagwithspecific attribute, usewithhere. Otherwise, usewithoutto get the opposite results. (optional) -
minimumandmaximum: Use these two numbers to define when this rule will be effective. For example,'minimum': nulland'maximum': 1means we want to check if this html file (or data) has less than 1 match. These two numbers are exclusively!
-
-
Example
- Using heading tag appropriately is good. We want to check if there are
<h2>tags in<body>section, and we hope there is at least one<h2>tag, but no more than 5.{ 'ruleName': 'Rule H2', 'root': 'body', 'tag': 'h2', 'minimum': 0, 'maximum': 5 }
- Using heading tag appropriately is good. We want to check if there are
Disabled List
- Use an array to list which default rule(s) should be disabled.
// disable the rule number 1, 2, 3 in default rules.
let disabledList = [1, 2, 3]// disable the rule by rule name.
let disabledList = ['No <title> tag in <haed>', '<img /> tag without alt attribute']Tests
$ npm install
$ npm testToDo
- More integration test cases about different input and output.
- More efficient way to parse html file (or data). I try to use
regular expression, it runs more quickly thancheerio.js(run some benchmarks). But I encountered problem intags or attributes with line breaker. Some other npm packages which are used to parse html have the same problem. - Better architecture...maybe after I study these three topics, I can it better.
- EventEmitter
- Stream
- Design Patterns in Node.js