# node-seo-validator
> SEO validator for static html file.
Latest version **1.0.2** (published 2018-12-10) · MIT license · 0 weekly downloads
## Install
```sh
npm install node-seo-validator
pnpm add node-seo-validator
yarn add node-seo-validator
bun add node-seo-validator
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-12-10 |
| First published | 2018-12-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 345.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | HungWei Kao |
| Maintainers | ricky155030 |
| Keywords | seo |
## Links
- npm: https://www.npmjs.com/package/node-seo-validator
- npm.io page: https://npm.io/package/node-seo-validator
## Dependencies (2)
- [cheerio](https://npm.io/package/cheerio.md) ^1.0.0-rc.2
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.1
## Recent versions
- 1.0.2 (latest) — 2018-12-10
- 1.0.1 — 2018-12-10
- 1.0.0 — 2018-12-10
## README
# node-seo-validator
SEO validator for static html file.
## Installation
```bash
yarn add node-seo-validator
# or
npm install --save node-seo-validator
```
## Test
```bash
yarn test
# or
npm test
```
## Usage
### seo(htmlFilePath, outputLogPath, applyRules)
**Parameters**
* `htmlFilePath`: Static html file input
* `outputLogPath`: Log path for output validation result
* `applyRules`: SEO rule names in array, these rule name should be configured in `src/rules.js`
Currently, there are 6 [Pre-defined SEO Rules](#pre-defined-seo-rules) in this package.
`IMG_ALT`, `HTML_A`, `HEADER_TITLE`, `HEADER_META`, `STRONG`, `H1`
```javascript
// test.js
const seo = require('node-seo-validator')
const applyRules = [
'IMG_ALT',
'HTML_A',
'HEADER_TITLE',
'HEADER_META',
'STRONG',
'H1'
]
seo('./index.html', './seo.log', applyRules)
```
**Output**
```bash
$ node test.js
Output file: ./seo.log
┌──────────────┬───────────────────────────────────────────────────┐
│ Rule Name │ Validate Result │
├──────────────┼───────────────────────────────────────────────────┤
│ IMG_ALT │ There are 27 ![]()
tag without attribute: alt │
├──────────────┼───────────────────────────────────────────────────┤
│ HTML_A │ There are 856 tag without attribute: rel │
├──────────────┼───────────────────────────────────────────────────┤
│ HEADER_TITLE │ Good │
├──────────────┼───────────────────────────────────────────────────┤
│ HEADER_META │ This HTML does not contain │
├──────────────┼───────────────────────────────────────────────────┤
│ STRONG │ Good │
├──────────────┼───────────────────────────────────────────────────┤
│ H1 │ Good │
└──────────────┴───────────────────────────────────────────────────┘
```
## Rule Configuration
You can define your SEO rules in `src/rules.js`
```javascript
/*
New rule to validate if
has been defined in
*/
const HEADER_META_ROBOTS = {
scope: 'head',
tag: 'meta',
upperBound: null,
lowerBound: null,
attribute: [
{ name: 'name', value: 'robots', type: 'one' }
]
}
```
| Key | Description | Sample Value |
|---|---|---|
| **scope** | Validate elements which are under this scope | `head` |
| **tag** | Which element you want to validate | `meta` |
| **upperBound** | Set upper bound limit to this **tag**
Set `null` to ignore this rule | `10` |
| **lowerBound** | Set lower bound limit to this **tag**
Set `null` to ignore this rule | `10` |
| **attribute** | Array of attribute rule object
Set `[]` to ignore this rule | ```[{ name: 'name', value: 'description', type: 'one' }]```
**Attribute Rule Object**
| Key | Description | Sample Value |
|---|---|---|
| **name** | Defined the attribute name to validate | `href` |
| **value** | Defined the value of this attribute to validate
Set `null` to ignore this rule | `https://github.com/` |
| **type** | Define this name/value rule should appear in at least one element or every elements | `one` or `every` |
## Pre-defined SEO Rules
There are some pre-defined rule in this package.
### 1. IMG_ALT
Detect if any `![]()
` tag without alt attribute.
### 2. HTML_A
Detect if any `` tag without rel attribute.
### 3. HEADER_TITLE
In `` tag, Detect if header doesn’t have `` tag.
### 4. HEADER_META
In `<head>` tag, Detect if header doesn’t have `<meta name="descriptions" ... />` and `<meta name="keywords" ... />` tag.
### 5. STRONG
Detect if there are more than 15 `<strong>` tag in HTML.
### 6. H1
Detect if a HTML have more than one `<H1>` tag.
---
_Source: https://npm.io/package/node-seo-validator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._