Giter Club home page Giter Club logo

detangler's Introduction

Detangler

Analyzes dependency structure and cycles

Levels

  • there must be at least 1 level
  • the last level is always the class level
  • the second to last level is the package level
  • the first x levels greater than 2 establish a hierarchy
  • every class will be broken down into the same number of levels
    • this makes sensible graphs possible without losing information
    • placeholders will be created if necessary

3 level example

Suppose you had the following configuration

{
  level 3
  startsWith {
    include [[com seanshubin]]
    drop [[com seanshubin]]
  }
}

And the following (contrived) classes

com.seanshubin.detangler.analysis.Detangler
com.seanshubin.detangler.analysis.tree.DetanglerBackedByTree
com.seanshubin.detangler.Metrics
com.seanshubin.CollectionUtil

Here is how they would be broken down into levels

drop top package class
com.seanshubin detangler analysis Detangler
com.seanshubin detangler analysis.tree DetanglerBackedByTree
com.seanshubin detangler root-of-detangler Metrics
com.seanshubin -root- -root- CollectionUtil

Configuration File

{
  reportDir console/target/detangled
  searchPaths [
    console/target/detangler.jar
  ]
  level 2
  startsWith {
    include [[com seanshubin detangler]]
    drop [[com seanshubin detangler]]
    exclude []
  }
  allowedInCycle console/detangler-allowed-in-cycle.txt
  canFailBuild true
}

Running from the command line

java -jar console/target/detangler.jar console/detangler.txt

Running from maven

In the file maven-sample/pom.xml

<plugin>
    <groupId>com.seanshubin.detangler</groupId>
    <artifactId>detangler-maven-plugin</artifactId>
    <version>0.9.4</version>
    <executions>
        <execution>
            <phase>verify</phase>
            <goals>
                <goal>report</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <detanglerConfig>detangler.txt</detanglerConfig>
    </configuration>
</plugin>

At the console

mvn -f maven-sample/ detangler:report -DdetanglerConfig=detangler.txt

detangler's People

Contributors

seanshubin avatar faithfulheretic avatar

Watchers

Erik Forkalsrud avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.