resolve-pkg

1.0.0 • Public • Published

resolve-pkg Build Status

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 null instead of throwing when the module can't be found, and resolves from process.cwd() instead __dirname by default.

Install

$ npm install --save 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: boolean
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
  • req-from - Require a module from a given path
  • req-cwd - Require a module from the current working directory
  • lazy-req - Require modules lazily

License

MIT © Sindre Sorhus

install

npm i resolve-pkg

Downloadsweekly downloads

75,438

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability