Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thlorenz/depstats
Groups modules by package and includes stats.
https://github.com/thlorenz/depstats
Last synced: 13 days ago
JSON representation
Groups modules by package and includes stats.
- Host: GitHub
- URL: https://github.com/thlorenz/depstats
- Owner: thlorenz
- Created: 2021-02-08T13:56:31.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-09T18:49:49.000Z (almost 4 years ago)
- Last Synced: 2024-12-10T08:26:50.800Z (about 1 month ago)
- Language: JavaScript
- Size: 25.4 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# depstats [](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
[
[
'[email protected]',
{
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'
}
]
}
],
[
'[email protected]',
{
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