dependencies-tree
v2.0.0
Published
Collect dependencies from package.json
Downloads
736
Readme
dependencies-tree
Collect dependencies from package.json
Install
npm i dependencies-tree
Usage
import getDependencies from 'dependencies-tree'
const { tree, flat } = await getDependencies()
API (Define)
export interface DependenciesOptions {
/** @default process.cwd() */
root?: string
/** `dependencies` in package.json under the default root path */
dependencies?: string[]
}
Example
Assume there is a dependency electron-squirrel-startup
in package.json.
{
"dependencies": {
"electron-squirrel-startup": "^1.0.0"
}
}
We get the dependency tree based on the path where package.json is located.
import getDependencies from 'dependencies-tree'
const root = process.cwd()
const { tree } = await getDependencies({ root })
console.log(tree)
// ↓↓↓↓
[
{
name: 'electron-squirrel-startup',
path: {
src: path.join(fixtureRoot, 'node_modules', 'electron-squirrel-startup'),
dest: path.join('node_modules', 'electron-squirrel-startup'),
name: 'electron-squirrel-startup',
},
dependencies: [
{
name: 'debug',
path: {
src: path.join(fixtureRoot, 'node_modules', 'debug'),
dest: path.join('node_modules', 'debug'),
name: 'debug',
},
dependencies: [
{
name: 'ms',
path: {
src: path.join(fixtureRoot, 'node_modules', 'ms'),
dest: path.join('node_modules', 'ms'),
name: 'ms',
},
dependencies: [],
},
],
},
],
},
]
Get the flat dependency tree
import getDependencies from 'dependencies-tree'
const root = process.cwd()
const { flat } = await getDependencies({ root })
console.log(falg)
// ↓↓↓↓
[
{
src: path.join(fixtureRoot, 'node_modules', 'electron-squirrel-startup'),
dest: path.join('node_modules', 'electron-squirrel-startup'),
name: 'electron-squirrel-startup',
},
{
src: path.join(fixtureRoot, 'node_modules', 'debug'),
dest: path.join('node_modules', 'debug'),
name: 'debug',
},
{
src: path.join(fixtureRoot, 'node_modules', 'ms'),
dest: path.join('node_modules', 'ms'),
name: 'ms',
},
]