project-bin-path
v2.0.0
Published
This will give path to the project's local bin
Downloads
8,554
Maintainers
Readme
project-bin-path
Find path to local bin of Node.js or NPM package
Inspired by sindresorhus/pkg-dir
Install:
npm install project-bin-path
or
yarn add project-bin-path
Usage:
Project structure
📁 Users/
📁 ajaynarainmathur/
📁 test-project/
📁 node_modules/
📁 .bin/
📃 package.json
📁 dist/
📃 foo.js
// foo.js
const projectBinPath = require('project-bin-path')
projectBinPath(__dirname).then(binPath => {
console.log(binPath);
// `/Users/ajaynarainmathur/test-project/node_modules/.bin`
});
Api
projectBinPath([cwd])
⮑ Returns a promise of path to .bin
folder of the project or null
if project is not found
projectBinPath.sync([cwd])
⮑ Returns the path to .bin
of the project or null
.
cwd
⮑ Directory to start from.
Type: string
Default: process.cwd()
Use Cases
When you need to get path to excutables in package ( not the project but of your local package ) just do
projectBinPath(__dirname)
=>[...]/project/node_modules/your_package/node_modules/.bin
When you need to get path to excutables in project ( project using you package* ) just do
projectBinPath()
=>[...]/project/node_modules/.bin
License
MIT 🍻 Ajay Narain Mathur