Colored output

build-files.txt

@@ -34,12 +34,16 @@ source/dub/internal/sdlang/util.d
 source/dub/internal/undead/xml.d
 source/dub/internal/utils.d
 source/dub/internal/vibecompat/core/file.d
-source/dub/internal/vibecompat/core/log.d
 source/dub/internal/vibecompat/data/json.d
 source/dub/internal/vibecompat/data/serialization.d
 source/dub/internal/vibecompat/data/utils.d
 source/dub/internal/vibecompat/inet/path.d
 source/dub/internal/vibecompat/inet/url.d
+source/dub/internal/colorize/colors.d
+source/dub/internal/colorize/cwrite.d
+source/dub/internal/colorize/package.d
+source/dub/internal/colorize/winterm.d
+source/dub/internal/logging.d
 source/dub/package_.d
 source/dub/packagemanager.d
 source/dub/packagesupplier.d

source/dub/commandline.d

@@ -12,9 +12,9 @@ import dub.dependency;
 import dub.dub;
 import dub.generators.generator;
 import dub.internal.vibecompat.core.file;
-import dub.internal.vibecompat.core.log;
 import dub.internal.vibecompat.data.json;
 import dub.internal.vibecompat.inet.path;
+import dub.internal.logging;
 import dub.package_;
 import dub.packagemanager;
 import dub.packagesuppliers;
@@ -165,6 +165,19 @@ struct CommandLineHandler
 		{
 			options.root_path = options.root_path.expandTilde.absolutePath.buildNormalizedPath;
 		}
+
+		final switch (options.colors_mode) with (options.colors)
+		{
+			case automatic:
+				// Use default determined in internal.logging.initLogging().
+				break;
+			case on:
+				setLoggingColorsEnabled(true);  // enable colors, no matter what
+				break;
+			case off:
+				setLoggingColorsEnabled(false); // disable colors, no matter what
+				break;
+		}
 	}
 
 	/** Get an instance of the requested command.
@@ -398,6 +411,10 @@ int runDubCommandLine(string[] args)
 		return [args0, "run", "-q", "--temp-build", "--single", file, "--"] ~ trailing;
 	}
 
+	// Initialize the logging module, ensure that whether stdout/stderr are a TTY
+	// or not is detected in order to disable colors if the output isn't a console
+	initLogging();
+
 	logDiagnostic("DUB version %s", getDUBVersion());
 
 	version(Windows){
@@ -536,6 +553,8 @@ struct CommonOptions {
 	bool help, annotate, bare;
 	string[] registry_urls;
 	string root_path;
+	enum colors { automatic, on, off } // Style violation in support of invalid option error formatting.
+	colors colors_mode = colors.automatic;
 	SkipPackageSuppliers skipRegistry = SkipPackageSuppliers.none;
 	PlacementLocation placementLocation = PlacementLocation.user;
 
@@ -563,6 +582,13 @@ struct CommonOptions {
 		args.getopt("q|quiet", &quiet, ["Only print warnings and errors"]);
 		args.getopt("verror", &verror, ["Only print errors"]);
 		args.getopt("vquiet", &vquiet, ["Print no messages"]);
+		args.getopt("colors", &colors_mode, [
+			"Configure colored output. Accepted values:",
+			"  automatic: Colored output on console/terminal,",
+			"             unless NO_COLOR is set and non-empty (default)",
+			"         on: Force colors enabled",
+			"        off: Force colors disabled"
+			]);
 		args.getopt("cache", &placementLocation, ["Puts any fetched packages in the specified location [local|system|user]."]);
 
 		version_ = args.hasAppVersion;
@@ -1762,7 +1788,7 @@ class UpgradeCommand : Command {
 		enforceUsage(app_args.length == 0, "Unexpected application arguments.");
 		enforceUsage(!m_verify, "--verify is not yet implemented.");
 		enforce(loadCwdPackage(dub, true), "Failed to load package.");
-		logInfo("Upgrading project in %s", dub.projectPath.toNativeString());
+		logInfo("Upgrading", Color.cyan, "project in %s", dub.projectPath.toNativeString().color(Mode.bold));
 		auto options = UpgradeOptions.upgrade|UpgradeOptions.select;
 		if (m_missingOnly) options &= ~UpgradeOptions.upgrade;
 		if (m_prerelease) options |= UpgradeOptions.preRelease;
@@ -1875,9 +1901,11 @@ class FetchCommand : FetchRemoveCommand {
 		} else {
 			try {
 				dub.fetch(name, Dependency.any, location, fetchOpts);
+				logInfo("Finished", Color.green, "%s fetched", name.color(Mode.bold));
 				logInfo(
 					"Please note that you need to use `dub run <pkgname>` " ~
-					"or add it to dependencies of your package to actually use/run it.");
+					"or add it to dependencies of your package to actually use/run it. "
+				);
 			}
 			catch(Exception e){
 				logInfo("Getting a release version failed: %s", e.msg);
@@ -2086,10 +2114,10 @@ class ListCommand : Command {
 		const pname = pinfo.name;
 		const pvlim = Dependency(pinfo.version_ == "" ? "*" : pinfo.version_);
 		enforceUsage(app_args.length == 0, "The list command supports no application arguments.");
-		logInfo("Packages present in the system and known to dub:");
+		logInfoNoTag("Packages present in the system and known to dub:");
 		foreach (p; dub.packageManager.getPackageIterator()) {
 			if ((pname == "" || pname == p.name) && pvlim.matches(p.version_))
-				logInfo("  %s %s: %s", p.name, p.version_, p.path.toNativeString());
+				logInfo("  %s %s: %s", p.name.color(Mode.bold), p.version_, p.path.toNativeString());
 		}
 		logInfo("");
 		return 0;
@@ -2124,9 +2152,9 @@ class SearchCommand : Command {
 		justify += (~justify & 3) + 1; // round to next multiple of 4
 		foreach (desc, matches; res)
 		{
-			logInfo("==== %s ====", desc);
+			logInfoNoTag("==== %s ====", desc);
 			foreach (m; matches)
-				logInfo("%s%s", leftJustify(m.name ~ " (" ~ m.version_ ~ ")", justify), m.description);
+				logInfoNoTag("  %s%s", leftJustify(m.name ~ " (" ~ m.version_ ~ ")", justify), m.description);
 		}
 		return 0;
 	}

source/dub/compilers/compiler.d

@@ -11,9 +11,10 @@ public import dub.compilers.buildsettings;
 deprecated("Please `import dub.dependency : Dependency` instead") public import dub.dependency : Dependency;
 public import dub.platform : BuildPlatform, matchesSpecification;
 
-import dub.internal.vibecompat.core.log;
 import dub.internal.vibecompat.inet.path;
 
+import dub.internal.logging;
+
 import std.algorithm;
 import std.array;
 import std.exception;

source/dub/compilers/dmd.d

@@ -10,8 +10,8 @@ module dub.compilers.dmd;
 import dub.compilers.compiler;
 import dub.compilers.utils;
 import dub.internal.utils;
-import dub.internal.vibecompat.core.log;
 import dub.internal.vibecompat.inet.path;
+import dub.internal.logging;
 
 import std.algorithm;
 import std.array;

source/dub/compilers/gdc.d

@@ -10,8 +10,8 @@ module dub.compilers.gdc;
 import dub.compilers.compiler;
 import dub.compilers.utils;
 import dub.internal.utils;
-import dub.internal.vibecompat.core.log;
 import dub.internal.vibecompat.inet.path;
+import dub.internal.logging;
 
 import std.algorithm;
 import std.array;

source/dub/compilers/ldc.d

@@ -10,8 +10,8 @@ module dub.compilers.ldc;
 import dub.compilers.compiler;
 import dub.compilers.utils;
 import dub.internal.utils;
-import dub.internal.vibecompat.core.log;
 import dub.internal.vibecompat.inet.path;
+import dub.internal.logging;
 
 import std.algorithm;
 import std.array;

source/dub/compilers/utils.d

@@ -9,10 +9,10 @@ module dub.compilers.utils;
 
 import dub.compilers.buildsettings;
 import dub.platform : BuildPlatform, archCheck, compilerCheck, platformCheck;
-import dub.internal.vibecompat.core.log;
 import dub.internal.vibecompat.inet.path;
-import std.algorithm : canFind, endsWith, filter;
+import dub.internal.logging;
 
+import std.algorithm : canFind, endsWith, filter;
 
 /**
 	Alters the build options to comply with the specified build requirements.

source/dub/dependency.d

@@ -8,12 +8,12 @@
 module dub.dependency;
 
 import dub.internal.utils;
-import dub.internal.vibecompat.core.log;
 import dub.internal.vibecompat.core.file;
 import dub.internal.vibecompat.data.json;
 import dub.internal.vibecompat.inet.path;
 import dub.package_;
 import dub.semver;
+import dub.internal.logging;
 
 import std.algorithm;
 import std.array;

source/dub/dependencyresolver.d

@@ -8,7 +8,7 @@
 module dub.dependencyresolver;
 
 import dub.dependency;
-import dub.internal.vibecompat.core.log;
+import dub.internal.logging;
 
 import std.algorithm : all, canFind, filter, map, sort;
 import std.array : appender, array, join;

source/dub/dub.d

@@ -12,9 +12,9 @@ import dub.dependency;
 import dub.dependencyresolver;
 import dub.internal.utils;
 import dub.internal.vibecompat.core.file;
-import dub.internal.vibecompat.core.log;
 import dub.internal.vibecompat.data.json;
 import dub.internal.vibecompat.inet.url;
+import dub.internal.logging;
 import dub.package_;
 import dub.packagemanager;
 import dub.packagesuppliers;
@@ -549,19 +549,20 @@ class Dub {
 				if (basename == rootbasename) continue;
 
 				if (!m_project.selections.hasSelectedVersion(basename)) {
-					logInfo("Package %s would be selected with version %s.",
-						basename, ver);
+					logInfo("Upgrade", Color.cyan,
+						"Package %s would be selected with version %s", basename, ver);
 					any = true;
 					continue;
 				}
 				auto sver = m_project.selections.getSelectedVersion(basename);
 				if (!sver.path.empty || !sver.repository.empty) continue;
 				if (ver.version_ <= sver.version_) continue;
-				logInfo("Package %s would be upgraded from %s to %s.",
-					basename, sver, ver);
+        logInfo("Upgrade", Color.cyan,
+          "%s would be upgraded from %s to %s.",
+					basename.color(Mode.bold), sver, ver);
 				any = true;
 			}
-			if (any) logInfo("Use \"dub upgrade\" to perform those changes.");
+			if (any) logInfo("Use \"dub upgrade\" to perform those changes");
 			return;
 		}
 
@@ -727,7 +728,7 @@ class Dub {
 	/// Cleans intermediate/cache files of the given package
 	void cleanPackage(NativePath path)
 	{
-		logInfo("Cleaning package at %s...", path.toNativeString());
+		logInfo("Cleaning", Color.green, "package at %s", path.toNativeString().color(Mode.bold));
 		enforce(!Package.findPackageFile(path).empty, "No package found.", path.toNativeString());
 
 		// TODO: clear target files and copy files
@@ -793,13 +794,13 @@ class Dub {
 					packageId, ver, placement);
 				return existing;
 			} else {
-				logInfo("Removing %s %s to prepare replacement with a new version.", packageId, ver);
+				logInfo("Removing", Color.yellow, "%s %s to prepare replacement with a new version", packageId.color(Mode.bold), ver);
 				if (!m_dryRun) m_packageManager.remove(existing);
 			}
 		}
 
-		if (reason.length) logInfo("Fetching %s %s (%s)...", packageId, ver, reason);
-		else logInfo("Fetching %s %s...", packageId, ver);
+		if (reason.length) logInfo("Fetching", Color.yellow, "%s %s (%s)", packageId.color(Mode.bold), ver, reason);
+		else logInfo("Fetching", Color.yellow, "%s %s", packageId.color(Mode.bold), ver);
 		if (m_dryRun) return null;
 
 		logDebug("Acquiring package zip file");
@@ -851,7 +852,7 @@ class Dub {
 	*/
 	void remove(in Package pack)
 	{
-		logInfo("Removing %s in %s", pack.name, pack.path.toNativeString());
+		logInfo("Removing", Color.yellow, "%s (in %s)", pack.name.color(Mode.bold), pack.path.toNativeString());
 		if (!m_dryRun) m_packageManager.remove(pack);
 	}
 
@@ -914,7 +915,6 @@ class Dub {
 		foreach(pack; packages) {
 			try {
 				remove(pack);
-				logInfo("Removed %s, version %s.", package_id, pack.version_);
 			} catch (Exception e) {
 				logError("Failed to remove %s %s: %s", package_id, pack.version_, e.msg);
 				logInfo("Continuing with other packages (if any).");
@@ -1141,7 +1141,7 @@ class Dub {
 		}
 
 		//Act smug to the user.
-		logInfo("Successfully created an empty project in '%s'.", path.toNativeString());
+		logInfo("Success", Color.green, "created empty project in %s", path.toNativeString().color(Mode.bold));
 	}
 
 	private void runCustomInitialization(NativePath path, string type, string[] runArgs)