npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gardr-validator

v1.1.0

Published

garðr-validator =========

Downloads

30

Readme

garðr-validator

Collect data from a display-ads lifecyle and validate the data. This project tries to give a nice framework for doing this.

Build Status Coverage Status NPM version Dependency Status devDependency Status

Installation

$ npm install

Examples

See the web-gui for this project: https://github.com/gardr/validator-web/blob/master/lib/routes/validate.js#L284

Writing intrumentation and validators

Intrument / Hook example filename: 'someData.js':
module.exports = {
    'onBeforeExit': function (api, config) {
        api.switchToIframe();
        if (config.someConfigBoolean){
            api.set('collectedData', api.evaluate(function(config){
                return window.someData;
            }, config));
        }
    }
};
Preprocessor example filename 'fixSomethingAsync.js'
module.exports = {
    'dependencies': ['someData'],
    'preprocess': function(harvested, output, next, globalOptions){
        output('someKey', {data: harvested.someData||{}});
        setTimeout(next, 1);
    }
};
Validator example filename 'someData.js'
module.exports = {
    'preprocessors': [
        'fixSomethingAsync'
    ],
    'dependencies': [
        'someData'
    ],
    'validate': function(harvested, report, next, globalOptions){
        if (this.someConfigBoolean){
            if (harvested.someData){
                report.error('Some message');
            }
        }
    }
};
Adding instrumentation/hooks etc to a run
var run = require('gardr-validator');
var options = {
    'include': [
        {
            name: 'someData',
            path: '/resolved/path/to/someData.js'
        }
    ],
    'config':{
        'someData': {
            'someConfigBoolean': true
        }
    }
};
run(options, function(phantomError, harvest, report){
    if (phantomError){
        // do something
        return;
    }
    assert(harvest.someData);
    assert(harvest.someKey);
    assert(report.errors.length === 1);
})

Options to runner

{
    instrument: [
        'actions', // defaults to files in /lib/rule/instrument/actions.js
        {name: 'css'},
        {name: 'custom', path: '/absolute/path/to/file'},
        {name: 'custom2', code: 'var someCode = "";'}
    ],
    preprocess: [
        //..
    ],
    validate: [
        //..
    ]
    //rest of runner default options, see /config folder.
}

Contributing

YES, pull requests with tests. Be sure to create a issue and let us know you are working on it - maybe we can help out with insights etc.

Running tests

$ npm test

Configuration options via process.env / ENV variables

- GOOG_PAGESPEED_API_KEY
- GOOG_SAFE_BROWSE_API_KEY
Alternatives

(please let us know of alternatives to this project)