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

videojs-generator-verify

v4.1.3

Published

A tool to verify that a generator-videojs-plugin project is ready for publish.

Downloads

2,224

Readme

videojs-generator-verify

Build Status Greenkeeper badge Slack Status

NPM

A tool to verify that a generator-videojs-plugin project is ready for publish.

Maintenance Status: Stable

Installation

Install videojs-generator-verify and in-publish via npm

$ npm install --save-dev videojs-generator-verify in-publish

Then add a script to your package.json as follows:

{
  "scripts": {
    "prepublish": "not-in-install && npm run build && vjsverify || in-install"
  }
}

Usage

Command line

This package provides two binaries videojs-generator-verify and vjsverify. vjsverify is just an alias to videojs-generator-verify.

The cli has the following options:


  Usage: vjsverify [--verbose|--quiet|--skip-es-check]

  A tool to verify that a generator-videojs-plugin project is ready for publish.

  -v, --version       Print the version of videojs-generator-verify.
  -V, --verbose       Print all results, even successful ones.
  -q, --quiet         Don't print anything.
  -d, --dir [dir]     Run in this project directory, defaults to cwd.
  --skip-es-check     skip the syntax check, still here for backwards compatablity
  --skip-[name]       skip a test that you do not want to run. install, syntax, fields, require

API

It is also possible to require this package, and run the verify function manually. It takes several options in as an object and returns a promise that is resolved to 0 on success and 1 on failure.

Options

Options are passed in an object by key/value.

Example

const vjsverify = require('videojs-generator-verify');
const opitons = {verbose: true};

vjsverify(options).then(function(exitCode) {
  process.exit(exitCode);
}).catch(function(e) {
  console.error('Uh oh, internally vjsverify error', e);

  process.exit(1);
});
verbose

Type: boolean Default: false

Print all results, even for success. By default only errors are printed.

quiet

Type: boolean Default: false

Do not print anything.

dir

Type: string Default: process.cwd()

Run vjsverify in a specific directory. Note that this directory must exist and contain a package.json.

skip

Type: array Default: []

Skip a tests that are not relevant for your project. valid checks: require, syntax, fields, install

What is tested

This package tests three things:

  1. Do all the files referenced in package.json point to a file that exists
  2. Will the package be installable from npm after publish
  3. Are the dist files all using es5 syntax, unless --skip-es-check is passed.

License

Apache-2.0. Copyright (c) Brightcove, Inc.