Registry / devops / node-modules-inspector

node-modules-inspector

library1.4.2jsnpmunverified

Node Modules Inspector is an interactive command-line interface (CLI) and web UI tool designed for comprehensive analysis and visualization of the `node_modules` directory within JavaScript/TypeScript projects. Maintained by Anthony Fu, the package is currently at version 1.4.2 and receives regular updates, as indicated by its recent feature and bugfix releases. It helps developers understand their project's dependency graph, identify installed dependencies, analyze package sizes, detect module types (ESM vs. CJS), and locate duplicates or version conflicts. The tool differentiates itself by offering an interactive UI that can be launched locally or built into a static report for hosting, supporting various package managers including npm, pnpm, and Bun. It is particularly useful for debugging dependency issues, optimizing bundle sizes in large projects or monorepos, and quickly assessing potential vulnerabilities through its report view.

devops observability

npm install node-modules-inspector

github ↗package ↗

INSTALL

IMPORT

SIG · NODE-MODULES-INSPE

node-modules-inspector

devopsjavascriptv1.4.2

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

run

✓ import { run } from 'node-modules-inspector/cli'; // Or, for direct CLI usage: // npx node-modules-inspector

✗ const run = require('node-modules-inspector/cli');

The primary interaction is typically via `npx` or a script, but the `run` function allows programmatic execution of the CLI. The package is ESM-first, so direct CommonJS `require` is not recommended for core modules.

analyzeProject

✓ import { analyzeProject } from 'node-modules-inspector/core'; // For detailed analysis.

✗ import analyzeProject from 'node-modules-inspector/core'; // Incorrect default import

This symbol, or similar, is inferred for programmatic analysis based on the package's functionality. Named imports are standard for modern TypeScript/ESM libraries. Exact export name might vary, consult source if 'analyzeProject' fails.

ModuleReport

✓ import type { ModuleReport } from 'node-modules-inspector/types';

✗ import { ModuleReport } from 'node-modules-inspector/types'; // Using `import` instead of `import type` for types.

When importing only types in TypeScript, `import type` is preferred for better tree-shaking and clarity, though `import` works at compile time. This type is for consuming the structured output of the analysis.

This quickstart demonstrates how to programmatically analyze a project's `node_modules` directory and log summary information.

import { analyzeProject } from 'node-modules-inspector/core'; import path from 'node:path'; import process from 'node:process'; async function inspectCurrentProject() { const projectPath = process.cwd(); console.log(`Analyzing node_modules in: ${projectPath}\n`); try { // The `analyzeProject` function (inferred) would perform the core logic. // In a real scenario, this might return a structured report object. const report = await analyzeProject(projectPath, { // Optional: Specify package manager if not auto-detected packageManager: 'npm', // Optional: Include dev dependencies in the analysis includeDevDependencies: true, // Optional: Filter modules based on criteria filter: (module) => !module.name.startsWith('@types/'), }); console.log('Analysis Complete! Key Insights:'); console.log(`Total unique packages: ${report.packages.length}`); console.log(`Total disk size: ${report.totalSizeHumanReadable}`); console.log(`Duplicate packages found: ${report.duplicates.length}`); console.log(`Modules with known vulnerabilities: ${report.vulnerabilities?.length || 0}`); console.log('\nTo view the full interactive report, run:'); console.log('npx node-modules-inspector'); } catch (error) { console.error(`Error during analysis: ${error.message}`); console.error('Ensure you run this in a project with a node_modules directory.'); console.error('If this error persists, try running `npx node-modules-inspector` directly.'); } } inspectCurrentProject();

node-modules-inspector --version

Debug

Known issues

gotchaThe `node-modules-inspector` package is primarily designed as a CLI tool with an interactive UI. While it exposes a programmatic API, the most common and feature-rich way to use it is via `npx node-modules-inspector` in your project's root, which launches a local web-based interface for exploration.

fix

Prefer `npx node-modules-inspector` for interactive analysis. If integrating programmatically, refer to the package's source or examples for exact API details, as it may evolve.

affects: >=1.0.0

gotchaWhen using `node-modules-inspector` in CI/CD environments or for static reports, remember to use the `build` command (e.g., `npx node-modules-inspector build`). Simply running the inspector without the build command will not generate persistent output for later review or hosting.

fix

For non-interactive or deployable reports, run `npx node-modules-inspector build`. The output will be in a `.node-modules-inspector` folder which can then be served as static files.

affects: >=1.0.0

gotchaThe tool relies on the structure and content of your `node_modules` directory. Issues with package manager caching, inconsistent installs, or corrupted `node_modules` can lead to incomplete or incorrect analysis reports.

fix

Ensure your `node_modules` is in a clean state by running `rm -rf node_modules && [your-package-manager] install` before using the inspector. This helps guarantee an accurate reflection of your project's dependencies.

affects: >=1.0.0

gotchaThe 'vulnerability tab on report view' feature was added in v1.4.0. Users on older versions will not have access to this security analysis capability.

fix

Upgrade to `node-modules-inspector@latest` (or >=1.4.0) to benefit from the integrated vulnerability scanning in the report UI.

affects: <1.4.0

Errors

Common errors & fixes

Error: Cannot find module 'node-modules-inspector/cli'

Attempting to `require` or `import` a submodule path that does not exist or has been moved, or an incorrect import style for an ESM-first package. This often happens with CommonJS `require` calls.

fix

Ensure you are using correct ESM import paths (e.g., `import { run } from 'node-modules-inspector/cli';`) and that your project supports ESM. For direct CLI usage, prefer `npx node-modules-inspector`.

TypeError: Cannot read properties of undefined (reading 'length') when accessing report data

This typically occurs when trying to access properties of the analysis report object (e.g., `report.packages.length`) before the analysis is complete or if the property is unexpectedly `undefined` due to an error during analysis or an empty `node_modules` directory.

fix

Add checks for `report` and its properties being defined before accessing them. Ensure your project has a `node_modules` directory and dependencies are installed. Log the `report` object to inspect its structure if the issue persists.

npx node-modules-inspector: command not found

The `node-modules-inspector` package is not installed or `npx` cannot locate it in your environment. This might happen if npm's global bin path is not in your system's PATH, or if there's a temporary network issue preventing `npx` from downloading it.

fix

Ensure `npm` is correctly installed and its bin directory is in your system's PATH. You can also try installing the package globally first: `npm install -g node-modules-inspector`, then run `node-modules-inspector`.

Upgrade

Version history

1.4.2latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

12 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/antfu/node-modules-inspector ↗

packagehttps://www.npmjs.com/package/node-modules-inspector ↗