feat(version): add build field to vim.version()

This exposes the git hash of the build to the lua table, generated by CMake. Closes #23863
neovim · Jun 7, 2023 · 4d1265d · 4d1265d
1 parent c1ee187
commit 4d1265d
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/cmake/GenerateVersion.cmake b/cmake/GenerateVersion.cmake
@@ -8,6 +8,9 @@ execute_process(
   ERROR_QUIET
   RESULT_VARIABLE RES)
 
+# Extract build info: "145-g0f9113907" => "g0f9113907"
+string(REGEX REPLACE ".*\\-" "" NVIM_VERSION_BUILD "${GIT_TAG}")
+
 if(RES)
   message(STATUS "Using NVIM_VERSION: ${NVIM_VERSION}")
   file(WRITE "${OUTPUT}" "")
@@ -24,7 +27,7 @@ if(NVIM_VERSION_PRERELEASE)
   set(NVIM_VERSION "${NVIM_VERSION}-${NVIM_VERSION_GIT}")
 endif()
 
-set(NVIM_VERSION_STRING "#define NVIM_VERSION_MEDIUM \"${NVIM_VERSION}\"\n")
+set(NVIM_VERSION_STRING "#define NVIM_VERSION_MEDIUM \"${NVIM_VERSION}\"\n#define NVIM_VERSION_BUILD \"${NVIM_VERSION_BUILD}\"\n")
 
 string(SHA1 CURRENT_VERSION_HASH "${NVIM_VERSION_STRING}")
 if(EXISTS ${OUTPUT})

diff --git a/src/nvim/version.c b/src/nvim/version.c
@@ -43,6 +43,7 @@
   "." STR(NVIM_VERSION_MINOR) "." STR(NVIM_VERSION_PATCH) \
   NVIM_VERSION_PRERELEASE
 #endif
+
 #define NVIM_VERSION_LONG "NVIM " NVIM_VERSION_MEDIUM  // NOLINT(bugprone-suspicious-missing-comma)
 
 char *Version = VIM_VERSION_SHORT;
@@ -2560,6 +2561,11 @@ Dictionary version_dict(void)
   PUT(d, "major", INTEGER_OBJ(NVIM_VERSION_MAJOR));
   PUT(d, "minor", INTEGER_OBJ(NVIM_VERSION_MINOR));
   PUT(d, "patch", INTEGER_OBJ(NVIM_VERSION_PATCH));
+#ifndef NVIM_VERSION_BUILD
+  PUT(d, "build", NIL);
+#else
+  PUT(d, "build", CSTR_AS_OBJ(NVIM_VERSION_BUILD));
+#endif
   PUT(d, "prerelease", BOOLEAN_OBJ(NVIM_VERSION_PRERELEASE[0] != '\0'));
   PUT(d, "api_level", INTEGER_OBJ(NVIM_API_LEVEL));
   PUT(d, "api_compatible", INTEGER_OBJ(NVIM_API_LEVEL_COMPAT));

diff --git a/test/functional/api/version_spec.lua b/test/functional/api/version_spec.lua
@@ -32,8 +32,12 @@ describe("api_info()['version']", function()
     local version = call('api_info')['version']
     local major   = version['major']
     local minor   = version['minor']
+    local build   = version['build']
     local patch   = version['patch']
     local prerelease = version['prerelease']
+
+    assert(build == nil or type(build) == 'string')
+
     eq("number", type(major))
     eq("number", type(minor))
     eq("number", type(patch))