القائمة
Use when applying built-in rules (e.g. `mode.debug`, `mode.release`, `qt.widgetapp`, `c++.unity_build`) or writing a custom rule to handle a new file extension or codegen step.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Use when switching xmake's output theme (colors, progress style, emoji) or fixing garbled/unreadable terminal output — `xmake g --theme=...`. Built-in themes: default, ninja, emoji, dark, light, plain, powershell.
Use when the user is starting a new Xmake project, installing Xmake, or needs the minimal xmake.lua structure. Covers installation, `xmake create`, the project layout, and the smallest valid xmake.lua.
Use when writing or reviewing an `xmake.lua` (project, package recipe, or toolchain) and you want to follow idiomatic xmake style — description vs script domain separation, naming, indentation, `set_` vs `add_`, option/config organization, and common conventions used across xmake-repo and the xmake project itself. Apply this alongside `xmake-targets`/`xmake-packages`/etc. as a stylistic overlay.
Use when creating a new xmake project from a built-in or third-party template (`xmake create -t <template>`), listing available templates, or authoring and distributing custom templates (built-in, user-global, or via xmake-repo). Covers template layout, `${TARGET_NAME}` / `${FAQ}` substitution, and language selection.
Use when invoking Xmake from the command line — configuring, building, running, cleaning, installing, packing, or inspecting a project. Covers the common flags for `xmake f`, `xmake`, `xmake run`, `xmake install`, `xmake pack`, and friends.
Use when exporting an xmake project to another build system or IDE — `compile_commands.json` for clangd/LSP, `CMakeLists.txt`, `build.ninja`, Visual Studio solution (`vsxmake`), or an Xcode project. Covers `xmake project -k <kind>` and how each generator is typically used.
| name | xmake-rules |
| description | Use when applying built-in rules (e.g. `mode.debug`, `mode.release`, `qt.widgetapp`, `c++.unity_build`) or writing a custom rule to handle a new file extension or codegen step. |
Rules are reusable bundles of build logic. You apply them with add_rules(...) at project or target scope, or define your own with rule(...).
Build modes (at project scope):
add_rules("mode.debug", "mode.release", "mode.releasedbg", "mode.minsizerel")
This enables xmake f -m debug|release|... and sets the corresponding flags.
Target-level built-ins:
target("app")
add_rules("c++.unity_build", {batchsize = 8}) -- unity builds
add_rules("c.unity_build")
add_rules("win.sdk.application") -- Windows GUI entry
add_rules("qt.widgetapp") -- Qt widgets app
add_rules("xcode.application") -- iOS/macOS app bundle
add_rules("plugin.compile_commands.autoupdate", {outputdir = "."})
plugin.compile_commands.autoupdate automatically regenerates compile_commands.json on every build — great for clangd/LSP.
Use a rule to teach Xmake how to handle a new file extension.
rule("protobuf")
set_extensions(".proto")
on_load(function (target)
target:add("includedirs", "$(buildir)/proto")
end)
before_buildcmd_file(function (target, batchcmds, sourcefile, opt)
local outputdir = path.join(target:autogendir(), "proto")
local sourcefile_cx = path.join(outputdir, path.basename(sourcefile) .. ".pb.cc")
batchcmds:mkdir(outputdir)
batchcmds:vrunv("protoc", {"--cpp_out=" .. outputdir, sourcefile})
target:add("files", sourcefile_cx)
batchcmds:add_depfiles(sourcefile)
batchcmds:set_depmtime(os.mtime(sourcefile_cx))
batchcmds:set_depcache(target:dependfile(sourcefile_cx))
end)
rule_end()
target("app")
add_rules("protobuf")
add_files("proto/*.proto", "src/*.cpp")
on_load, on_config, before_build, on_build_file, on_buildcmd_file, before_link, after_build, on_clean, etc. Use the *cmd* variants when you want to emit commands into the batch runner (with dependency tracking); use plain hooks for arbitrary Lua logic.
add_rules("mode.debug", "mode.release") -- global: applies to all targets
target("app")
add_rules("c++.unity_build") -- only to this target
xmake-targetsxmake-toolchains