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

overwrite

v1.0.3

Published

Forget monkey-patching your dependencies. Completely rewrite any file in a third-party package/module on-the-fly!

Downloads

136

Readme

overwrite NPM version

Forget monkey-patching your dependencies. Completely rewrite any file in a third-party package/module on-the-fly!

Works with NPM v3+; untested on earlier versions.

Installation

Install the package with NPM:

$ npm install overwrite

Usage

As an example, consider the following code:

import isInteger from "is-integer";

console.log(isInteger(1)); // => true
console.log(isInteger(2)); // => true

If you wanted to modify/tweak the functionality of the third-party is-integer module (for some reason), you'd normally have three options:

  1. Attempt to programmatically monkey-patch the module.
  2. Fork the module, submit a patch to the original repository, and pray that it is merged.
  3. Fork the module and publish your changes as a separate NPM package.

This package introduces a powerful fourth option – overwrite specific files in the module on-the-fly at runtime! For example:

import overwrite from "overwrite";

const isInteger = overwrite("is-integer", {
  "index.js": `
    module.exports = function(value) {
      return value === 1;
    }
  `
});

console.log(isInteger(1)); // => true
console.log(isInteger(2)); // => false

As can be seen, this package exposes a function that accepts a module name (string) as the first argument, and a mapping (object literal) of relative file paths to file contents as the second. The return value is the module itself (as if you called require or import), but with all of the overwrites applied. In this particular example, the index.js file in the third-party is-integer package is completely overwritten with new code that behaves very differently.

Tip

Most of the time, you probably won't want to completely overwrite the contents of a file, you'll just want to change a few lines here and there. You can easily do this by simply mapping the relative file path to a transformation function (instead of a string). Here's an example:

import overwrite from "overwrite";

const isInteger = overwrite("is-integer", {
  "index.js": contents => {
    let lines = contents.split("\n");
    lines.splice(3, 1, `console.log("Hello!");`);
    return lines.join("\n");
  }
});