├── .gitignore
├── LICENSE
├── README.md
├── index.js
└── package.json


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | sandbox.js
3 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2018 Mathias Buus
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # module-bin-path
 2 | 
 3 | Get the absolute file path to a bin entry of an installed dependency.
 4 | Useful if you want to include a cli as an npm dependency and spawn it from node.
 5 | 
 6 | ```
 7 | npm install module-bin-path
 8 | ```
 9 | 
10 | ## Usage
11 | 
12 | ``` js
13 | // let's assume npm install --save some-cli was include
14 | 
15 | const binPath = require('module-bin-path')
16 | console.log('path to the bin entry', binPath('some-cli'))
17 | 
18 | // to spawn the included cli do
19 | 
20 | const child = childProcess.spawn(binPath('some-cli'), [ ... ])
21 | ```
22 | 
23 | ## API
24 | 
25 | #### `const path = binPath(moduleName, [binEntry])`
26 | 
27 | Get the absolute path to a modules package.json bin entry.
28 | 
29 | `binEntry` is the bin entry name. Defaults to `moduleName`.
30 | 
31 | ## License
32 | 
33 | MIT
34 | 


--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
 1 | const path = require('path')
 2 | 
 3 | module.exports = bin
 4 | 
 5 | function bin (name, binName) {
 6 |   const pkg = require(name + '/package.json')
 7 |   const pkgPath = path.join(require.resolve(name + '/package.json'), '..')
 8 | 
 9 |   if (!binName && typeof pkg.bin === 'string') return path.join(pkgPath, pkg.bin)
10 |   if (!binName) binName = name
11 | 
12 |   if (!pkg.bin || !pkg.bin[binName]) throw new Error('Could not find bin path')
13 |   return path.join(pkgPath, pkg.bin[binName])
14 | }
15 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "module-bin-path",
 3 |   "version": "1.0.1",
 4 |   "description": "Get the absolute file path to a bin entry of an installed dependency",
 5 |   "main": "index.js",
 6 |   "dependencies": {},
 7 |   "devDependencies": {},
 8 |   "repository": {
 9 |     "type": "git",
10 |     "url": "https://github.com/mafintosh/module-bin-path.git"
11 |   },
12 |   "author": "Mathias Buus (@mafintosh)",
13 |   "license": "MIT",
14 |   "bugs": {
15 |     "url": "https://github.com/mafintosh/module-bin-path/issues"
16 |   },
17 |   "homepage": "https://github.com/mafintosh/module-bin-path"
18 | }
19 | 


--------------------------------------------------------------------------------