Wondering what’s next for npm?Check out our public roadmap! »

    pirates
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.1 • Public • Published

    Pirates Version Build Status Coverage Commitizen friendly semantic-release MIT License

    Properly hijack require

    Why?

    Two reasons:

    1. Babel and istanbul were breaking each other.
    2. Everyone seemed to re-invent the wheel on this, and everyone wanted a solution that was DRY, simple, easy to use, and made everything Just Work™, while allowing multiple require hooks, in a fashion similar to calling super.

    For some context, see the Babel issue thread which started this all, then the nyc issue thread, where discussion was moved (as we began to discuss just using the code nyc had developed), and finally to #1 where discussion was finally moved.

    Installation

    npm install --save pirates
    

    Usage

    Using pirates is really easy:

    // my-module/register.js
    const addHook = require('pirates').addHook;
    // Or if you use ES modules
    // import { addHook } from 'pirates';
     
    function matcher(filename) {
      // Here, you can inspect the filename to determine if it should be hooked or
      // not. Just return a truthy/falsey. Files in node_modules are automatically ignored, 
      // unless otherwise specified in options (see below).
     
      // TODO: Implement your logic here
      return true;
    }
     
    const revert = addHook(
      (code, filename) => code.replace('@@foo', 'console.log(\'foo\');'), 
      { exts: ['.js'], matcher }
    );
     
    // And later, if you want to un-hook require, you can just do:
    revert();

    API

    pirates.addHook(hook, [opts={ [matcher: true], [exts: ['.js']], [ignoreNodeModules: true] }]);

    Add a require hook. hook must be a function that takes (code, filename), and returns the modified code. opts is an optional options object. Available options are: matcher, which is a function that accepts a filename, and returns a truthy value if the file should be hooked (defaults to a function that always returns true), falsey if otherwise; exts, which is an array of extensions to hook, they should begin with . (defaults to ['.js']); ignoreNodeModules, if true, any file in a node_modules folder wont be hooked (the matcher also wont be called), if false, then the matcher will be called for any files in node_modules (defaults to true).

    Projects that use Pirates

    See the wiki page. If you add Pirates to your project, (And you should! It works best if everyone uses it. Then we can have a happy world full of happy require hooks!), please add yourself to the wiki.

    License

    MIT

    Keywords

    none

    Install

    npm i pirates

    DownloadsWeekly Downloads

    11,019,831

    Version

    4.0.1

    License

    MIT

    Unpacked Size

    12.6 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar