feat: Disable "compile_commands.json" symlink creation by default.

Author: Project579

README.md

@@ -134,7 +134,7 @@ project_options(
       ${ENABLE_SANITIZER_UNDEFINED_BEHAVIOR}
       # ENABLE_SANITIZER_THREAD
       # ENABLE_SANITIZER_MEMORY
-      # DISABLE_COMPILE_COMMANDS_SYMLINK
+      # ENABLE_COMPILE_COMMANDS_SYMLINK
       # ENABLE_PCH
       # PCH_HEADERS
       # WARNINGS_AS_ERRORS

docs/src/project_options_api.md

@@ -17,7 +17,7 @@
 - `ENABLE_SANITIZER_UNDEFINED_BEHAVIOR`: Enable undefined behavior sanitizer
 - `ENABLE_SANITIZER_THREAD`: Enable thread sanitizer
 - `ENABLE_SANITIZER_MEMORY`: Enable memory sanitizer
-- `DISABLE_COMPILE_COMMANDS_SYMLINK`: Disable compile_commands.json symlink creation
+- `ENABLE_COMPILE_COMMANDS_SYMLINK`: Enable compile_commands.json symlink creation
 - `ENABLE_PCH`: Enable Precompiled Headers
 - `ENABLE_INCLUDE_WHAT_YOU_USE`: Enable static analysis with include-what-you-use
 - `ENABLE_GCC_ANALYZER`: Enable static analysis with GCC (10+) analyzer

docs/src/project_options_example.md

@@ -92,7 +92,7 @@ project_options(
       ${ENABLE_SANITIZER_UNDEFINED_BEHAVIOR}
       # ENABLE_SANITIZER_THREAD
       # ENABLE_SANITIZER_MEMORY
-      # DISABLE_COMPILE_COMMANDS_SYMLINK
+      # ENABLE_COMPILE_COMMANDS_SYMLINK
       # ENABLE_PCH
       # PCH_HEADERS
       # WARNINGS_AS_ERRORS

src/Common.cmake

@@ -12,7 +12,7 @@ macro(set_project_options_src_dir)
 endmacro()
 
 # Common project settings run by default for all the projects that call `project_options()`
-macro(common_project_options DISABLE_COMPILE_COMMANDS_SYMLINK)
+macro(common_project_options ENABLE_COMPILE_COMMANDS_SYMLINK)
   set_project_options_src_dir()
   message(DEBUG "${ProjectOptions_SRC_DIR}")
 
@@ -74,7 +74,7 @@ macro(common_project_options DISABLE_COMPILE_COMMANDS_SYMLINK)
     # Enable generate compile_commands.json
     set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-    if(NOT ${DISABLE_COMPILE_COMMANDS_SYMLINK})
+    if(${ENABLE_COMPILE_COMMANDS_SYMLINK})
       # Make a symbol link of compile_commands.json on the source dir to help clang based tools find it
       if(WIN32)
         # Detect whether cmake is run as administrator (only administrator can read the LOCAL SERVICE account reg key)

src/DynamicProjectOptions.cmake

@@ -75,7 +75,7 @@ macro(dynamic_project_options)
       "0\;ENABLE_SANITIZER_UNDEFINED_BEHAVIOR\;OFF\;${SUPPORTS_UBSAN}\;Make certain types (numeric mostly) of undefined behavior into runtime errors"
       "0\;ENABLE_SANITIZER_THREAD\;OFF\;OFF\;Make thread race conditions into hard runtime errors"
       "0\;ENABLE_SANITIZER_MEMORY\;OFF\;OFF\;Make other memory errors into runtime errors"
-      "0\;DISABLE_COMPILE_COMMANDS_SYMLINK\;OFF\;OFF\;Don't create a symlink for compile_commands.json"
+      "0\;ENABLE_COMPILE_COMMANDS_SYMLINK\;OFF\;OFF\;Don't create a symlink for compile_commands.json"
       "1\;LINKER\;\;\;Choose a specific linker"
       "1\;VS_ANALYSIS_RULESET\;\;\;Override the defaults for the code analysis rule set in Visual Studio"
       "1\;CONAN_PROFILE\;\;\;Use specific Conan profile"
@@ -205,7 +205,7 @@ macro(dynamic_project_options)
     ${ENABLE_SANITIZER_UNDEFINED_BEHAVIOR_VALUE}
     ${ENABLE_SANITIZER_THREAD_VALUE}
     ${ENABLE_SANITIZER_MEMORY_VALUE}
-    ${DISABLE_COMPILE_COMMANDS_SYMLINK_VALUE}
+    ${ENABLE_COMPILE_COMMANDS_SYMLINK_VALUE}
     ${LINKER_VALUE}
     ${VS_ANALYSIS_RULESET_VALUE}
     ${CONAN_PROFILE_VALUE}

src/Index.cmake

@@ -67,7 +67,7 @@ macro(project_options)
       ENABLE_SANITIZER_UNDEFINED_BEHAVIOR
       ENABLE_SANITIZER_THREAD
       ENABLE_SANITIZER_MEMORY
-      DISABLE_COMPILE_COMMANDS_SYMLINK)
+      ENABLE_COMPILE_COMMANDS_SYMLINK)
   set(oneValueArgs
       PREFIX
       LINKER
@@ -101,7 +101,7 @@ macro(project_options)
     set(WARNING_MESSAGE WARNING)
   endif()
 
-  common_project_options(${ProjectOptions_DISABLE_COMPILE_COMMANDS_SYMLINK})
+  common_project_options(${ProjectOptions_ENABLE_COMPILE_COMMANDS_SYMLINK})
 
   # Add an interface library for the options
   set(_options_target project_options)