d2x's project template - base

Sunrisepeak · Sunrisepeak · commit 02a1379af9ec · 2026-01-29T11:33:34.000+08:00
diff --git a/.d2x.json b/.d2x.json
@@ -0,0 +1,11 @@
+{
+    "buildtools": "xmake d2x-buildtools",
+    "lang": "zh",
+    "llm": {
+        "api_key": "",
+        "api_url": "https://api.deepseek.com/v1",
+        "model": "deepseek-chat",
+        "system_prompt": ""
+    },
+    "ui_backend": "tui"
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,47 @@
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# Python
+__pycache__
+
+# d2x project files
+.xlings
+.vscode
+.xmake
+.zed
+llm.config.xlings
+media
+build
+.cache/
+compile_commands.json
+dslings/compile_commands.json
diff --git a/LICENSE b/LICENSE
@@ -1,3 +1,5 @@
+Copyright (c) 2026-present  d2learn, dev@d2learn.org
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
diff --git a/README.md b/README.md
@@ -1,2 +1,16 @@
 # d2x-project-template
+
 d2x项目模板
+
+## 目录结构
+
+```cpp
+├── book    // 项目文档/书籍
+├── d2x     // d2x工具依赖
+│   ├── buildtools
+│   │   ├── cmake
+│   │   └── xmake
+|   ├── cpp
+│   └── mcpp
+└── dslings // 项目练习代码
+```
diff --git a/book/.gitignore b/book/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/book/book.toml b/book/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = ["sunrisepeak"]
+language = "en"
+multilingual = false
+src = "src"
+title = "D2X Project Template | D2X项目模板"
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -0,0 +1,5 @@
+# Summary
+
+- [简介](./chapter_0.md)
+- [环境配置](./chapter_1.md)
+- [使用模板](./chapter_2.md)
diff --git a/book/src/chapter_0.md b/book/src/chapter_0.md
@@ -0,0 +1,2 @@
+# 简介
+
diff --git a/book/src/chapter_1.md b/book/src/chapter_1.md
@@ -0,0 +1,2 @@
+# 环境配置
+
diff --git a/book/src/chapter_2.md b/book/src/chapter_2.md
@@ -0,0 +1 @@
+# 使用模板
diff --git a/config.xlings b/config.xlings
@@ -0,0 +1,24 @@
+-- https://xlings.d2learn.org
+
+xname = "d2x-project-template" -- project name
+
+-- xim-deps
+xim = {
+    vscode = "", -- config by checker.editor
+    cpp = "", -- language：[windows:mingw], [linux:gcc], [macos:clang]
+    mdbook = "0.4.43", -- for d2x book
+    d2x = "0.2.0",
+    xppcmds = {
+        "xmake project -k compile_commands"
+    }
+}
+
+-- TODO: delete d2x from config.xligns
+d2x = {
+    checker = {
+        name = "dslings",
+        editor = "vscode", -- option: vscode, nvim, zed
+    },
+}
+
+xim[d2x.checker.editor or "vscode"] = "" -- config deps(default version
diff --git a/d2x/buildtools/README.md b/d2x/buildtools/README.md
@@ -0,0 +1,14 @@
+# d2x 支持的构建工具
+
+通过对构建工具做最小化的接口规范来适配不同编程语言及其工具链
+
+## 构建工具接口规范
+
+```
+xxx d2x-buildtools [command] [target]
+
+Commands:
+    list        List all targets
+    build       Build specified target
+    run         Run specified target
+```
diff --git a/d2x/buildtools/cmake/README.md b/d2x/buildtools/cmake/README.md
@@ -0,0 +1 @@
+TODO
diff --git a/d2x/buildtools/xmake/main.lua b/d2x/buildtools/xmake/main.lua
@@ -0,0 +1,45 @@
+import("core.base.json")
+import("core.base.option")
+import("core.project.project")
+
+function list()
+    local targets = project.targets()
+    for name, _ in pairs(targets) do
+        local files = targets[name]:sourcefiles()
+        local flag = true
+
+        -- cprintf / print xxx
+        printf(name) -- target name
+        for _, file in ipairs(files) do
+            file = path.absolute(file)
+            if flag then
+                --printf(": " .. file) -- avoid C:\ issue on Windows
+                printf("@ " .. file)
+                flag = false
+            else
+                printf(", " .. file)
+            end
+        end
+        printf("\n")
+    end
+end
+
+function main()
+
+    local command = option.get("command")
+    local target = option.get("target")
+
+    os.cd(os.projectdir())
+    --print("project file: " .. project.rootfile())
+
+    if command == "list" then
+        list()
+    elseif command == "build" then
+        os.exec("xmake build " .. (target or ""))
+    elseif command == "run" then
+        os.exec("xmake run " .. (target or ""))
+    else
+        print("Unknown command: " .. tostring(command))
+    end
+
+end
diff --git a/d2x/buildtools/xmake/xmake.lua b/d2x/buildtools/xmake/xmake.lua
@@ -0,0 +1,14 @@
+task("d2x-buildtools")
+
+    set_category("plugin")
+
+    on_run("main")
+
+    set_menu {
+        usage = "xmake d2x-buildtools [options]",
+        description = "d2x buildtools plugin",
+        options = {
+            {nil, "command", "v", nil, "d2x-buildtools's command"},
+            {nil, "target", "v", nil, "the target name"}
+        }
+    }
diff --git a/d2x/cpp/common.hpp b/d2x/cpp/common.hpp
@@ -0,0 +1,46 @@
+#ifndef COMMON_HPP_D2X
+#define COMMON_HPP_D2X
+
+#include <iostream>
+#include <string>
+
+#include <d2x/cpp/honly_logger.hpp>
+
+#define d2x_assert(expr) \
+{ \
+    if (!(expr)) { \
+        HONLY_LOGW("❌(error) | %s", #expr); \
+    } else { \
+        HONLY_LOGI_P("✅ | %s", #expr); \
+    } \
+}
+
+#define d2x_assert_eq(a, b) \
+{ \
+    if (a != b) {\
+        HONLY_LOGW("❌ | %s == %s (%s == %s)", \
+            #a, #b, std::to_string(a).c_str(), std::to_string(b).c_str()); \
+    } else {\
+        HONLY_LOGI_P("✅ | %s == %s (%s == %s)", \
+            #a, #b, std::to_string(a).c_str(), std::to_string(b).c_str()); \
+    } \
+}
+
+#define D2X_WAIT HONLY_LOGW("🥳 Delete the D2X_WAIT to continue...");
+#define D2X_YOUR_ANSWER
+#define D2X_DONT_DELETE_THIS(x) x
+
+template<typename F, typename... Args>
+class d2x_is_invocable {
+private:
+    template<typename U>
+    static auto test(U* f) -> decltype((*f)(std::declval<Args>()...), std::true_type());
+
+    template<typename>
+    static std::false_type test(...);
+
+public:
+    static constexpr bool value = decltype(test<F>(nullptr))::value;
+};
+
+#endif
diff --git a/d2x/cpp/common.lua b/d2x/cpp/common.lua
@@ -0,0 +1,29 @@
+function get_local_lang()
+--local config = platform.get_config_info()
+    local local_lang = "en" -- Default language
+    -- TODO: config language by xlings.json
+    if is_host("linux") then
+        local tmp_local_lang = os.getenv("LANG") or "en"
+        if tmp_local_lang:find("zh") then
+            local_lang = "zh"
+        end
+    elseif is_host("windows") then
+        local tmp_local_lang = nil
+        if find_tool("wmic") then -- Windows 10 and earlier
+            -- wmic is deprecated in Windows 11, but still available
+            tmp_local_lang = os.iorun([[wmic os get locale]])
+        else -- win11+
+            tmp_local_lang = os.iorun([[powershell -NoProfile -ExecutionPolicy Bypass -Command "'{0:X4}' -f (Get-Culture).LCID"]])
+        end
+        if tmp_local_lang and tmp_local_lang:find("0804") then
+            local_lang = "zh"
+        end
+    elseif is_host("macosx") then
+        local tmp_local_lang = os.iorun([[defaults read -g AppleLocale]])
+        if tmp_local_lang and tmp_local_lang:find("zh") then
+            local_lang = "zh"
+        end
+    end
+
+    return local_lang
+end
diff --git a/d2x/cpp/honly_logger.hpp b/d2x/cpp/honly_logger.hpp
@@ -0,0 +1,18 @@
+#ifndef LOGGER_HPP__HONLY
+#define LOGGER_HPP__HONLY
+
+#include <cstdio>
+
+#ifndef HONLY_LOGGER_TAG
+#define HONLY_LOGGER_TAG "HONLY"
+#endif
+
+#define LOG_ENABLE true
+#define _HONLY_LOG(fd, ...) if (LOG_ENABLE) { fprintf (fd, __VA_ARGS__); fprintf (fd, "\033[0m\n"); fflush(stdout); }
+#define HONLY_LOGI_P(...) { fprintf (stdout, "\033[32m[%s LOGI]: - ", HONLY_LOGGER_TAG); _HONLY_LOG(stdout, __VA_ARGS__); }
+#define HONLY_LOGI(...) { fprintf (stdout, "\033[32m[%s LOGI]: %s: %s:%d - ", HONLY_LOGGER_TAG, __func__, __FILE__, __LINE__); _HONLY_LOG(stdout, __VA_ARGS__); }
+#define HONLY_LOGD(...) { fprintf (stdout, "\033[37m[%s LOGD]: %s: %s:%d - ", HONLY_LOGGER_TAG, __func__, __FILE__, __LINE__); _HONLY_LOG(stdout, __VA_ARGS__); }
+#define HONLY_LOGW(...) { fprintf (stdout, "\033[33m[%s LOGW]: %s: %s:%d - ", HONLY_LOGGER_TAG, __func__, __FILE__, __LINE__); _HONLY_LOG(stdout, __VA_ARGS__); }
+#define HONLY_LOGE(...) { fprintf (stdout, "\033[31m[%s LOGE]: %s: %s:%d - ❌ | ", HONLY_LOGGER_TAG, __func__, __FILE__, __LINE__); _HONLY_LOG(stdout, __VA_ARGS__); }
+
+#endif
diff --git a/d2x/mcpp/common.cppm b/d2x/mcpp/common.cppm
@@ -0,0 +1,5 @@
+module;
+
+#include <d2x/cpp/common.hpp>
+
+export module d2x.project.common;
diff --git a/dslings/hello-mcpp.cpp b/dslings/hello-mcpp.cpp
@@ -0,0 +1,72 @@
+// d2x: https://github.com/d2learn/d2x
+// license: Apache-2.0
+// file: dslings/hello-mcpp.cpp
+//
+// Exercise/练习: 自动化代码练习使用教学
+//
+// Tips/提示:
+//    该项目是使用xlings工具搭建的自动化代码练习项目, 通过在项目根目录下
+//    执行 xlings checker 进入"编译器驱动开发模式"的练习代码自动检测.
+//    你需要根据控制台的报错和提示信息, 修改代码中的错误. 当修复所有编译错误和
+//    运行时检查点后, 你可以删除或注释掉代码中的 D2X_WAIT 宏, 会自动进入下一个练习.
+//
+//      - D2X_WAIT: 该宏用于隔离不同练习, 你可以删除或注释掉该宏, 进入下一个练习.
+//      - d2x_assert_eq: 该宏用于运行时检查点, 你需要修复代码中的错误, 使得所有
+//      - D2X_YOUR_ANSWER: 该宏用于提示你需要修改的代码, 一般用于代码填空(即用正确的代码替换这个宏)
+//
+// Auto-Checker/自动检测命令:
+//
+//   d2x checker hello-mcpp
+//
+
+import std;
+
+import d2x.project.common;
+
+// 修改代码时可以观察到控制台"实时"的变化
+
+int main() {
+
+    std::cout << "hello, mcpp!" << std:endl; // 0.修复这个编译错误
+
+    int a = 1.1; // 1.修复这个运行时错误, 修改int为double, 通过检查
+
+    d2x_assert_eq(a, 1.1); // 2.运行时检查点, 需要修复代码通过所有检查点(不能直接删除检查点代码)
+
+    D2X_YOUR_ANSWER b = a; // 3.修复这个编译错误, 给b一个合适的类型
+
+    d2x_assert_eq(b, 1); // 4.运行时检查点2
+
+    D2X_WAIT // 5.删除或注释掉这个宏, 进入下一个练习(项目正式代码练习)
+
+    return 0;
+}
+
+//// --- 更多详细介绍 | | |
+//                  V V V
+/*
+
+# [[ 控制台输出解读 ]]
+
+🌏Progress: [>----------] 0/10 -->> 显示当前的练习进度
+
+[Target: 00-0-hello-mcpp] - normal -->> 当前的练习名
+
+❌ Error: Compilation/Running failed for dslings/hello-mcpp.cpp -->> 显示检测状态
+
+ The code exist some error!
+
+---------C-Output--------- - 编译器输出信息
+[HONLY LOGW]: main: dslings/hello-mcpp.cpp:24 - ❌ | a == 1.1 (1 == 1.100000) -->> 错误提示及位置(24行)
+[HONLY LOGW]: main: dslings/hello-mcpp.cpp:26 - 🥳 Delete the D2X_WAIT to continue...
+
+
+AI-Tips-Config: https://d2learn.org/docs/xlings -->> AI提示(需要配置大模型的key, 可不使用)
+
+---------E-Files---------
+dslings/hello-mcpp.cpp -->> 当前检测的文件
+-------------------------
+
+Homepage: https://github.com/d2learn/xlings
+
+*/
diff --git a/dslings/helloworld.cpp b/dslings/helloworld.cpp
diff --git a/dslings/xmake.lua b/dslings/xmake.lua
diff --git a/xmake.lua b/xmake.lua

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+Copyright (c) 2026-present d2learn, dev@d2learn.org`
	`2`	`+`
`1`	`3`	`Apache License`
`2`	`4`	`Version 2.0, January 2004`
`3`	`5`	`http://www.apache.org/licenses/`