Skip to main content

시작하기

install#

  • 우선 graphviz를 인스톨합시다. optional로 소개가 되어있지만 궁극적으로 graph를 visualize하기 위해 사용하는 라이브러리이므로 인스톨하는 것이 바람직합니다.
$ brew install graphviz || port install graphviz
# 실행하고자 하는 디렉토리로 이동
$ npm i madge

디렉터리 구조 (예)#

.
├── images
│ └── overview.svg
├── src
├── madge.js
├── .madgerc (optional)
...
└── package.json

api#

madge.js 작성#

api는 개발자의 깃허브나 npm 페이지에 명시되어있습니다.

// madge.js 에 추가 후 madge.js를 node로 실행할 경우
// import
const madge = require('madge');
// functions
madge('path/to/app.js')
.then((res) => res.image('path/to/image.svg'))
.then((writtenImagePath) => {
console.log('Image written to ' + writtenImagePath);
});
//.....더 추가할 수 있습니다.

실행 with CLI#

madge path/src/app.js --[configOption]

configuration#

옵션 또한 깃허브 페이지에 명시되어 있습니다.

유용한 옵션만 소개합니다.

다음페이지에서 참고하세요.

기타#