Skip to content

antfu/node-modules-inspector

Repository files navigation

Node Modules Inspector

npm version npm downloads bundle JSDocs License

Visualize your node_modules, inspect dependencies, and more.

Quick Start

Try it by running following command under your pnpm/npm project.

pnpx node-modules-inspector
npx node-modules-inspector

Currently only support pnpm and npm projects. We are counting on the community to bring support for other package managers.

Online Version

You can also try an online version at node-modules.dev, powered by WebContainer.

Configuration

You can create a node-modules-inspector.config.ts file in your project root to configure the inspector's default behaviour.

import { defineConfig } from 'node-modules-inspector'

export default defineConfig({
  defaultFilters: {
    excludes: [
      'eslint',
    ],
  },
  defaultSettings: {
    moduleTypeSimple: true,
  },

  // Experimental publint.dev integration, default is false
  publint: true

  // ...see jsdoc for more options and details
})

Static Build

You can also build a static SPA of your current node_modules status:

pnpx node-modules-inspector build
npx node-modules-inspector build

Then you can host the .node-modules-inspector folder with any static file server.

You can see a build for all Anthony Fu's packages at everything.antfu.dev.

Screenshots

Image Image Image

Credits

Sponsors

License

MIT License © Anthony Fu