Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ryan-williams/scala-pkg-deps

Hacky tool for inferring Scala projects' intra-project, inter-package dependencies and rendering them to DOT graphs.
https://github.com/ryan-williams/scala-pkg-deps

Last synced: about 2 months ago
JSON representation

Hacky tool for inferring Scala projects' intra-project, inter-package dependencies and rendering them to DOT graphs.

Host: GitHub
URL: https://github.com/ryan-williams/scala-pkg-deps
Owner: ryan-williams
License: apache-2.0
Created: 2016-12-10T03:59:50.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2016-12-10T14:53:53.000Z (about 8 years ago)
Last Synced: 2024-10-20T07:45:20.583Z (3 months ago)
Language: Scala
Size: 71.3 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # scala-pkg-deps

Hacky tool for inferring Scala projects' intra-project, inter-package dependencies and rendering them to DOT graphs.

[![Build Status](https://travis-ci.org/ryan-williams/scala-pkg-deps.svg?branch=master)](https://travis-ci.org/ryan-williams/scala-pkg-deps)

[![Coverage Status](https://coveralls.io/repos/github/ryan-williams/scala-pkg-deps/badge.svg?branch=master)](https://coveralls.io/github/ryan-williams/scala-pkg-deps?branch=master)

## Usage

```bash

git clone [email protected]:ryan-williams/scala-pkg-deps.git

cd scala-pkg-deps

sbt pack

target/pack/bin/inter-package-deps-to-dot   # Outputs DOT to stdout.

target/pack/bin/inter-package-deps-to-dot  

```

## Examples

[`src/test/resources/guac-readsets`](src/test/resources/guac-readsets) has a small example taken from [hammerlab/guacamole](https://github.com/hammerlab/guacamole).

Here is a rendered dot-graph on all of [hammerlab/guacamole](https://github.com/hammerlab/guacamole):

![](https://d3vv6lp55qjaqc.cloudfront.net/items/15300m2y3a2g0c0m0P3N/download%20(2).png?X-CloudApp-Visitor-Id=486740)

## Caveats

This tool uses [a couple of simple regexs](https://github.com/ryan-williams/scala-pkg-deps/blob/826b24ec73728be2b7dca0ca57a9bf2521f559ac/src/main/scala/com/runsascoded/deps/InterPackageDepsToDot.scala#L19-L21) to try to find `package` declarations and `import` statements; as a result, it may produce incorrect results in arbitrary ways.