# @syakoo/dmdg

> dir module dependency graph

Latest version **0.1.8** (published 2022-08-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @syakoo/dmdg
pnpm add @syakoo/dmdg
yarn add @syakoo/dmdg
bun add @syakoo/dmdg
```

Provides the command `dmdg`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2022-08-19 |
| First published | 2022-08-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 13 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | syakoo |
| Maintainers | syakoo |

## Links

- npm: https://www.npmjs.com/package/@syakoo/dmdg
- Repository: https://github.com/syakoo/dmdg
- Homepage: https://www.npmjs.com/package/@syakoo/dmdg
- Issues: https://github.com/syakoo/dmdg/issues
- npm.io page: https://npm.io/package/@syakoo/dmdg

## Dependencies (2)

- [cac](https://npm.io/package/cac.md) ^6.7.12
- [dependency-cruiser](https://npm.io/package/dependency-cruiser.md) ^11.14.1

## Recent versions

- 0.1.8 (latest) — 2022-08-19
- 0.1.7 — 2022-08-19
- 0.1.6 — 2022-08-07
- 0.1.5 — 2022-08-06
- 0.1.4 — 2022-08-06
- 0.1.3 — 2022-08-06
- 0.1.2 — 2022-08-06
- 0.1.1 — 2022-08-06
- 0.1.0 — 2022-08-06

## README

Tool to draw a graph of module dependencies in a directory as Markdown

# Installation

```bash
npm install -D @syakoo/dmdg
```

# Usage

The following will generate a dependency graph for a module in `./src` as README.md ([here](https://github.com/syakoo/dmdg/tree/master/src)):

```bash
npx @syakoo/dmdg draw ./src
```

You can output the results in a block by writing the README as follows:

```Markdown
<!-- DMDG BEGIN -->
Output here
<!-- DMDG END -->
```

The default graph depth is 5, but you can set it yourself:

```bash
npx @syakoo/dmdg draw ./src --maxDepth=10
```

> **Warning**
> Since mermaid is used to draw the graph, if the graph is too large, the drawing will fail.
> It is recommended that maxDepth be set to an appropriate value.

# LICENSE

MIT

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