documentation

Author: linkrope

README.md

@@ -1,2 +1,48 @@
-# depend
 Dependency Tool for D
+=====================
+
+This tool checks actual import dependencies against a UML model of target dependencies.
+
+Usage
+-----
+
+Run [dmd](http://dlang.org/dmd-linux.html) with the switch `--deps`
+to extract the actual dependencies. For example:
+
+    dmd -deps=dependencies -c src/depend.d -of/dev/null
+
+Use the _depend_ tool together with the [Graphviz](http://www.graphviz.org) programs
+for a visualization of the module dependencies:
+
+    src/depend.d --dot dependencies | dot -Tsvg -odependencies.svg
+
+For best results, remove the transitive dependencies:
+
+    src/depend.d --dot dependencies | tred | dot -Tsvg -odependencies.svg
+
+Consider switching to package dependencies instead of module dependencies:
+
+    src/depend.d --packages --dot dependencies | tred | dot -Tsvg -odependencies.svg
+
+Or filter dependencies of source files matching a regular expression:
+
+    src/depend.d --filter 'src|test' --dot dependencies | tred | dot -Tsvg -odependencies.svg
+
+Then, specify the target dependencies as a [PlantUML](http://plantuml.sourceforge.net) model.
+For example, create a text file _model.uml_:
+
+    package model {}
+    package view {}
+    package controller {}
+
+    controller ..> view
+    controller ..> model
+    view .> model
+
+Finally, use the _depend_ tool for checking actual dependencies against the target dependencies:
+
+    src/depend.d --target model.uml dependencies
+
+The tool complains about violations:
+
+    error: unintended dependency model -> controller

src/depend.d

@@ -6,13 +6,23 @@ import std.regex;
 import std.stdio;
 import std.typecons;
 
+const USAGE = `Usage: %s [options] FILE
+Process import dependencies as created by dmd with the --deps switch.
+Options:
+  --dot                 Print the dependency graph in the DOT language
+  -f, --filter REGEX    Filter source files  matching the regular expression
+  -h, --help            Display usage information, then exit
+  -p, --packages        Generalize to package dependencies
+  -t, --target FILE     Check against the PlantUML target dependencies`;
+
 alias Dependency = Tuple!(string, "client", string, "supplier");
 
 int main(string[] args)
 {
     import std.getopt : getopt;
 
     bool dot = false;
+    bool help = false;
     bool packages = false;
     string filter;
     string target;
@@ -31,6 +41,14 @@ int main(string[] args)
         return 1;
     }
 
+    if (help)
+    {
+        import std.path : baseName;
+
+        writefln(USAGE, args[0].baseName);
+        return 0;
+    }
+
     File file = (args.length > 1) ? File(args[1]) : stdin;
     auto pattern = regex(filter);
     Dependency[] actualDependencies = moduleDependencies(file, pattern);
@@ -144,7 +162,7 @@ void write(in Dependency[] dependencies)
     writeln("digraph Dependencies {");
     writeln("node [shape=box];");
     foreach (element; dependencies.elements)
-        writeln('"', element,'"');
+        writeln('"', element, '"');
     foreach (dependency; dependencies)
         writeln('"', dependency.client, '"', " -> ", '"', dependency.supplier, '"');
     writeln("}");