add --html-style option

- allow to pretty-print HTML output (useful for tests and development)
- quite suboptimal due to rejectedsoftware/diet-ng#33

Author: MartinNowak

source/ddox/htmlgenerator.d

@@ -16,6 +16,7 @@ import std.array;
 import std.digest.md;
 import std.format : formattedWrite;
 import std.string : startsWith, toLower;
+import std.traits : EnumMembers;
 import std.variant;
 import vibe.core.log;
 import vibe.core.file;
@@ -25,6 +26,7 @@ import vibe.inet.path;
 import vibe.http.server;
 import vibe.stream.wrapper : StreamOutputRange;
 import diet.html;
+import diet.traits : dietTraits;
 
 
 /*
@@ -232,11 +234,17 @@ class DocPageInfo {
 	}
 }
 
+@dietTraits
+struct DdoxDietTraits(HTMLOutputStyle htmlStyle) {
+	// fields and functions must be static atm., see https://github.com/rejectedsoftware/diet-ng/issues/33
+	enum HTMLOutputStyle htmlOutputStyle = htmlStyle;
+}
+
 void generateSitemap(OutputStream dst, Package root_package, GeneratorSettings settings, string delegate(in Entity) link_to, HTTPServerRequest req = null)
 {
 	dst.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
 	dst.write("<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\">\n");
-	
+
 	void writeEntry(string[] parts...){
 		dst.write("<url><loc>");
 		foreach( p; parts )
@@ -305,7 +313,15 @@ void generateApiIndex(OutputStream dst, Package root_package, GeneratorSettings
 	info.node = root_package;
 
 	auto rng = StreamOutputRange(dst);
-	rng.compileHTMLDietFile!("ddox.overview.dt", req, info);
+	final switch (settings.htmlOutputStyle)
+	{
+		foreach (htmlOutputStyle; EnumMembers!HTMLOutputStyle)
+		case htmlOutputStyle:
+		{
+			rng.compileHTMLDietFile!("ddox.overview.dt", req, info, DdoxDietTraits!(htmlOutputStyle));
+			return;
+		}
+	}
 }
 
 void generateModulePage(OutputStream dst, Package root_package, Module mod, GeneratorSettings settings, string delegate(in Entity) link_to, HTTPServerRequest req = null)
@@ -319,7 +335,15 @@ void generateModulePage(OutputStream dst, Package root_package, Module mod, Gene
 	info.docGroups = null;
 
 	auto rng = StreamOutputRange(dst);
-	rng.compileHTMLDietFile!("ddox.module.dt", req, info);
+	final switch (settings.htmlOutputStyle)
+	{
+		foreach (htmlOutputStyle; EnumMembers!HTMLOutputStyle)
+		case htmlOutputStyle:
+		{
+			rng.compileHTMLDietFile!("ddox.module.dt", req, info, DdoxDietTraits!(htmlOutputStyle));
+			return;
+		}
+	}
 }
 
 void generateDeclPage(OutputStream dst, Package root_package, Module mod, string nested_name, DocGroup[] docgroups, GeneratorSettings settings, string delegate(in Entity) link_to, HTTPServerRequest req = null)
@@ -337,7 +361,15 @@ void generateDeclPage(OutputStream dst, Package root_package, Module mod, string
 	info.nestedName = nested_name;
 
 	auto rng = StreamOutputRange(dst);
-	rng.compileHTMLDietFile!("ddox.docpage.dt", req, info);
+	final switch (settings.htmlOutputStyle)
+	{
+		foreach (htmlOutputStyle; EnumMembers!HTMLOutputStyle)
+		case htmlOutputStyle:
+		{
+			rng.compileHTMLDietFile!("ddox.docpage.dt", req, info, DdoxDietTraits!(htmlOutputStyle));
+			return;
+		}
+	}
 }
 
 private bool cmpKind(in Entity a, in Entity b)

source/ddox/main.d

@@ -132,6 +132,7 @@ int setupGeneratorInput(ref string[] args, out GeneratorSettings gensettings, ou
 		"sitemap-url", &sitemapurl,
 		"std-macros", &macrofiles,
 		"enum-member-pages", &gensettings.enumMemberPages,
+		"html-style", &gensettings.htmlOutputStyle,
 		);
 	gensettings.siteUrl = URL(sitemapurl);
 
@@ -345,6 +346,7 @@ Use <COMMAND> -h|--help to get detailed usage information for a command.
     --decl-sort=MODE       The sort order used for declaration lists
     --web-file-dir=DIR     Make files from dir available on the served site
     --enum-member-pages    Generate a single page per enum member
+    --html-style=STYLE     Sets the HTML output style, either compact (default) or pretty.
     --hyphenate            hyphenate text
  -h --help                 Show this help
 
@@ -374,6 +376,7 @@ protectionInheritanceName
                            This option is useful on case insensitive file
                            systems.
     --enum-member-pages    Generate a single page per enum member
+    --html-style=STYLE     Sets the HTML output style, either compact (default) or pretty.
     --hyphenate            hyphenate text
  -h --help                 Show this help
 

source/ddox/settings.d

@@ -8,6 +8,7 @@
 module ddox.settings;
 
 import vibe.inet.url;
+import diet.html : HTMLOutputStyle;
 public import vibe.web.common : MethodStyle;
 
 enum SortMode {
@@ -50,6 +51,8 @@ class GeneratorSettings {
 	MethodStyle fileNameStyle = MethodStyle.unaltered;
 	/// Enables syntax highlighting for inline code
 	bool highlightInlineCode = true;
+	/// Select HTML style (e.g. compact, pretty)
+	HTMLOutputStyle htmlOutputStyle = HTMLOutputStyle.compact;
 
 	/// Creates a page per enum member instead of putting everything into a single table.
 	bool enumMemberPages;