Light

rakasha / seo_defect Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 263 KB

License: MIT License

JavaScript 100.00%

seo_defect's Introduction

dom-defect

Detect defections from HTML DOM-Elements

Installation

npm install domdefect

Usage

Initialize the client

const domdefect = require('domdefect');
let detector = new domdefect.Detector();

Set the rules for the detector

// Using pre-defined rule
const {rules} = domdefect;
detector.rules_to_apply = [rules.PREDEFINED[0], rules.PREDEFINED[1]]
// Or customize your rule from Meta rules
let myRule = rules.Meta.checkNumberOfSelected('strong', '<', 2);
let myRule2 = rules.Meta.checkElementAttributes('input', ['value', 'id', 'yo']);
detector.rules_to_apply.push(myRule);
detector.rules_to_apply.push(myRule2);

Load the HTML from source (URL or file path). Then run the detector to get the report.

// Load HTML then run validations
// You can also load HTML from file by passing file path
// like: setDocumentSource('index.html')
detector.setDocumentSource('http://www.example.com')
 .then( () => {
    detector.run();
    
    // Aftter running , the results is stored 
    // in the `report` object in JSON format:
    detector.report.detail()
    
    // You can pretty-print the data
    detector.report.print();
    
    // Output the report into file
    detector.report.toFile('myreport.txt').then(...);
    
    // Or write into a writable stream
    detector.report.writeToStream(stream).then(...);
    
 });

How to cusomize rules for the detector

Using the high order functions defined in lib/rules.js.

For exmaple, calling

const {rules} = require('domdefect');
let myRule = rules.Meta.checkNumberOfSelected('strong', '<', 2);

Generates a rule which checks if the number of <strong> tags is less than 2

API

(TBD)

Test

npm test

                       _oo0oo_
                      o8888888o
                      88" . "88
                      (| -_- |)
                      0\  =  /0
                    ___/`---'\___
                  .' \\|     |// '.
                 / \\|||  :  |||// \
                / _||||| -:- |||||- \
               |   | \\\  -  /// |   |
               | \_|  ''\---/''  |_/ |
               \  .-\__  '-'  ___/-. /
             ___'. .'  /--.--\  `. .'___
          ."" '<  `.___\_<|>_/___.' >' "".
         | | :  `- \`.;`\ _ /`;.`/ - ` : | |
         \  \ `_.   \_ __\ /__ _/   .-` /  /
     =====`-.____`.___ \_____/___.-`___.-'=====
                       `=---='


     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

                       佛系開發

seo_defect's People

Contributors

Watchers

seo_defect's Issues

Check if the format of input HTML is correct

The detector should tells if user inputs an invalid HTML file (or source)

Provide detailed information in the generated reports

Currently we just include the success and failures:

reportData = {
  success: ['rule 1', 'rule2'],
  failed: ['rule3', 'ruleA'],
}

Would be better to provide extra information for each applied rules (or DOMs)

Include the location of the defective `DOM` in the validation results

Use a more standardized project structure

Add README file for how to use the client

Check README.md

Use function reference instead of string tokens to assemble the DOM-checking rules.

Change the data structure for representing a Rule :
from ["DOM-selector name", "DOM-validator name"]
to [dom_selector_function, dom_validator_function]

Currently the checking-rules are represented by an array of strings which consists of the name of DOM-selector function and DOM-validation function.

For example, the predefined rule "all images have alt text": ["All <img> tags", "all have attributes alt"] means that when validating the HTML DOMs it will:

Lookup the DOM-Selector function with the name "All <img> tags" and use it to acquire the DOM(s)
Lookup the validation function "all have attributes alt" and use it to verify the DOMs

For keeping things simple we should use function reference instead of string

Publish to NPM registory

References:

Add pre-commit hooks for testings

Linter
Unit test

Allow various output format

According to this note
We should at least provide the following output format:

Console
A file (User is able to config the output destination)
Node Writable Stream (definition, detail)

Checklist:

Console (human readable)
File (configurable path)
Node writable stream
(Not Mandatory) Structured data in JSON

Allow setting HTML from various input sources

Allow setting HTML from the following input:

From file
From URL
From Node.js Readable Stream

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.