dependencies-hierarchy

dependencies-hierarchy

Creates a dependencies hierarchy for a symlinked `node_modules`

A symlinked node_modules is created when installing using pnpm.

Installation

<pnpm|npm|yarn> add dependencies-hierarchy

Usage

'use strict'
const hierarchyForPackages = require('dependencies-hierarchy').forPackages

hierarchyForPackages(['graceful-fs', {name: 'pify', range: '2'}], __dirname, {depth: 2})
  .then(tree => {
    console.log(JSON.stringify(tree, null, 2))
    //> [
    //    {
    //      "dependencies": [
    //        {
    //          "dependencies": [
    //            {
    //              "pkg": {
    //                "name": "graceful-fs",
    //                "path": "/home/zoltan/src/pnpm/pnpm/packages/dependencies-hierarchy/example/node_modules/.registry.npmjs.org/graceful-fs/4.1.11",
    //                "version": "4.1.11"
    //              },
    //              "searched": true
    //            },
    //            {
    //              "pkg": {
    //                "name": "pify",
    //                "path": "/home/zoltan/src/pnpm/pnpm/packages/dependencies-hierarchy/example/node_modules/.registry.npmjs.org/pify/2.3.0",
    //                "version": "2.3.0"
    //              },
    //              "searched": true
    //            }
    //          ],
    //          "pkg": {
    //            "name": "write-json-file",
    //            "path": "/home/zoltan/src/pnpm/pnpm/packages/dependencies-hierarchy/example/node_modules/.registry.npmjs.org/write-json-file/2.2.0",
    //            "version": "2.2.0"
    //          }
    //        }
    //      ],
    //      "pkg": {
    //        "name": "write-pkg",
    //        "path": "/home/zoltan/src/pnpm/pnpm/packages/dependencies-hierarchy/example/node_modules/.registry.npmjs.org/write-pkg/3.1.0",
    //        "version": "3.1.0"
    //      }
    //    }
    //  ]
  })

API

default: dependenciesHierarchy(projectPath, [opts]): Promise<Hierarchy>

Creates a dependency tree for a project's node_modules.

Arguments:

• projectPath - String - The path to the project.
• [opts.depth] - Number - 0 by default. How deep should the node_modules be analyzed.
• [opts.only] - 'dev' | 'prod' - Optional. If set to dev, then only packages from devDependencies are analyzed. If set to prod, then only packages from dependencies are analyzed.

forPackages(packageSelectors, projectPath, [opts]): Promise<Hierarchy>

Creates a dependency tree for a project's node_modules. Limits the results to only the paths to the packages named.

Arguments:

• packageSelectors - (string | {name: string, version: string})[] - An array that consist of package names or package names and version ranges. E.g. ['foo', {name: 'bar', version: '^2.0.0'}].
• projectPath - String - The path to the project
• [opts.depth] - Number - 0 by default. How deep should the node_modules be analyzed.
• [opts.only] - 'dev' | 'prod' - Optional. If set to dev, then only packages from devDependencies are analyzed. If set to prod, then only packages from dependencies are analyzed.

License

MIT © Zoltan Kochan