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

adviser-plugin-webhint

v1.0.1

Published

Plugin for adviser to run webhint audits on a given URL

Downloads

126

Readme

adviser-plugin-webhint

Plugin for adviser to run webhint hints checking on a given URL

Installation

You'll first need to install Adviser:

$ npm i adviser --save-dev

Next, install adviser-plugin-webhint:

$ npm install adviser-plugin-webhint --save-dev

Note: If you installed Adviser globally (using the -g flag) then you must also install adviser-plugin-webhint globally.

Usage

Add webhint to the plugins section of your .adviserrc configuration file. You can omit the adviser-plugin- prefix:

{
  "plugins": ["webhint"]
}

If you don't have a .adviserrc you can create one running $ adviser --init

Then configure the rules you want to use under the rules section. You can ignore any of webhint's hints and set a minimum severity

{
  "plugins": ["webhint"],
  "rules": {
    "webhint/hints": [
      "error",
      {
        "ignore": ["http-cache"],
        "minSeverity": 3
      }
    ]
  }
}

You can also create a webhint configuration file following webhint configurations https://webhint.io/docs/user-guide/configuring-webhint/summary/

Full example

{
  "plugins": ["webhint"],
  "rules": {
    "webhint/hints": [
      "error",
      {
        "ignore": ["http-cache"],
        "minSeverity": 3
      }
    ]
  },
  "settings": {
    "webhint": {
      "url": "www.google.com",
      "configPath": "dev.wh.config.json"
    }
  }
}

Tests

If you would like to contribute and later on test your changes there are a couple ways explained below.

Unit code

The package (adviser-plugin-webhint) is setup to run tests under the folder __tests__ with Jest. Save your tests there and they will run before each code push and by travis once the PR is created.

Integration tests

To run your rules with adviser, we recommend you to create an empty folder (We have one under ./examples/integration) with:

  • An example package.json
  • An adviser configuration file. You can grab the example in this README or generate one using $ adviser --init (adviser must be installed globally or using npx)
  • Link this repo to the example project.
    • Run $ npm link in the adviser-plugin-webhint root
    • Run $ npm link adviser-plugin-webhint in the example project root

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Supported Rules

  • hints - Inspect the webhint hints

License

MIT