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

@probablyup/mock-private-registry

v1.1.0

Published

Mock of a private npm registry, useful for testing npm-related stuff

Downloads

3

Readme

@probablyup/mock-private-registry

Mock of a private npm registry, useful for testing npm-related stuff. This is a fork of "mock-private-registry" with support for mocking multiple packages.

Installation

npm install --save-dev @probablyup/mock-private-registry

Usage

const registry = require('@probablyup/mock-private-registry');
const got = require('got');

const token = 'MySecretToken';

// make the tarballs by running `npm pack` in it
const packages = [
  ['my-package', '/absolute/path/to/private/package/tarball.tar.gz'],
  ['my-other-package', '/absolute/path/to/other/private/package/tarball.tar.gz'],
];

registry({ packages, port: 18888, token }, function(err, server) {
  if (err) {
    throw err;
  }

  const opts = { headers: { Authorization: 'Bearer ' + token }, json: true };

  got('http://localhost:18888/@mockscope%2Ffoobar', opts)
    .then(function(res) {
      console.log('Package manifest: ', res.body);
    })
    .catch(function(err) {
      console.error(err);
    })
    .then(function() {
      server.close();
    });
});

Basically, call the module to spin up a server, and specify whatever you want to use as the valid authorization token. Second argument is a callback, which provides access to the server that is listening. This allows you to call close() on it when you're done.

Options

  • port - Port number for the server. Default: 63142

  • hostname - Hostname the server should listen on. Default: 127.0.0.1

  • token - The token that valid requests should use. Default: MySecretToken

  • tokenType - Type of token. Usually Bearer or Basic. Default: Bearer

  • packages - A two dimensional array of package data and tarball path, e.g.

    [['foo-package', '/local/path/to/foo-package.tar.gz']]

    or

    [[{name: 'foo-package'}, '/local/path/to/foo-package.tar.gz']]

    In object form, you're basically supplying the contents of package.json.

  • debug - Boolean. Set to true in order to have the registry mock spit back whatever is not matching, for instance the expected vs received token. Default: false

Promise API

There is an alternative promise API available if you require @probablyup/mock-private-registry/promise. Usage is the same except there is no callback. Instead, the function will return a promise.

Why

For testing. Lots of stuff interacts with the NPM registry, but often has bugs when authorizing against private registries. Trying to mock the whole private registry flow can be difficult, so I created this.

License

MIT