Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

pirates

Package Overview
Dependencies
0
Maintainers
3
Versions
18
Issues
File Explorer

Advanced tools

pirates

Properly hijack require

    4.0.5latest

Version published
Maintainers
3
Weekly downloads
19,698,432
increased by6.28%

Weekly downloads

Changelog

Source

v4.0.5

4.0.5 (2022-01-24)

Bug Fixes

  • Ensure revert() does revert correctly (4e1b015), closes #90

Readme

Source

Pirates Coverage

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.

FAQs

What is pirates?

Properly hijack require

Is pirates popular?

The npm package pirates receives a total of 16,570,404 weekly downloads. As such, pirates popularity was classified as popular.

Is pirates well maintained?

We found that pirates demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 3 open source maintainers collaborating on the project.

Last updated on 24 Jan 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc