nmls

An analysis tool to Node Modules List

Usage no npm install needed!

<script type="module">
  import nmls from 'https://cdn.skypack.dev/nmls';
</script>

README

nmls - Node Modules List

An analysis tool to show dependencies detail in node modules folder.

npm npm David

CLI Usage

# Install
npm install nmls -g

# go to project folder and execute:
nmls

# sort by dependency size
nmls -s dSize
nmls --sort dSize

# show workspace
nmls -w
nmls --workspace

# filter workspace packages with name
nmls -w my-workspace-name

# more options help
nmls -h
nmls --help
 Usage: nmls [options]
┌─────────────────────────────┬───────────────────────────────────────────────────────────────────┐
│ Commands and Options        │ Description                                                       │
├─────────────────────────────┼───────────────────────────────────────────────────────────────────┤
│ └ nmls                      │                                                                   │
│   ├  -v, --version          │ output the version number                                         │
│   ├  -r, --root <path>      │ project root, default value is '.' (current working directory)    │
│   ├  -s, --sort <field>     │ sort field (name/version/size/dAmount/dNested/dSize/files/dFiles) │
│   ├  -a, --asc              │ sort by asc                                                       │
│   ├  -w, --workspace [name] │ show all packages of workspace, or filter with name               │
│   ├  -f, --files            │ show files columns                                                │
│   └  -h, --help             │ display help for command                                          │
└─────────────────────────────┴───────────────────────────────────────────────────────────────────┘

Output Example

nmls -f
[nmls] root: G:/workspace/nmls
[nmls] generated node modules: 135  (nested: 24  size percentage: 11.55 %)
┌─────────────────────┬─────────┬───────┬───────────┬──────────┬──────────┬──────────┬───────────┐
│                     │         │       │           │     Deps │     Deps │     Deps │           │
│  Name               │ Version │ Files │      Size │   Amount │   Nested │    Files │ Deps Size │
├─────────────────────┼─────────┼───────┼───────────┼──────────┼──────────┼──────────┼───────────┤
│ └ nmls              │ 3.0.1   │    14 │  38.25 KB │      135 │       24 │    2,105 │  11.77 MB │
│   ├ dependencies    │         │       │           │          │          │          │           │
│   │ ├ commander     │ 7.2.0   │     8 │ 141.32 KB │        0 │        0 │        0 │       0 B │
│   │ ├ console-grid  │ 1.0.17  │     4 │  28.19 KB │        1 │        0 │        3 │   2.36 KB │
│   │ ├ eight-colors  │ 1.0.0   │     3 │   2.36 KB │        0 │        0 │        0 │       0 B │
│   │ ├ gauge         │ 3.0.0   │    19 │  48.15 KB │       10 │        0 │       46 │   70.8 KB │
│   │ ├ glob          │ 7.1.7   │     7 │   54.6 KB │       10 │        0 │       46 │  85.69 KB │
│   │ ├ ignore        │ 5.1.8   │     7 │  48.65 KB │        0 │        0 │        0 │       0 B │
│   │ └ object-assign │ 4.1.1   │     4 │    6.3 KB │        0 │        0 │        0 │       0 B │
│   └ devDependencies │         │       │           │          │          │          │           │
│     └ eslint        │ 7.27.0  │   393 │      3 MB │      118 │       24 │    1,593 │   8.37 MB │
└─────────────────────┴─────────┴───────┴───────────┴──────────┴──────────┴──────────┴───────────┘

Node.js API

const NMLS = require("nmls");
const option = {};
new NMLS().start(option).then((info) => {
    console.log("[nmls] done");
});

see default options

Changelog

  • 3.0.1

    • added size percentage

  • 3.0.0

    • support workspace
    • removed useless --module option

  • 2.0.3

    • fixed color

  • 2.0.2

    • fixed absolute path issue for ignore