# depstats

> Groups modules by package and includes stats.

Latest version **0.2.0** (published 2021-02-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install depstats
pnpm add depstats
yarn add depstats
bun add depstats
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2021-02-09 |
| First published | 2021-02-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 13.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Thorsten Lorenz |
| Maintainers | thlorenz |

## Links

- npm: https://www.npmjs.com/package/depstats
- Repository: https://github.com/thlorenz/depstats
- Homepage: https://github.com/thlorenz/depstats#readme
- Issues: https://github.com/thlorenz/depstats/issues
- npm.io page: https://npm.io/package/depstats

## Dependencies (4)

- [debug](https://npm.io/package/debug.md) ^4.3.1
- [tslib](https://npm.io/package/tslib.md) ^2.1.0
- [find-up](https://npm.io/package/find-up.md) ^5.0.0
- [pretty-bytes](https://npm.io/package/pretty-bytes.md) ^5.5.0

## Recent versions

- 0.2.0 (latest) — 2021-02-09
- 0.1.0 — 2021-02-09

## README

# depstats [![](https://github.com/thlorenz/depstats/workflows/Node/badge.svg?branch=master)](https://github.com/thlorenz/depstats/actions)

Groups modules by package and includes stats.

## Example

Given an app with express dependency at `expressAppDir`.

```js
const { depStats } = require('depstats')
const { inspect } = require('util')

const res = await depStats(expressAppDir, [
  './node_modules/express/lib/middleware/query.js',
  './node_modules/express/lib/middleware/init.js',
  './node_modules/express/lib/router/layer.js',
  './node_modules/express/lib/router/index.js',
  './node_modules/express/lib/express.js',
  './node_modules/express/index.js',
  './node_modules/express/application.js',
  './node_modules/body-parser/lib/types/json.js',
  './node_modules/body-parser/lib/read.js',
  './node_modules/body-parser/index.js',
])
console.log(inspect(Array.from(res), { depth: 5 }))
```

Outputs the below where `full:` is the actual full path for your case.

```js
[
  [
    'body-parser@1.19.0',
    {
      name: 'body-parser',
      version: '1.19.0',
      main: 'index.js',
      fullPath: 'full:node_modules/body-parser',
      relPath: 'node_modules/body-parser',
      modules: [
        {
          modulePath: 'index.js',
          relPath: 'node_modules/body-parser/index.js',
          fullPath: 'full:node_modules/body-parser/index.js',
          size: 2656,
          humanSize: '2.66 kB'
        },
        {
          modulePath: 'lib/read.js',
          relPath: 'node_modules/body-parser/lib/read.js',
          fullPath: 'full:node_modules/body-parser/lib/read.js',
          size: 3894,
          humanSize: '3.89 kB'
        },
        {
          modulePath: 'lib/types/json.js',
          relPath: 'node_modules/body-parser/lib/types/json.js',
          fullPath: 'full:node_modules/body-parser/lib/types/json.js',
          size: 4918,
          humanSize: '4.92 kB'
        }
      ]
    }
  ],
  [
    'express@4.17.1',
    {
      name: 'express',
      version: '4.17.1',
      main: 'index.js',
      fullPath: 'full:node_modules/express',
      relPath: 'node_modules/express',
      modules: [
        {
          modulePath: 'index.js',
          relPath: 'node_modules/express/index.js',
          fullPath: 'full:node_modules/express/index.js',
          size: 224,
          humanSize: '224 B'
        },
        {
          modulePath: 'lib/express.js',
          relPath: 'node_modules/express/lib/express.js',
          fullPath: 'full:node_modules/express/lib/express.js',
          size: 2409,
          humanSize: '2.41 kB'
        },
        {
          modulePath: 'lib/middleware/init.js',
          relPath: 'node_modules/express/lib/middleware/init.js',
          fullPath: 'full:node_modules/express/lib/middleware/init.js',
          size: 853,
          humanSize: '853 B'
        },
        {
          modulePath: 'lib/middleware/query.js',
          relPath: 'node_modules/express/lib/middleware/query.js',
          fullPath: 'full:node_modules/express/lib/middleware/query.js',
          size: 885,
          humanSize: '885 B'
        },
        {
          modulePath: 'lib/router/index.js',
          relPath: 'node_modules/express/lib/router/index.js',
          fullPath: 'full:node_modules/express/lib/router/index.js',
          size: 14883,
          humanSize: '14.9 kB'
        },
        {
          modulePath: 'lib/router/layer.js',
          relPath: 'node_modules/express/lib/router/layer.js',
          fullPath: 'full:node_modules/express/lib/router/layer.js',
          size: 3296,
          humanSize: '3.3 kB'
        }
      ]
    }
  ]
]
```

### ModuleInfo

Allows retrieving info including of its containing package for a specific file.

Given `depstats` obtained previously.

```js
const file = path.resolve(
  appRootDir,
  './node_modules/body-parser/lib/types/text.js'
)
const packageInfo = modulePackageInfo(depstats, file)
console.log(inspect(packageInfo, { depth: 5 }))
```

Outputs the below where `full:` is the actual full path for your case.

```
{
  pkg: {
    name: 'body-parser',
    version: '1.19.0',
    main: 'index.js',
    fullPath: 'full:node_modules/body-parser',
    relPath: 'node_modules/body-parser'
  },
  mdl: {
    modulePath: 'lib/types/text.js',
    relPath: 'node_modules/body-parser/lib/types/text.js',
    fullPath: 'full:node_modules/body-parser/lib/types/text.js',
    size: 2285,
    humanSize: '2.29 kB'
  }
}
```

## LICENSE

MIT

---
_Source: https://npm.io/package/depstats · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._