https://github.com/migerh/js-module-walker

Analyze dependencies of es6 module based js projects
https://github.com/migerh/js-module-walker

analysis dependency es6 graph javascript modules

Last synced: 20 days ago
JSON representation

Analyze dependencies of es6 module based js projects

• Host: GitHub
• URL: https://github.com/migerh/js-module-walker
• Owner: migerh
• License: mit
• Created: 2016-12-29T19:24:52.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T15:14:03.000Z (about 2 years ago)
• Last Synced: 2024-11-13T21:46:30.282Z (about 2 months ago)
• Topics: analysis, dependency, es6, graph, javascript, modules
• Language: JavaScript
• Size: 1.87 MB
• Stars: 5
• Watchers: 4
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# js-module-walker

[![Build Status](https://travis-ci.org/migerh/js-module-walker.svg?branch=master)](https://travis-ci.org/migerh/js-module-walker)

[![Code Climate](https://codeclimate.com/github/migerh/js-module-walker/badges/gpa.svg)](https://codeclimate.com/github/migerh/js-module-walker)

[![Test Coverage](https://codeclimate.com/github/migerh/js-module-walker/badges/coverage.svg)](https://codeclimate.com/github/migerh/js-module-walker/coverage)

A dependency analyzer for ECMAScript projects that use es6 modules.

## Installation

```bash

# npm install -g @migerh/js-module-walker

```

## Usage

Invoke with `--help` or `-h` to get up to date information of the accepted input parameters:

```bash

  Usage: js-module-walker [options] 

  Options:

    -h, --help           output usage information

    -o, --output [file]  save output in file

    --find-cycles        detect and highlight cyclic dependencies

    --ignore-packages    ignore dependencies into packages from e.g. node modules

```

Examples:

```bash

$ js-module-walker ./path/to/your/js-project

$ js-module-walker --ignore-packages --output /tmp/dependencies.dot ./path/to/js-files

```

### js-module-walker

An analysis of this very project as of d8636e14 produces the graph below

```bash

$ js-module-walker index.js ./lib | dot -o./examples/js-module-walker-d8636e14.png -T png

```

![js-module-walker example graph](examples/js-module-walker-d8636e14.png)

### [4minitz](https://github.com/4minitz/4minitz)

An open source webapp for meeting minutes; version https://github.com/4minitz/4minitz/commit/215091a7d.

The analysis is restricted to the client side modules.

```bash

$ js-module-walker --find-cycles --ignore-packages ./client/**/*.js ./lib/**/*.js ./imports/**/*.js | dot -Tpng -o./examples/4minitz-client-w-cycles-wo-packages-215091a7d.png

```

Graph: [4minitz dependency graph](examples/4minitz-client-w-cycles-wo-packages-215091a7d.png)

## Contributors

[@yogan](https://github.com/yogan)

## License

This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE) file for more information.