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

@vitruvius-labs/mockingbird

v0.2.3

Published

Module mocking library

Downloads

7

Readme

mockingbird

Presentation

This lib provide a custom module loader to help write tests for modules.

It is compatible with the native nodejs test runners.

Getting started

Choose your favourite package manager.

pnpm add @vitruvius-labs/mockingbird
yarn add @vitruvius-labs/mockingbird
npm install @vitruvius-labs/mockingbird

Documentation

To use a mock in your test, use the mockingbird() function

mockingbird<TestedModule>(
	module_identifier: string,
	meta_url: string,
	mocks: Record<string, MockedDependency>
): TestedModule;

interface MockedDependency
{
	default: unknown;
	[imported: string]: unknown;
}

module_identifier is the module you want to test. Usually provided by the relative file path to it.

meta_url is simply the value of import.meta.url. It is used to resolve paths.

mocks is a mapping of the module dependencies to replace and with what to replace them.

If you have aliases in your imports, you must name the imported items by their original name.

The default import for a dependency can be filled under the default name.

Import syntax

Unsupported syntax for imports:

import defaultExport, { export1 } from "module-name";
import defaultExport, * as name from "module-name";

You can replace them with these syntax:

import { default as defaultExport, export1 } from "module-name";

// "defaultExport" can be accessed with "name.default"
import * as name from "module-name";

Example of use

Module file

import { randomUUID as seed } from "node:crypto";
import * as formatter from "./formatter.mjs";
import validateId from "./validate-id.mjs";

function generateId(): string
{
	const ID: string = formatter.formatId(seed());

	if (!validateId(ID))
	{
		throw new Error(`Invalid ID: ${ID}`);
	}

	return ID;
}

export { generateId };

Test file

import type * as TestedModule from '../src/my-module.mjs';

const MODULE: typeof TestedModule = await mockingbird<typeof TestedModule>(
	"../src/my-module.mjs",
	import.meta.url,
	{
		"node:crypto": {
			randomUUID: (): string =>
			{
				return "fixed-uuid";
			}
		},
		"./validateId.mjs": {
			default: (): boolean =>
			{
				return true;
			}
		},
	}
);

assert.doesNotThrow((): void => { MODULE.generateId(); });
assert.strictEqual(MODULE.generateId(), "fixed-uuid");