Add color highlighting to build script output

Change-Id: I94bf20f08e7f466e0bc1208920d0d79c1666e334
Reviewed-by: Karsten Heimrich <karsten.heimrich@qt.io>

16 files changed, 116 insertions, 42 deletions

diff --git a/scripts/vstools/args.cmd b/scripts/vstools/args.cmd
index be53965c..5a06bb5e 100644
--- a/scripts/vstools/args.cmd
+++ b/scripts/vstools/args.cmd
@@ -33,7 +33,7 @@ IF "%ARG%" == "-init" (
 ) ELSE IF "%ARG%" == "-version" (
     IF "%2" == "" (
         %##########################%
-        %##% Missing argument after '%ORIGINAL_ARG%' 1>&2
+        %##% %BOLD%%RED%Missing argument after '%ORIGINAL_ARG%'.%RESET% 1>&2
         %##########################%
         CALL %SCRIPTLIB%\usage.cmd
         EXIT /B 1
@@ -59,7 +59,7 @@ IF "%ARG%" == "-init" (
 ) ELSE IF "%ARG%" == "-vcvars" (
     IF "%~2" == "" (
         %##########################%
-        %##% Missing argument after '%ORIGINAL_ARG%' 1>&2
+        %##% %BOLD%%RED%Missing argument after '%ORIGINAL_ARG%'.%RESET% 1>&2
         %##########################%
         CALL %SCRIPTLIB%\usage.cmd
         EXIT /B 1
@@ -69,7 +69,7 @@ IF "%ARG%" == "-init" (
 ) ELSE IF "%ARG%" == "-config" (
     IF "%~2" == "" (
         %##########################%
-        %##% Missing argument after '%ORIGINAL_ARG%' 1>&2
+        %##% %BOLD%%RED%Missing argument after '%ORIGINAL_ARG%'.%RESET% 1>&2
         %##########################%
         CALL %SCRIPTLIB%\usage.cmd
         EXIT /B 1
@@ -79,7 +79,7 @@ IF "%ARG%" == "-init" (
 ) ELSE IF "%ARG%" == "-platform" (
     IF "%~2" == "" (
         %##########################%
-        %##% Missing argument after '%ORIGINAL_ARG%' 1>&2
+        %##% %BOLD%%RED%Missing argument after '%ORIGINAL_ARG%'.%RESET% 1>&2
         %##########################%
         CALL %SCRIPTLIB%\usage.cmd
         EXIT /B 1
@@ -105,7 +105,7 @@ IF "%ARG%" == "-init" (
     EXIT /B 1
 ) ELSE (
     %##########################%
-    %##% Unknown argument '%ORIGINAL_ARG%' 1>&2
+    %##% %BOLD%%RED%Unknown argument '%ORIGINAL_ARG%'.%RESET% 1>&2
     %##########################%
     CALL %SCRIPTLIB%\usage.cmd
     EXIT /B 1
diff --git a/scripts/vstools/clean.cmd b/scripts/vstools/clean.cmd
index 816e840d..5a33b70f 100644
--- a/scripts/vstools/clean.cmd
+++ b/scripts/vstools/clean.cmd
@@ -16,7 +16,7 @@ IF "%BUILD_PLATFORM%" == "" (
 
 ECHO.
 %##########################%
-%##% Deleting output files...
+%##% %BOLD%Deleting output files...%RESET%
 %##########################%
 RD /S /Q bin > NUL 2>&1
 FOR /F %ALL% %%d IN (`DIR /A:D /B /S bin 2^> NUL`) DO (
@@ -31,7 +31,7 @@ CALL %SCRIPTLIB%\log_version.cmd
 
 ECHO.
 %##########################%
-%##% Restoring packages...
+%##% %BOLD%Restoring packages...%RESET%
 IF %VERBOSE% (
     %##%  msbuild: vstools.sln
     %##%  msbuild: -t:Restore
@@ -40,6 +40,7 @@ IF %VERBOSE% (
     %##%  msbuild extras: %MSBUILD_EXTRAS%
 )
 %##########################%
+IF NOT %VERBOSE% ECHO %DARK_GRAY%
 msbuild ^
     -nologo ^
     -verbosity:%MSBUILD_VERBOSITY% ^
@@ -48,6 +49,7 @@ msbuild ^
     -p:Platform=%BUILD_PLATFORM% ^
     %MSBUILD_EXTRAS% ^
     vstools.sln
+ECHO %RESET%
 IF %ERRORLEVEL% NEQ 0 (
     CALL %SCRIPTLIB%\error.cmd %ERRORLEVEL% "ERROR restoring packages!"
     EXIT /B %ERRORLEVEL%
diff --git a/scripts/vstools/console.cmd b/scripts/vstools/console.cmd
new file mode 100644
index 00000000..03c1314b
--- /dev/null
+++ b/scripts/vstools/console.cmd
@@ -0,0 +1,55 @@
+::**************************************************************************************************
+::Copyright (C) 2023 The Qt Company Ltd.
+::SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
+::**************************************************************************************************
+
+::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+::console.cmd
+:: * Definitions that enable use of console features (e.g. color text)
+::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
+
+SET ESC=
+SET [=%ESC%[
+SET ]=m
+
+SET RESET=%[%0%]%
+
+SET BOLD=%[%1%]%
+SET UNDERLINE=%[%4%]%
+SET NO_UNDERLINE=%[%24%]%
+SET INVERSE=%[%7%]%
+SET NO_INVERSE=%[%27%]%
+
+SET BLACK=%[%30%]%
+SET DARK_RED=%[%31%]%
+SET DARK_GREEN=%[%32%]%
+SET DARK_YELLOW=%[%33%]%
+SET DARK_BLUE=%[%34%]%
+SET DARK_MAGENTA=%[%35%]%
+SET DARK_CYAN=%[%36%]%
+SET DARK_GRAY=%[%90%]%
+SET GRAY=%[%37%]%
+SET RED=%[%91%]%
+SET GREEN=%[%92%]%
+SET YELLOW=%[%93%]%
+SET BLUE=%[%94%]%
+SET MAGENTA=%[%95%]%
+SET CYAN=%[%96%]%
+SET WHITE=%[%97%]%
+
+SET BKG_BLACK=%[%40%]%
+SET BKG_DARK_RED=%[%41%]%
+SET BKG_DARK_GREEN=%[%42%]%
+SET BKG_DARK_YELLOW=%[%43%]%
+SET BKG_DARK_BLUE=%[%44%]%
+SET BKG_DARK_MAGENTA=%[%45%]%
+SET BKG_DARK_CYAN=%[%46%]%
+SET BKG_DARK_GRAY=%[%100%]%
+SET BKG_GRAY=%[%47%]%
+SET BKG_RED=%[%101%]%
+SET BKG_GREEEN=%[%102%]%
+SET BKG_YELLOW=%[%103%]%
+SET BKG_BLUE=%[%104%]%
+SET BKG_MAGENTA=%[%105%]%
+SET BKG_CYAN=%[%106%]%
+SET BKG_WHITE=%[%107%]%
diff --git a/scripts/vstools/deploy.cmd b/scripts/vstools/deploy.cmd
index 583452fb..2c9de69b 100644
--- a/scripts/vstools/deploy.cmd
+++ b/scripts/vstools/deploy.cmd
@@ -10,16 +10,18 @@
 
 ECHO.
 %##########################%
-%##% Deploying to %DEPLOY_DIR%...
-%##########################%
+%##% %BOLD%Deploying to %DEPLOY_DIR%\%VERSION%.%VERSION_REV%...%RESET%
 IF "%VERSION_REV%" == "" (
-    ECHO   QtVsTools.vsix -^> qt-vsaddin-msvc%VS%-%VERSION%.vsix
+    %##%   QtVsTools.vsix -^> qt-vsaddin-msvc%VS%-%VERSION%.vsix
     MD "%DEPLOY_DIR%\%VERSION%.0" > NUL 2>&1
     COPY /Y QtVsTools.Package\bin\Release\QtVsTools.vsix ^
-        "%DEPLOY_DIR%\%VERSION%.0\qt-vsaddin-msvc%VS%-%VERSION%.vsix"
+        "%DEPLOY_DIR%\%VERSION%.0\qt-vsaddin-msvc%VS%-%VERSION%.vsix" > NUL ^
+    || (%##%   %BOLD%%RED%Error copying package to deploy dir.%RESET%)
 ) ELSE (
-    ECHO   QtVsTools.vsix -^> qt-vsaddin-msvc%VS%-%VERSION%-rev.%VERSION_REV%.vsix
+    %##%   QtVsTools.vsix -^> qt-vsaddin-msvc%VS%-%VERSION%-rev.%VERSION_REV%.vsix
     MD "%DEPLOY_DIR%\%VERSION%.%VERSION_REV%" > NUL 2>&1
     COPY /Y QtVsTools.Package\bin\Release\QtVsTools.vsix ^
-        "%DEPLOY_DIR%\%VERSION%.%VERSION_REV%\qt-vsaddin-msvc%VS%-%VERSION%-rev.%VERSION_REV%.vsix"
+        "%DEPLOY_DIR%\%VERSION%.%VERSION_REV%\qt-vsaddin-msvc%VS%-%VERSION%-rev.%VERSION_REV%.vsix" > NUL ^
+    || (%##%   %BOLD%%RED%Error copying package to deploy dir.%RESET%)
 )
+%##########################%
diff --git a/scripts/vstools/error.cmd b/scripts/vstools/error.cmd
index 17a38786..a8a2a779 100644
--- a/scripts/vstools/error.cmd
+++ b/scripts/vstools/error.cmd
@@ -11,6 +11,6 @@
 
 ECHO.
 %##########################%
-%##% %~2 1>&2
+%##% %BOLD%%RED%%~2%RESET% 1>&2
 %##########################%
 EXIT /B %1
diff --git a/scripts/vstools/globals.cmd b/scripts/vstools/globals.cmd
index 8e6f7e58..96d28870 100644
--- a/scripts/vstools/globals.cmd
+++ b/scripts/vstools/globals.cmd
@@ -50,3 +50,4 @@ SET FLAG_VS2022=-vs2022
 SET FLAG_VS2019=-vs2019
 
 CALL %SCRIPTLIB%\banner.cmd
+CALL %SCRIPTLIB%\console.cmd
diff --git a/scripts/vstools/info.cmd b/scripts/vstools/info.cmd
index 229ee5a7..ec72c1b4 100644
--- a/scripts/vstools/info.cmd
+++ b/scripts/vstools/info.cmd
@@ -19,7 +19,7 @@ EXIT /B
 ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
 ECHO.
 %##########################%
-%##% %VS_NAME% ^(%VS_VERSION%^)
+%##% %BOLD%%VS_NAME%%RESET% ^(%VS_VERSION%^)
 IF NOT "%MSBUILD_VERSION%" == "" (
     IF "%VSCMD_ARG_HOST_ARCH%" == "%VSCMD_ARG_TGT_ARCH%" (
         %##% MSBuild v%MSBUILD_VERSION% ^(%VSCMD_ARG_TGT_ARCH%^)
@@ -28,9 +28,9 @@ IF NOT "%MSBUILD_VERSION%" == "" (
     )
 )
 IF "%VERSION_REV%" == "" (
-    %##% Qt VS Tools version: %VERSION%
+    %##% Qt VS Tools version: %BOLD%%VERSION%%RESET%
 ) ELSE (
-    %##% Qt VS Tools version: %VERSION% ^(rev.%VERSION_REV%^)
+    %##% Qt VS Tools version: %BOLD%%VERSION% ^(rev.%VERSION_REV%^)%RESET%
 )
 IF NOT "%DEPLOY_DIR%" == "" %##% Deploy to: %DEPLOY_DIR%
 %##########################%
@@ -41,8 +41,8 @@ EXIT /B
 ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
 ECHO.
 %##########################%
-%##% %VS_NAME% ^(%VS_VERSION%^)
-%##% %VS_PATH%
+%##% %BOLD%%VS_NAME%%RESET% ^(%VS_VERSION%^)
+%##% %DARK_GRAY%%VS_PATH%%RESET%
 %##########################%
 EXIT /B
 
diff --git a/scripts/vstools/init.cmd b/scripts/vstools/init.cmd
index becf9b15..dcefa005 100644
--- a/scripts/vstools/init.cmd
+++ b/scripts/vstools/init.cmd
@@ -14,7 +14,7 @@ IF "%BUILD_PLATFORM%" == "" (
 
 ECHO.
 %##########################%
-%##% Building pre-requisites...
+%##% %BOLD%Building pre-requisites...%RESET%
 IF %VERBOSE% (
     %##%  msbuild: vstools.sln
     %##%  msbuild: -t:%DEPENDENCIES%
@@ -24,6 +24,7 @@ IF %VERBOSE% (
     %##%  msbuild extras: %MSBUILD_EXTRAS%
 )
 %##########################%
+IF NOT %VERBOSE% ECHO %DARK_GRAY%
 msbuild ^
     -nologo ^
     -verbosity:%MSBUILD_VERBOSITY% ^
@@ -34,7 +35,7 @@ msbuild ^
     -p:TransformOutOfDateOnly=false ^
     %MSBUILD_EXTRAS% ^
     vstools.sln
-
+ECHO %RESET%
 IF %ERRORLEVEL% NEQ 0 (
     CALL %SCRIPTLIB%\error.cmd %ERRORLEVEL% "ERROR building pre-requisites"
     EXIT /B %ERRORLEVEL%
diff --git a/scripts/vstools/install.cmd b/scripts/vstools/install.cmd
index 7a67a129..8e41526f 100644
--- a/scripts/vstools/install.cmd
+++ b/scripts/vstools/install.cmd
@@ -11,7 +11,7 @@
 
 ECHO.
 %##########################%
-%##% Installing extension package
+%##% %BOLD%Installing extension package%RESET%
 %##########################%
 
 ECHO Removing previous installation...
diff --git a/scripts/vstools/log_version.cmd b/scripts/vstools/log_version.cmd
index 55f68ff8..2b615aad 100644
--- a/scripts/vstools/log_version.cmd
+++ b/scripts/vstools/log_version.cmd
@@ -10,10 +10,12 @@
 
 ECHO.
 %##########################%
-%##% Logging extension version
-%##########################%
+%##% %BOLD%Logging extension version%RESET%
 IF "%VERSION_REV%" == "" (
     ECHO %VERSION%.0 > version.log
+    %##% %BOLD%%DARK_CYAN%%VERSION%%RESET%
 ) ELSE (
     ECHO %VERSION%.%VERSION_REV% > version.log
+    %##% %BOLD%%DARK_CYAN%%VERSION% ^(rev.%VERSION_REV%^)%RESET%
 )
+%##########################%
diff --git a/scripts/vstools/msbuild.cmd b/scripts/vstools/msbuild.cmd
index b71e40ad..96549ae0 100644
--- a/scripts/vstools/msbuild.cmd
+++ b/scripts/vstools/msbuild.cmd
@@ -14,6 +14,7 @@ IF "%BUILD_PLATFORM%" == "" (
 
 ECHO.
 %##########################%
+%##% %BOLD%Building...%RESET%
 %##% msbuild: vstools.sln
 %##% msbuild: -t:%MSBUILD_TARGETS%
 %##% msbuild: -p:Configuration=%BUILD_CONFIGURATION%
@@ -24,6 +25,7 @@ IF %VERBOSE% (
     %##% msbuild extras: %MSBUILD_EXTRAS%
 )
 %##########################%
+IF NOT %VERBOSE% ECHO %DARK_GRAY%
 msbuild ^
     -nologo ^
     -verbosity:%MSBUILD_VERBOSITY% ^
@@ -34,12 +36,12 @@ msbuild ^
     -t:%MSBUILD_TARGETS% ^
     %MSBUILD_EXTRAS% ^
     vstools.sln
-
+ECHO %RESET%
 IF %ERRORLEVEL% NEQ 0 (
     CALL %SCRIPTLIB%\error.cmd %ERRORLEVEL% "ERROR building solution"
     EXIT /B %ERRORLEVEL%
 )
 
 CALL %SCRIPTLIB%\info.cmd "version"
-%##% Solution build successful.
+%##% %BOLD%%GREEN%Solution build successful.%RESET%
 %##########################%
diff --git a/scripts/vstools/startvs.cmd b/scripts/vstools/startvs.cmd
index 2ed8e683..bb97394d 100644
--- a/scripts/vstools/startvs.cmd
+++ b/scripts/vstools/startvs.cmd
@@ -9,6 +9,6 @@
 ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
 
 %##########################%
-%##% Starting Visual Studio...
+%##% %BOLD%Starting Visual Studio...%RESET%
 %##########################%
 devenv vstools.sln
diff --git a/scripts/vstools/tests.cmd b/scripts/vstools/tests.cmd
index 731c8f3c..7bdc4e07 100644
--- a/scripts/vstools/tests.cmd
+++ b/scripts/vstools/tests.cmd
@@ -11,7 +11,7 @@
 
 ECHO.
 %##########################%
-%##% Finding tests...
+%##% %BOLD%Finding tests...%RESET%
 
 DEL %TEMP%\vstools.args > NUL 2>&1
 
@@ -30,29 +30,37 @@ FINDSTR /C:dll %TEMP%\vstools.args > NUL 2>&1 ^
     FOR /F %%c in ('TYPE %TEMP%\vstools.args') DO %##%   * %%~nc
     %##########################%
     ECHO.
+    %##########################%
+    %##% %BOLD%Running tests...%RESET%
+    %##########################%
+    IF NOT %VERBOSE% ECHO %DARK_GRAY%
     IF %VERBOSE% (
         %##% vstest.console /logger:console;verbosity=detailed @%TEMP%\vstools.args
         vstest.console /logger:console;verbosity=detailed @%TEMP%\vstools.args ^
         || (
-            GOTO :return
+            ECHO %RESET%
+            GOTO :error
         )
     ) ELSE (
         vstest.console @%TEMP%\vstools.args ^
         || (
-            GOTO :return
+            ECHO %RESET%
+            GOTO :error
         )
     )
 ) || (
-    %##%   * No tests found.
+    %##%   * %BOLD%%YELLOW%No tests found.%RESET%
     %##########################%
     GOTO :eof
 )
 
+ECHO %RESET%
 CALL %SCRIPTLIB%\info.cmd "version"
-%##% Tests completed successfully
+%##% %BOLD%%GREEN%Test run successful.%RESET%
 %##########################%
+GOTO :eof
 
-:return
+:error
 IF %ERRORLEVEL% NEQ 0 (
     CALL %SCRIPTLIB%\error.cmd %ERRORLEVEL% "Tests failed!"
     EXIT /B %ERRORLEVEL%
diff --git a/scripts/vstools/validate.cmd b/scripts/vstools/validate.cmd
index bc74b336..a8b69c26 100644
--- a/scripts/vstools/validate.cmd
+++ b/scripts/vstools/validate.cmd
@@ -12,7 +12,7 @@
 IF %VERBOSE% CALL %SCRIPTLIB%\info.cmd "args"
 
 IF NOT EXIST vstools.sln (
-    ECHO Error: could not find Qt VS Tools solution file.
+    ECHO %BOLD%%RED%Error: could not find Qt VS Tools solution file.%RESET%
     EXIT /B 1
 )
 
@@ -45,12 +45,12 @@ IF %BINARYLOG% (
 )
 
 IF NOT EXIST vstools.sln (
-    ECHO Error: could not find Qt VS Tools solution file.
+    ECHO %BOLD%%RED%Error: could not find Qt VS Tools solution file.%RESET%
     EXIT /B 1
 )
 
 IF NOT EXIST %VSWHERE_EXE% (
-    ECHO Error: could not find Visual Studio Locator tool.
+    ECHO %BOLD%%RED%Error: could not find Visual Studio Locator tool.%RESET%
     EXIT /B 1
 )
 
@@ -74,12 +74,12 @@ FOR /F "tokens=5,6,7 delims=.+ " %%v IN ("%VSWHERE_LOGO%") DO (
     )
 )
 IF NOT %VSWHERE_OK% (
-    ECHO Error: Visual Studio Locator version must be %VSWHERE_VERSION% or greater.
+    ECHO %BOLD%%RED%Error: Visual Studio Locator version must be %VSWHERE_VERSION% or greater.%RESET%
     EXIT /B 1
 )
 
 WHERE /Q git.exe || (
-    ECHO Error: could not find git.
+    ECHO %BOLD%%RED%Error: could not find git.%RESET%
     EXIT /B 1
 )
 IF %VERBOSE% %##% git describe --tags
diff --git a/scripts/vstools/vs_versions.cmd b/scripts/vstools/vs_versions.cmd
index 215167ae..e6ad9079 100644
--- a/scripts/vstools/vs_versions.cmd
+++ b/scripts/vstools/vs_versions.cmd
@@ -20,7 +20,7 @@ FOR %%v IN (%VS_VERSIONS%) DO (
 )
 IF %EMPTY_LOOP% (
     %##########################%
-    %##% No matching Visual Studio instances were found
+    %##% %BOLD%%YELLOW%No matching Visual Studio instances were found%RESET%
     %##########################%
     EXIT /B 1
 )
@@ -95,15 +95,15 @@ CALL "%VS_PATH%\VC\Auxiliary\Build\vcvars64.bat" %VCVARS_ARCH% > NUL
 
 WHERE /Q msbuild && (
     FOR /F %ALL% %%m IN (`msbuild -version -nologo`) DO SET MSBUILD_VERSION=%%m
-) || (
-    ECHO ERRORCODE: msbuild not found
+)
+IF %ERRORLEVEL% NEQ 0 (
+    ECHO %BOLD%%RED%ERROR: msbuild not found%RESET%
     ENDLOCAL
     SET ERRORCODE=3
     EXIT /B
 )
 
 CALL %SCRIPTLIB%\info.cmd "version"
-IF %VERBOSE% SET
 
 IF NOT %INIT% IF NOT %REBUILD% IF %START_VS% (
     CALL %SCRIPTLIB%\startvs.cmd
diff --git a/vstools.sln b/vstools.sln
index d63effa2..669c2af2 100644
--- a/vstools.sln
+++ b/vstools.sln
@@ -121,6 +121,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "vstools", "vstools", "{E11A
 		scripts\vstools\args.cmd = scripts\vstools\args.cmd
 		scripts\vstools\banner.cmd = scripts\vstools\banner.cmd
 		scripts\vstools\clean.cmd = scripts\vstools\clean.cmd
+		scripts\vstools\console.cmd = scripts\vstools\console.cmd
 		scripts\vstools\deploy.cmd = scripts\vstools\deploy.cmd
 		scripts\vstools\error.cmd = scripts\vstools\error.cmd
 		scripts\vstools\globals.cmd = scripts\vstools\globals.cmd