Bump to 0.2.10

Better TOML validation

CMakeLists.txt

@@ -25,7 +25,7 @@ project(cmkr
 	LANGUAGES
 		CXX
 	VERSION
-		0.2.6
+		0.2.10
 	DESCRIPTION
 		"CMakeLists generator from TOML"
 )

cmake.toml

@@ -4,7 +4,7 @@ cmkr-include = false
 
 [project]
 name = "cmkr"
-version = "0.2.6"
+version = "0.2.10"
 description = "CMakeLists generator from TOML"
 languages = ["CXX"]
 subdirs = ["third_party", "tests"]

cmake/bump_version.cmake

@@ -12,6 +12,14 @@ if(NOT EXISTS "${CMAKE_SOURCE_DIR}/cmake/cmkr.cmake")
     message(FATAL_ERROR "Cannot find cmkr.cmake")
 endif()
 
+# Validate branch
+find_package(Git REQUIRED)
+execute_process(COMMAND "${GIT_EXECUTABLE}" branch --show-current OUTPUT_VARIABLE GIT_BRANCH)
+string(STRIP "${GIT_BRANCH}" GIT_BRANCH)
+if(NOT GIT_BRANCH STREQUAL "main")
+    message(FATAL_ERROR "You need to be on the main branch, you are on: ${GIT_BRANCH}")
+endif()
+
 file(READ "${CMAKE_SOURCE_DIR}/cmake.toml" CMAKE_TOML)
 string(FIND "${CMAKE_TOML}" "[project]" PROJECT_INDEX)
 string(SUBSTRING "${CMAKE_TOML}" ${PROJECT_INDEX} -1 CMAKE_TOML_PROJECT)

cmake/cmkr.cmake

@@ -2,7 +2,7 @@ include_guard()
 
 # Change these defaults to point to your infrastructure if desired
 set(CMKR_REPO "https://github.com/build-cpp/cmkr" CACHE STRING "cmkr git repository" FORCE)
-set(CMKR_TAG "v0.2.6" CACHE STRING "cmkr git tag (this needs to be available forever)" FORCE)
+set(CMKR_TAG "v0.2.10" CACHE STRING "cmkr git tag (this needs to be available forever)" FORCE)
 
 # To bootstrap/generate a cmkr project: cmake -P cmkr.cmake
 if(CMAKE_SCRIPT_MODE_FILE)
@@ -15,6 +15,7 @@ endif()
 set(CMKR_EXECUTABLE "" CACHE FILEPATH "cmkr executable")
 set(CMKR_SKIP_GENERATION OFF CACHE BOOL "skip automatic cmkr generation")
 set(CMKR_BUILD_TYPE "Debug" CACHE STRING "cmkr build configuration")
+mark_as_advanced(CMKR_REPO CMKR_TAG CMKR_EXECUTABLE CMKR_SKIP_GENERATION CMKR_BUILD_TYPE)
 
 # Disable cmkr if generation is disabled
 if(DEFINED ENV{CI} OR CMKR_SKIP_GENERATION OR CMKR_BUILD_SKIP_GENERATION)
@@ -62,6 +63,8 @@ if(DEFINED ENV{CMKR_CACHE} AND EXISTS "$ENV{CMKR_CACHE}")
     if(NOT CMKR_DIRECTORY_PREFIX MATCHES "\\/$")
         set(CMKR_DIRECTORY_PREFIX "${CMKR_DIRECTORY_PREFIX}/")
     endif()
+    # Build in release mode for the cache
+    set(CMKR_BUILD_TYPE "Release")
 else()
     set(CMKR_DIRECTORY_PREFIX "${CMAKE_CURRENT_BINARY_DIR}/_cmkr_")
 endif()
@@ -69,7 +72,7 @@ set(CMKR_DIRECTORY "${CMKR_DIRECTORY_PREFIX}${CMKR_TAG}")
 set(CMKR_CACHED_EXECUTABLE "${CMKR_DIRECTORY}/bin/${CMKR_EXECUTABLE_NAME}")
 
 # Handle upgrading logic
-if(CMKR_EXECUTABLE AND NOT CMKR_CACHED_EXECUTABLE STREQUAL CMKR_EXECUTABLE)    
+if(CMKR_EXECUTABLE AND NOT CMKR_CACHED_EXECUTABLE STREQUAL CMKR_EXECUTABLE)
     if(CMKR_EXECUTABLE MATCHES "^${CMAKE_CURRENT_BINARY_DIR}/_cmkr")
         if(DEFINED ENV{CMKR_CACHE} AND EXISTS "$ENV{CMKR_CACHE}")
             message(AUTHOR_WARNING "[cmkr] Switching to cached cmkr: '${CMKR_CACHED_EXECUTABLE}'")
@@ -98,7 +101,7 @@ elseif(NOT CMKR_EXECUTABLE AND EXISTS "${CMKR_CACHED_EXECUTABLE}")
 else()
     set(CMKR_EXECUTABLE "${CMKR_CACHED_EXECUTABLE}" CACHE FILEPATH "Full path to cmkr executable" FORCE)
     message(VERBOSE "[cmkr] Bootstrapping '${CMKR_EXECUTABLE}'")
-    
+
     message(STATUS "[cmkr] Fetching cmkr...")
     if(EXISTS "${CMKR_DIRECTORY}")
         cmkr_exec("${CMAKE_COMMAND}" -E rm -rf "${CMKR_DIRECTORY}")
@@ -202,18 +205,18 @@ macro(cmkr)
             # Copy the now-generated CMakeLists.txt to CMakerLists.txt
             # This is done because you cannot include() a file you are currently in
             configure_file(CMakeLists.txt "${CMKR_TEMP_FILE}" COPYONLY)
-            
+
             # Add the macro required for the hack at the start of the cmkr macro
             set_source_files_properties("${CMKR_TEMP_FILE}" PROPERTIES
                 CMKR_CURRENT_LIST_FILE "${CMAKE_CURRENT_LIST_FILE}"
             )
-            
+
             # 'Execute' the newly-generated CMakeLists.txt
             include("${CMKR_TEMP_FILE}")
-            
+
             # Delete the generated file
             file(REMOVE "${CMKR_TEMP_FILE}")
-            
+
             # Do not execute the rest of the original CMakeLists.txt
             return()
         endif()

docs/CNAME

@@ -0,0 +1 @@
+cmkr.build

docs/Gemfile

@@ -3,6 +3,7 @@ gem "minima", "~> 2.5"
 gem "github-pages", group: :jekyll_plugins
 
 gem "jekyll-remote-theme"
+gem "jekyll-sitemap", "~> 1.4.0"
 
 platforms :mingw, :x64_mingw, :mswin, :jruby do
   gem "tzinfo", "~> 1.2"

docs/Gemfile.lock

@@ -271,6 +271,7 @@ PLATFORMS
 DEPENDENCIES
   github-pages
   jekyll-remote-theme
+  jekyll-sitemap (~> 1.4.0)
   just-the-docs
   minima (~> 2.5)
   tzinfo (~> 1.2)

docs/_config.yml

@@ -2,6 +2,7 @@ title: cmkr
 
 plugins:
   - jekyll-remote-theme
+  - jekyll-sitemap
 
 # Automatically deduce dark theme preference https://github.com/pmarsceill/just-the-docs/pull/464
 remote_theme: build-cpp/just-the-docs@light-switch
@@ -9,7 +10,7 @@ search_enabled: true
 color_scheme: light-or-dark
 heading_anchors: true
 aux_links:
-  "cmkr":
+  "GitHub":
     - "https://github.com/build-cpp/cmkr"
 aux_links_new_tab: true
 
@@ -18,4 +19,6 @@ gh_edit_link_text: "Edit this page on GitHub."
 gh_edit_repository: "https://github.com/build-cpp/cmkr"
 gh_edit_branch: "main"
 gh_edit_view_mode: "edit"
-gh_edit_source: docs
+gh_edit_source: docs
+
+production_url : https://cmkr.build

docs/getting-started.html

@@ -0,0 +1,10 @@
+---
+layout: null
+permalink: /getting-started/
+---
+
+<html>
+    <head>
+        <meta http-equiv="refresh" content="0;url=https://cmkr.build">
+    </head>
+</html>

include/project_parser.hpp

@@ -127,6 +127,7 @@ struct Install {
     std::vector<std::string> dirs;
     std::vector<std::string> configs;
     std::string destination;
+    std::string component;
 };
 
 struct Subdir {

src/cmake_generator.cpp

@@ -162,6 +162,10 @@ struct Command {
     }
 
     static std::string quote(const std::string &str) {
+        // Quote an empty string
+        if (str.empty()) {
+            return "\"\"";
+        }
         // Don't quote arguments that don't need quoting
         if (str.find(' ') == std::string::npos && str.find('\"') == std::string::npos && str.find('/') == std::string::npos &&
             str.find(';') == std::string::npos) {
@@ -562,7 +566,7 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
     if (!project.options.empty()) {
         comment("Options");
         for (const auto &opt : project.options) {
-            cmd("option")(opt.name, opt.comment, opt.val ? "ON" : "OFF");
+            cmd("option")(opt.name, RawArg(Command::quote(opt.comment)), opt.val ? "ON" : "OFF");
         }
         endl();
     }
@@ -604,11 +608,13 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
     if (!project.vcpkg.packages.empty()) {
         // Allow the user to specify a url or derive it from the version
         auto url = project.vcpkg.url;
+        auto version_name = url;
         if (url.empty()) {
             if (project.vcpkg.version.empty()) {
                 throw std::runtime_error("You need either [vcpkg].version or [vcpkg].url");
             }
             url = "https://github.com/microsoft/vcpkg/archive/refs/tags/" + project.vcpkg.version + ".tar.gz";
+            version_name = project.vcpkg.version;
         }
 
         // Show a nicer error than vcpkg when specifying an invalid package name
@@ -622,7 +628,7 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
         // clang-format off
         cmd("if")("CMKR_ROOT_PROJECT", "AND", "NOT", "CMKR_DISABLE_VCPKG");
             cmd("include")("FetchContent");
-            cmd("message")("STATUS", "Fetching vcpkg...");
+            cmd("message")("STATUS", "Fetching vcpkg (" + version_name + ")...");
             cmd("FetchContent_Declare")("vcpkg", "URL", url);
             cmd("FetchContent_MakeAvailable")("vcpkg");
             cmd("include")("${vcpkg_SOURCE_DIR}/scripts/buildsystems/vcpkg.cmake");
@@ -689,7 +695,7 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
 
         ofs << "  ],\n";
         ofs << "  \"description\": \"" << escape(project.project_description) << "\",\n";
-        ofs << "  \"name\": \"" << escape(project.project_name) << "\",\n";
+        ofs << "  \"name\": \"" << escape(vcpkg_escape_identifier(project.project_name)) << "\",\n";
         ofs << R"(  "version-string": "")" << '\n';
         ofs << "}\n";
     }
@@ -1028,7 +1034,11 @@ void generate_cmake(const char *path, const parser::Project *parent_project) {
             auto files = std::make_pair("FILES", inst.files);
             auto configs = std::make_pair("CONFIGURATIONS", inst.configs);
             auto destination = std::make_pair("DESTINATION", inst.destination);
-            auto component = std::make_pair("COMPONENT", inst.targets.empty() ? "" : inst.targets.front());
+            auto component_name = inst.component;
+            if (component_name.empty() && !inst.targets.empty()) {
+                component_name = inst.targets.front();
+            }
+            auto component = std::make_pair("COMPONENT", component_name);
             ConditionScope cs(gen, inst.condition);
             cmd("install")(targets, dirs, files, configs, destination, component);
         }

src/project_parser.cpp

@@ -143,14 +143,21 @@ class TomlChecker {
 };
 
 class TomlCheckerRoot {
+    const TomlBasicValue &m_root;
     std::deque<TomlChecker> m_checkers;
+    tsl::ordered_map<toml::key, bool> m_visisted;
     bool m_checked = false;
 
   public:
-    TomlCheckerRoot() = default;
+    TomlCheckerRoot(const TomlBasicValue &root) : m_root(root) {}
     TomlCheckerRoot(const TomlCheckerRoot &) = delete;
     TomlCheckerRoot(TomlCheckerRoot &&) = delete;
 
+    bool contains(const toml::key &ky) {
+        m_visisted[ky] = true;
+        return m_root.contains(ky);
+    }
+
     TomlChecker &create(const TomlBasicValue &v) {
         m_checkers.emplace_back(v);
         return m_checkers.back();
@@ -161,7 +168,14 @@ class TomlCheckerRoot {
         return m_checkers.back();
     }
 
-    void check(const tsl::ordered_map<std::string, std::string> &conditions) {
+    void check(const tsl::ordered_map<std::string, std::string> &conditions, bool check_root) {
+        if (check_root) {
+            for (const auto &itr : m_root.as_table()) {
+                if (!m_visisted.contains(itr.first)) {
+                    throw std::runtime_error(format_key_error("Unknown key '" + itr.first + "'", itr.first, itr.second));
+                }
+            }
+        }
         for (const auto &checker : m_checkers) {
             checker.check(conditions);
         }
@@ -171,13 +185,16 @@ class TomlCheckerRoot {
 Project::Project(const Project *parent, const std::string &path, bool build) {
     const auto toml_path = fs::path(path) / "cmake.toml";
     if (!fs::exists(toml_path)) {
-        throw std::runtime_error("No cmake.toml was found!");
+        throw std::runtime_error("File not found '" + toml_path.string() + "'");
     }
     const auto toml = toml::parse<toml::discard_comments, tsl::ordered_map, std::vector>(toml_path.string());
+    if (toml.size() == 0) {
+        throw std::runtime_error("Empty TOML '" + toml_path.string() + "'");
+    }
 
-    TomlCheckerRoot checker;
+    TomlCheckerRoot checker(toml);
 
-    if (toml.contains("cmake")) {
+    if (checker.contains("cmake")) {
         auto &cmake = checker.create(toml, "cmake");
 
         cmake.required("version", cmake_version);
@@ -209,7 +226,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
 
     // Skip the rest of the parsing when building
     if (build) {
-        checker.check(conditions);
+        checker.check(conditions, false);
         return;
     }
 
@@ -231,14 +248,14 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         templates = parent->templates;
     }
 
-    if (toml.contains("conditions")) {
+    if (checker.contains("conditions")) {
         auto conds = toml::find<decltype(conditions)>(toml, "conditions");
         for (const auto &cond : conds) {
             conditions[cond.first] = cond.second;
         }
     }
 
-    if (toml.contains("project")) {
+    if (checker.contains("project")) {
         auto &project = checker.create(toml, "project");
         project.required("name", project_name);
         project.optional("version", project_version);
@@ -251,7 +268,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         project.optional("subdirs", project_subdirs);
     }
 
-    if (toml.contains("subdir")) {
+    if (checker.contains("subdir")) {
         const auto &subs = toml::find(toml, "subdir").as_table();
         for (const auto &itr : subs) {
             Subdir subdir;
@@ -268,7 +285,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         }
     }
 
-    if (toml.contains("settings")) {
+    if (checker.contains("settings")) {
         using set_map = tsl::ordered_map<std::string, TomlBasicValue>;
         const auto &sets = toml::find<set_map>(toml, "settings");
         for (const auto &itr : sets) {
@@ -297,7 +314,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         }
     }
 
-    if (toml.contains("options")) {
+    if (checker.contains("options")) {
         using opts_map = tsl::ordered_map<std::string, TomlBasicValue>;
         const auto &opts = toml::find<opts_map>(toml, "options");
         for (const auto &itr : opts) {
@@ -315,7 +332,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         }
     }
 
-    if (toml.contains("find-package")) {
+    if (checker.contains("find-package")) {
         using pkg_map = tsl::ordered_map<std::string, TomlBasicValue>;
         const auto &pkgs = toml::find<pkg_map>(toml, "find-package");
         for (const auto &itr : pkgs) {
@@ -337,7 +354,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
     }
 
     // TODO: perform checking here
-    if (toml.contains("fetch-content")) {
+    if (checker.contains("fetch-content")) {
         const auto &fc = toml::find(toml, "fetch-content").as_table();
         for (const auto &itr : fc) {
             Content content;
@@ -370,7 +387,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         }
     }
 
-    if (toml.contains("bin")) {
+    if (checker.contains("bin")) {
         throw std::runtime_error("[[bin]] has been renamed to [[target]]");
     }
 
@@ -489,7 +506,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         return target;
     };
 
-    if (toml.contains("template")) {
+    if (checker.contains("template")) {
         const auto &ts = toml::find(toml, "template").as_table();
         for (const auto &itr : ts) {
             auto &t = checker.create(itr.second);
@@ -517,7 +534,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         }
     }
 
-    if (toml.contains("target")) {
+    if (checker.contains("target")) {
         const auto &ts = toml::find(toml, "target").as_table();
         for (const auto &itr : ts) {
             auto &t = checker.create(itr.second);
@@ -525,7 +542,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         }
     }
 
-    if (toml.contains("test")) {
+    if (checker.contains("test")) {
         const auto &ts = toml::find(toml, "test").as_array();
         for (const auto &value : ts) {
             auto &t = checker.create(value);
@@ -540,7 +557,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         }
     }
 
-    if (toml.contains("install")) {
+    if (checker.contains("install")) {
         const auto &is = toml::find(toml, "install").as_array();
         for (const auto &value : is) {
             auto &i = checker.create(value);
@@ -551,11 +568,12 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
             i.optional("dirs", inst.dirs);
             i.optional("configs", inst.configs);
             i.required("destination", inst.destination);
+            i.optional("component", inst.component);
             installs.push_back(inst);
         }
     }
 
-    if (toml.contains("vcpkg")) {
+    if (checker.contains("vcpkg")) {
         auto &v = checker.create(toml, "vcpkg");
         v.optional("url", vcpkg.url);
         v.optional("version", vcpkg.version);
@@ -581,7 +599,7 @@ Project::Project(const Project *parent, const std::string &path, bool build) {
         }
     }
 
-    checker.check(conditions);
+    checker.check(conditions, true);
 }
 
 bool is_root_path(const std::string &path) {