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

@undefined-moe/require-resolve-hook

v1.1.0

Published

Module to hook into the Node.js require and require.resolve function

Downloads

312

Readme

require-resolve-hook

Build status Test coverage NPM version NPM Downloads Prettier Conventional Commits

Module to hook into the Node.js require and require.resolve function

Installation

npm install require-resolve-hook
# or use yarn
yarn add require-resolve-hook

Usage

import requireResolveHook, { bypass, unhook } from 'require-resolve-hook'

const { unhook: unhookReact, bypass: bypassReact } = requireResolveHook('react', (id, parent, isMain) => {
  return '/path/to/your/custom-react' // absolute path
})

require.resolve('react') // => '/path/to/your/custom-react'
require('react') // => export '/path/to/your/custom-react'

bypassReact(() => require.resolve('react')) // => '/path/to/real-react'

unhookReact()
require.resolve('react') // => '/path/to/real-react'

API

requireResolveHook(match: Match, onResolve: OnResolve, options: Options)

  • Returns: { bypass: (fn) => ReturnType<fn>, unhook: () => void }

    bypass means:

    bypass = (fn) => {
      unhook()
      const res = fn()
      hook()
      return res
    }

StrictMatch

  • Type: string | RegExp | (id: string) => boolean

Match

  • Type: StrictMatch | StrictMatch[]

OnResolve

  • Type: (id: string, parent: null | Module, isMain: boolean) => string | false

Options

ignoreModuleNotFoundError

Should ignore MODULE_NOT_FOUND error?

requireResolveHook('react', () => require.resolve('not_found_package'))
requireResolveHook('react', () => require.resolve('founded_react'))

require.resolve('react') === require.resolve('founded_react')
requireResolveHook('react', () => require.resolve('not_found_package'), { ignoreModuleNotFoundError: false })
requireResolveHook('react', () => require.resolve('founded_react'))

require.resolve('react') // Throws MODULE_NOT_FOUND error
  • Type: boolean
  • Default: true

FAQ

  1. How to require the actual module in the mock file?
import requireResolveHook, { bypass } from 'require-resolve-hook'
import * as Module from 'module'

requireResolveHook(/^react/, (id, parent, isMain, opts) => {
  if (parent && parent.filename === '/path/to/mock/react') {
    // Access the actual react filename
    return bypass(() => Module._resolveFilename(id, parent, isMain, opts))
  }
  return '/path/to/mock/react'
})

Contributing

  • Fork it!
  • Create your new branch:
    git checkout -b feature-new or git checkout -b fix-which-bug
  • Start your magic work now
  • Make sure npm test passes
  • Commit your changes:
    git commit -am 'feat: some description (close #123)' or git commit -am 'fix: some description (fix #123)'
  • Push to the branch: git push
  • Submit a pull request :)

Authors

This library is written and maintained by imcuttle, [email protected].

License

MIT - imcuttle 🐟