Giter Club home page Giter Club logo

pdedependencies2dot's Introduction

pdedependencies2dot

Description

Given a folder full of Eclipse plugins projects and features projects, generates a dot dependency graph by reading all the OSGI MANIFEST.MF files and the Eclipse feature.xml files of a set of folders.

Example

Options

Usage: java -jar pdedependencies2dot-1.0-shaded.jar [options...] <folder1,folder2,...>

Arguments and options:
 folder1,folder2,...                   : List of folders recursively containing
                                         plugins and features.
 --allowedPrefixes=STRING              : List of allowed prefixes. If given, a
                                         found plugin/feature is not taken into
                                         account if its id doesn't match one of
                                         these prefixes. (default:
                                         org.eclipse.gemoc)
 --alwaysPrint                         : If set, the output DOT graph is
                                         printed even if an output file is
                                         given.
 --colorSeed=N                         : Seed for the color randomizer. Each
                                         seed is a completely different color
                                         set. (default: 12)
 --excludedFilePatterns=STRING         : List of glob patterns (e.g
                                         **/badfolder/**). If given, a found
                                         plugin/feature is not taken into
                                         account if its file path matches one
                                         of these patterns
 --filteredPrefixes=STRING             : List of forbidden prefixes. If given,
                                         a found plugin/feature is not taken
                                         into account if its id matches one of
                                         these prefixes.
 --hideExternal                        : If set, external dependencies/reference
                                         s for which no MANIFEST.MF/plugin.xml
                                         was found are not displayed.
 --orientation=[horizontal | vertical] : Sets the overall shape of the graph.
                                         (default: horizontal)
 --outputFile=FILE                     : Path to the output file. If given,
                                         will write into this file instead of
                                         printing to the console. (default:
                                         /tmp/mygraph.dot)
 --outputXMIFile=FILE                  : Path to the XMI output file which
                                         contains the intermediate EMF model
                                         representing the features/plugins and
                                         their dependencies . If given, will
                                         write into this file instead of
                                         printing the DOT graph to the console.

Compiling & Using

$ git clone https://github.com/diverse-project/pdedependencies2dot.git
$ cd pdedependencies2dot
$ mvn package

That should produce target/pdedependencies2dot-1.0-shaded.jar, which is executable and contains all dependencies.

To use it:

$ java -jar target/pdedependencies2dot-1.0-shaded.jar --allowedPrefixes=org.company --filteredPrefixes=org.eclipse --outputFile=/tmp/mygraph.dot /my/development/folder

Future work

zest visualization within eclipse?

pdedependencies2dot's People

Contributors

dvojtise avatar ebousse avatar maoschanz avatar sunye avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

pdedependencies2dot's Issues

Extra quote is generated for version numbers in the .dot file

Sample project used to view dependencies : https://git.eclipse.org/c/mmt/org.eclipse.atl.git/

The generated .dot file contains an extra quote in all lines containing a version number. For example in line 19 of the generated .dot file :

"3.1.0)""[fillcolor=lightgray];

This extra quote creates the following error when trying to convert the .dot to .pdf using the command dot -Tpdf atl_deps.dot > atl_deps.pdf :

Error: atl_deps.dot: syntax error in line 19 near '.'

Maven plugin for invoking the tool

It would be cool to have a maven plugin that can invoke this tool

I would happily use it in some projects in order to help document them.

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.