New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate SBT project structure diagram producer into the project #431

Closed
ScalaWilliam opened this Issue Oct 29, 2017 · 1 comment

Comments

Projects
None yet
2 participants
@ScalaWilliam
Owner

ScalaWilliam commented Oct 29, 2017

Skills required: SBT, Scala

At the moment I'm using this funky hack with JetBrains sbt-structure and some XSLT (Saxon) here:
https://github.com/ActionFPS/dev-doc/blob/master/Makefile

This requires a graphviz, sbt and coursier installation. Usage is: sbt SBT_REPO=/path/to/ActionFPS.

What I'm looking instead to do is to self-contain it and have something that could automatically generate it from inside the project itself.

I'd like a root project SBT task definition within this project called generateXmlStructure and generateDotStructure. I intend to use the XML structure at some point.

Purpose: Documentation. The Dot structure I use to generate a nice looking graph with URLs to the GitHub source code, as per demonstration here: https://actionfps.github.io/dev-doc/structure.svg

Demo:
screen shot 2017-10-29 at 08 47 09

There's https://github.com/jrudolph/sbt-dependency-graph but it seems to generate something rather different from what I want, eg per-project full dependencies, creating multiple files.

I'll pay US$25 for the completion of this task via ScalaWilliam Work. As per the rules, type "I agree to the rules and am taking on this task" to lock this task to yourself.

Work item is here: http://work.scalawilliam.com/integrate-sbt-project-diagram/

@laughedelic

This comment has been minimized.

Show comment
Hide comment
@laughedelic

laughedelic Oct 29, 2017

Contributor

I agree to the rules and am taking on this task

Contributor

laughedelic commented Oct 29, 2017

I agree to the rules and am taking on this task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment