[FEAT] stdout judgement (#8)

* [FIX] Fix Reset Template

* [ENHANCE] Add STDOUT Judgement

---------

Co-authored-by: root <>

Author: jamesnulliu

.templates/common/cmake/compilers/cuda-compiler-configs.cmake

@@ -2,7 +2,7 @@
 # @file compiler-configs-cuda.cmake
 # @brief Compiler configurations for cuda.
 #
-# @note Several parameters SHOULD be set BEFORE including this file:
+# @note Values SHOULD be set BEFORE including this file:
 #         - `ENV{NVCC_CCBIN}`: CUDA Compiler bindir. Default: auto-detected.
 #         - `CMAKE_CUDA_STANDARD`: CUDA Standard. Default: 20.
 # ==================================================================================================

.templates/common/cmake/compilers/cxx-compiler-configs.cmake

@@ -2,7 +2,9 @@
 # @file compiler-configs-cpp.cmake
 # @brief Compiler configurations for the host.
 #
-# @note Several parameters SHOULD be set BEFORE including this file:
+# @note Values MUST be set BEFORE including this file:
+#         - `STDOUT_IS_TERMINAL`: Whether stdout is a terminal.
+#       Values SHOULD be set BEFORE including this file:
 #         - `ENV{CXX}`: C++ Compiler. Default: auto-detected.
 #         - `CMAKE_CXX_STANDARD`: C++ Standard. Default: 20.
 #         - `CMAKE_CXX_SCAN_FOR_MODULES`: Whether to use modules. Default: OFF.
@@ -58,3 +60,11 @@ elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
 else()
     log_fatal("Unsupported compiler")
 endif()
+
+if(STDOUT_IS_TERMINAL)
+    add_compile_options(
+        $<$<CXX_COMPILER_ID:GNU>:-fdiagnostics-color=always>
+        $<$<CXX_COMPILER_ID:Clang>:-fcolor-diagnostics>
+        $<$<CXX_COMPILER_ID:MSVC>:/FC>
+    )
+endif()

.templates/common/cmake/libraries/libcuda.cmake

@@ -2,7 +2,7 @@
 # @brief Enable CUDA support.
 # @see "https://cliutils.gitlab.io/modern-cmake/chapters/packages/CUDA.html"
 # 
-# @note Several parameters should be set before including this file:
+# @note Values should be set before including this file:
 #       - CUDA_HOME/CUDA_DIR/ENV{CUDA_HOME}/ENV{CUDA_DIR}:
 #             Path to spdlog libaray installation path.
 # ==================================================================================================

.templates/common/cmake/libraries/libpython.cmake

@@ -1,4 +1,4 @@
-# [SEE] https://cmake.org/cmake/help/latest/module/FindPython.html
+# [SEE] "https://cmake.org/cmake/help/latest/module/FindPython.html"
 find_package(
     Python 
     REQUIRED 

.templates/common/cmake/utils/logging.cmake

@@ -3,11 +3,14 @@
 # @brief Compiler configurations for cuda.
 #
 # @note This file shoule NEVER include any other file (to avoid circular dependencies).
+#
+# @note Values MUST be set BEFORE including this file:
+#         - `STDOUT_IS_TERMINAL`: Whether stdout is a terminal.
 # ==================================================================================================
 
 string(ASCII 27 Esc)
 
-if(CMAKE_COLOR_DIAGNOSTICS)
+if(STDOUT_IS_TERMINAL)
     set(LOG_RED "${Esc}[0;31m")
     set(LOG_GREEN "${Esc}[0;32m")
     set(LOG_YELLOW "${Esc}[0;33m")
@@ -28,11 +31,11 @@ else()
 endif()
 
 if(NOT DEFINED LOG_PREFIX)
-    set(LOG_PREFIX "${LOG_PURPLE}_template_project_name_${LOG_RESET}")
+    set(LOG_PREFIX "_template_project_name_")
 endif()
 
 function(log_info msg)
-    message(STATUS "[${LOG_PREFIX}|${LOG_GREEN}INFO${LOG_RESET}] >>> ${msg}")
+    message(STATUS "[${LOG_PURPLE}${LOG_PREFIX}${LOG_RESET}|${LOG_GREEN}INFO${LOG_RESET}] >>> ${msg}")
 endfunction()
 
 function(log_warning msg)

.templates/cuda_exe/scripts/build.sh

@@ -8,6 +8,14 @@ BUILD_TYPE=Release
 CXX_STANDARD=20
 CUDA_STANDARD=20
 
+if [ -t 1 ]; then
+    STDOUT_IS_TERMINAL=ON
+    export GTEST_COLOR=yes
+else
+    STDOUT_IS_TERMINAL=OFF
+    export GTEST_COLOR=no
+fi
+
 while [[ $# -gt 0 ]]; do
     case $1 in
         -S|--source-dir)
@@ -33,6 +41,7 @@ while [[ $# -gt 0 ]]; do
 done
 
 cmake -G Ninja -S $SOURCE_DIR -B $BUILD_DIR \
+    -DSTDOUT_IS_TERMINAL=$STDOUT_IS_TERMINAL \
     -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
     -DCMAKE_CXX_STANDARD=$CXX_STANDARD \
     -DCMAKE_CUDA_STANDARD=$CUDA_STANDARD

.templates/cuda_lib/scripts/build.sh

@@ -9,6 +9,14 @@ CXX_STANDARD=20
 CUDA_STANDARD=20
 BUILD_SHARED_LIBS=OFF
 
+if [ -t 1 ]; then
+    STDOUT_IS_TERMINAL=ON
+    export GTEST_COLOR=yes
+else
+    STDOUT_IS_TERMINAL=OFF
+    export GTEST_COLOR=no
+fi
+
 while [[ $# -gt 0 ]]; do
     case $1 in
         -S|--source-dir)
@@ -36,6 +44,7 @@ while [[ $# -gt 0 ]]; do
 done
 
 cmake -G Ninja -S $SOURCE_DIR -B $BUILD_DIR \
+    -DSTDOUT_IS_TERMINAL=$STDOUT_IS_TERMINAL \
     -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
     -DCMAKE_CXX_STANDARD=$CXX_STANDARD \
     -DCMAKE_CUDA_STANDARD=$CUDA_STANDARD \

.templates/cxx_exe/scripts/build.sh

@@ -7,6 +7,14 @@ BUILD_DIR=./build
 BUILD_TYPE=Release
 CXX_STANDARD=20
 
+if [ -t 1 ]; then
+    STDOUT_IS_TERMINAL=ON
+    export GTEST_COLOR=yes
+else
+    STDOUT_IS_TERMINAL=OFF
+    export GTEST_COLOR=no
+fi
+
 while [[ $# -gt 0 ]]; do
     case $1 in
         -S|--source-dir)
@@ -30,6 +38,7 @@ while [[ $# -gt 0 ]]; do
 done
 
 cmake -G Ninja -S $SOURCE_DIR -B $BUILD_DIR \
+    -DSTDOUT_IS_TERMINAL=$STDOUT_IS_TERMINAL \
     -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
     -DCMAKE_CXX_STANDARD=$CXX_STANDARD
 

.templates/cxx_lib/scripts/build.sh

@@ -8,6 +8,14 @@ BUILD_TYPE=Release
 CXX_STANDARD=20
 BUILD_SHARED_LIBS=OFF
 
+if [ -t 1 ]; then
+    STDOUT_IS_TERMINAL=ON
+    export GTEST_COLOR=yes
+else
+    STDOUT_IS_TERMINAL=OFF
+    export GTEST_COLOR=no
+fi
+
 while [[ $# -gt 0 ]]; do
     case $1 in
         -S|--source-dir)
@@ -33,6 +41,7 @@ while [[ $# -gt 0 ]]; do
 done
 
 cmake -G Ninja -S $SOURCE_DIR -B $BUILD_DIR \
+    -DSTDOUT_IS_TERMINAL=$STDOUT_IS_TERMINAL \
     -DCMAKE_BUILD_TYPE=$BUILD_TYPE \
     -DCMAKE_CXX_STANDARD=$CXX_STANDARD \
     -DBUILD_SHARED_LIBS=$BUILD_SHARED_LIBS