sindresorhus/resolve-pkg

Resolve the path of a package regardless of it having an entry point

resolve-pkg

Resolve the path of a package regardless of it having an entry point

Some packages like CLI tools and grunt tasks don't have a entry point, like "main": "foo.js" in package.json, resulting in them not being resolvable by require.resolve(). Unlike require.resolve(), this module also resolves packages without an entry point, returns undefined instead of throwing when the module can't be found, and resolves from process.cwd() instead __dirname by default.

Install

$ npm install resolve-pkg

Usage

const resolvePkg = require('resolve-pkg');

// $ npm install --save-dev grunt-svgmin

resolvePkg('grunt-svgmin/tasks', {cwd: __dirname});
//=> '/Users/sindresorhus/unicorn/node_modules/grunt-svgmin/tasks'

// Fails here as Grunt tasks usually don't have a defined main entry point
require.resolve('grunt-svgmin/tasks');
//=> Error: Cannot find module 'grunt-svgmin'

API

resolvePkg(moduleId, [options])

moduleId

Type: string

What you would use in require().

options

cwd

Type: string
Default: process.cwd()

Directory to resolve from.

Related

• resolve-cwd - Resolve the path of a module from the current working directory
• resolve-from - Resolve the path of a module from a given path
• resolve-global - Resolve the path of a globally installed module
• import-from - Import a module from a given path
• import-cwd - Import a module from the current working directory
• import-lazy - Import a module lazily

License

MIT © Sindre Sorhus

resolve-pkg's Issues

why is this package's api different from resolve-from/resolve-cwd/resolve-global

resolve-from/resolve-cwd/resolve-global all throws by default, and have a silent method to prevent throwing.

Why this package is different. Is there any chance that you make it the same with others? (which will definitely cause a break.)

CLI version?

Is there a CLI version of this?

Does resolve to directory but not to "main" property

The standard require.resolve returns the location of the "main" property as specified in the package.json.

sync version?

Possible to add support for a synchronous version as resolvePkg.sync?

Does not work with package exports

Given a package that has exports in its package.json, like this:

{
    "exports": {
    ".": "./dist/index.js",
    "./*": {
      "types": "./dist/*.d.ts",
      "default": "./dist/*.js"
    }
  }
}

When trying to resolve that package, a MODULE_NOT_FOUND error is thrown with "Cannot find module '/path/to/my-package/dist/package.json.js'"

Basically the assumption here that you can always resolve the package.json of a package using node does not hold true anymore in this case. Still I'd like to be able to get the root path of that package, using node module resolution rules. 🤔

Cannot resolve the package which has conditional exports

Conditional exports API

Attempting to resolve https://github.com/delvedor/hpagent which has conditional exports at it's package.json results to undefined.