package-viewer

1.1.3 • Public • Published

Package-Viewer

Generates a list of Node.js packages located inside of a given directory.

Image displaying tree view functionality of package-viewer

Features

  • Tree view containing multiple folders and Node.js packages.
  • Automatic identification and tagging for:
    • pNpm, Lerna, Angular and Nx Workspaces
    • Git projects
    • Compiled packages (under /dist folders)
    • Packages containing local path dependencies (starting with file:)
    • Global Symlinked Packages
  • Unnecessary packages are filtered by default (packages under node_modules as well as hidden files and folders ./.**)
  • Built-in Markdown renderer for readme.md files.
  • Button to quickly open your projects in VS Code.

Usage

  1. Navigate to some folder to be analyzed, for example, your personal projects folder.
  2. Run npx package-viewer and wait for the list of folders and packages to open in the browser.

Options

  • You can optionally pass the directory as an argument, for example: npx package-viewer ~/my-custom-directory.
  • The server port can be configured with the PORT environment variable, e.g. PORT=3012 npx package-viewer, or yet PORT=any npx package-viewer to let the program choose an available port.
  • Generated index.html will be cached at ~/.package-viewer/index.html. Such folder can be removed by the user at any time.

Further Improvements

  1. Add support for multiple folders as arguments.
  2. Add custom glob rules for filtering.
  3. Add custom notes and tagging features.
  4. Identify global modules for npm/pnpm and tag respective package.json files.

Readme

Keywords

none

Package Sidebar

Install

npm i package-viewer

Weekly Downloads

0

Version

1.1.3

License

ISC

Unpacked Size

220 kB

Total Files

8

Last publish

Collaborators

  • rafaelcalpena