{"id":17242801,"url":"https://github.com/imcuttle/require-resolve-hook","last_synced_at":"2025-10-30T14:33:09.293Z","repository":{"id":45113369,"uuid":"307356756","full_name":"imcuttle/require-resolve-hook","owner":"imcuttle","description":"Module to hook into the Node.js require and require.resolve function","archived":false,"fork":false,"pushed_at":"2022-10-18T07:57:30.000Z","size":143,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-23T02:34:05.647Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imcuttle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"License","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-26T11:55:36.000Z","updated_at":"2022-10-02T17:58:10.000Z","dependencies_parsed_at":"2023-01-20T03:46:23.085Z","dependency_job_id":null,"html_url":"https://github.com/imcuttle/require-resolve-hook","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Frequire-resolve-hook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Frequire-resolve-hook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Frequire-resolve-hook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imcuttle%2Frequire-resolve-hook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imcuttle","download_url":"https://codeload.github.com/imcuttle/require-resolve-hook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248814724,"owners_count":21165812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-15T06:14:06.363Z","updated_at":"2025-10-30T14:33:04.272Z","avatar_url":"https://github.com/imcuttle.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# require-resolve-hook\n\n[![Build status](https://img.shields.io/travis/imcuttle/require-resolve-hook/master.svg?style=flat-square)](https://travis-ci.org/imcuttle/require-resolve-hook)\n[![Test coverage](https://img.shields.io/codecov/c/github/imcuttle/require-resolve-hook.svg?style=flat-square)](https://codecov.io/github/imcuttle/require-resolve-hook?branch=master)\n[![NPM version](https://img.shields.io/npm/v/require-resolve-hook.svg?style=flat-square)](https://www.npmjs.com/package/require-resolve-hook)\n[![NPM Downloads](https://img.shields.io/npm/dm/require-resolve-hook.svg?style=flat-square\u0026maxAge=43200)](https://www.npmjs.com/package/require-resolve-hook)\n[![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://prettier.io/)\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)\n\n\u003e Module to hook into the Node.js require and require.resolve function\n\n## Installation\n\n```bash\nnpm install require-resolve-hook\n# or use yarn\nyarn add require-resolve-hook\n```\n\n## Usage\n\n```javascript\nimport requireResolveHook, { bypass, unhook } from 'require-resolve-hook'\n\nconst { unhook: unhookReact, bypass: bypassReact } = requireResolveHook('react', (id, parent, isMain) =\u003e {\n  return '/path/to/your/custom-react' // absolute path\n})\n\nrequire.resolve('react') // =\u003e '/path/to/your/custom-react'\nrequire('react') // =\u003e export '/path/to/your/custom-react'\n\nbypassReact(() =\u003e require.resolve('react')) // =\u003e '/path/to/real-react'\n\nunhookReact()\nrequire.resolve('react') // =\u003e '/path/to/real-react'\n```\n\n## API\n\n#### `requireResolveHook(match: Match, onResolve: OnResolve, options: Options)`\n\n- **Returns:** `{ bypass: (fn) =\u003e ReturnType\u003cfn\u003e, unhook: () =\u003e void }`\n\n  `bypass` means:\n\n  ```javascript\n  bypass = (fn) =\u003e {\n    unhook()\n    const res = fn()\n    hook()\n    return res\n  }\n  ```\n\n#### `StrictMatch`\n\n- **Type:** `string | RegExp | (id: string) =\u003e boolean`\n\n#### `Match`\n\n- Type: `StrictMatch | StrictMatch[]`\n\n#### `OnResolve`\n\n- **Type:** `(id: string, parent: null | Module, isMain: boolean) =\u003e string | false`\n\n#### `Options`\n\n##### `ignoreModuleNotFoundError`\n\nShould ignore `MODULE_NOT_FOUND` error?\n\n```javascript\nrequireResolveHook('react', () =\u003e require.resolve('not_found_package'))\nrequireResolveHook('react', () =\u003e require.resolve('founded_react'))\n\nrequire.resolve('react') === require.resolve('founded_react')\n```\n\n```javascript\nrequireResolveHook('react', () =\u003e require.resolve('not_found_package'), { ignoreModuleNotFoundError: false })\nrequireResolveHook('react', () =\u003e require.resolve('founded_react'))\n\nrequire.resolve('react') // Throws MODULE_NOT_FOUND error\n```\n\n- **Type:** `boolean`\n- **Default:** `true`\n\n## FAQ\n\n1. How to require the actual module in the mock file?\n\n```javascript\nimport requireResolveHook, { bypass } from 'require-resolve-hook'\nimport * as Module from 'module'\n\nrequireResolveHook(/^react/, (id, parent, isMain, opts) =\u003e {\n  if (parent \u0026\u0026 parent.filename === '/path/to/mock/react') {\n    // Access the actual react filename\n    return bypass(() =\u003e Module._resolveFilename(id, parent, isMain, opts))\n  }\n  return '/path/to/mock/react'\n})\n```\n\n## Contributing\n\n- Fork it!\n- Create your new branch:  \n  `git checkout -b feature-new` or `git checkout -b fix-which-bug`\n- Start your magic work now\n- Make sure npm test passes\n- Commit your changes:  \n  `git commit -am 'feat: some description (close #123)'` or `git commit -am 'fix: some description (fix #123)'`\n- Push to the branch: `git push`\n- Submit a pull request :)\n\n## Authors\n\nThis library is written and maintained by imcuttle, \u003ca href=\"mailto:imcuttle@163.com\"\u003eimcuttle@163.com\u003c/a\u003e.\n\n## License\n\nMIT - [imcuttle](https://github.com/imcuttle) 🐟\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimcuttle%2Frequire-resolve-hook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimcuttle%2Frequire-resolve-hook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimcuttle%2Frequire-resolve-hook/lists"}