summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkaps316 <[email protected]>2026-04-11 11:43:14 +0530
committerruki <[email protected]>2026-04-20 09:35:36 +0800
commit8512dce671af24d2f293728bfdb9e65f81e5ed38 (patch)
tree2028395b1f6f1127ed15ad94ad0ecfafe4ffbed7
parent3a1b4e1719ba50b259afa27b450f06c39548003d (diff)
feat(show): export target dependency graph as JSON
Add a graph-oriented mode to `xmake show` for exporting target\ndependency relationships as JSON.\n\nThis adds `--target_graph` support for whole-project output and\noptional root-target filtering with `--target`.\n\nAdd a plugin test covering full-graph and single-target graph export.\n\nRefs #7475
-rw-r--r--tests/plugins/show/test.lua85
-rw-r--r--xmake/plugins/show/info/target_graph.lua120
-rw-r--r--xmake/plugins/show/main.lua2
-rw-r--r--xmake/plugins/show/xmake.lua2
4 files changed, 208 insertions, 1 deletions
diff --git a/tests/plugins/show/test.lua b/tests/plugins/show/test.lua
new file mode 100644
index 000000000..0c0f783e6
--- /dev/null
+++ b/tests/plugins/show/test.lua
@@ -0,0 +1,85 @@
+import("core.base.json")
+
+local function _prepare_xmake_env()
+ local xmake = path.absolute(os.programfile())
+ local xmake_program_dir = path.absolute(os.programdir())
+ os.setenv("XMAKE_PROGRAM_FILE", xmake)
+ os.setenv("XMAKE_PROGRAM_DIR", xmake_program_dir)
+ return xmake
+end
+
+local function _create_project(tempdir)
+ io.writefile(path.join(tempdir, "xmake.lua"), [[
+add_rules("mode.debug", "mode.release")
+
+target("core")
+ set_kind("static")
+ add_files("src/core.c")
+
+target("ui")
+ set_kind("static")
+ add_deps("core")
+ add_files("src/ui.c")
+
+target("app")
+ set_kind("binary")
+ add_deps("core", "ui")
+ add_files("src/main.c")
+]])
+ os.mkdir(path.join(tempdir, "src"))
+ io.writefile(path.join(tempdir, "src", "core.c"), "int core(void) { return 0; }\n")
+ io.writefile(path.join(tempdir, "src", "ui.c"), "int ui(void) { return 0; }\n")
+ io.writefile(path.join(tempdir, "src", "main.c"), "int main(void) { return 0; }\n")
+end
+
+function test_target_graph_json(t)
+ local tempdir = os.tmpfile()
+ os.mkdir(tempdir)
+ _create_project(tempdir)
+
+ local homedir = path.join(tempdir, "home")
+ os.setenv("HOME", homedir)
+ os.mkdir(homedir)
+ os.mkdir(path.join(homedir, ".xmake"))
+
+ local xmake = _prepare_xmake_env()
+ local outdata = os.iorunv(xmake, {"show", "-P", tempdir, "--target_graph", "--json"})
+ local graph = json.decode(outdata)
+
+ t:are_equal(graph.root_targets, {"app"})
+ t:require(#graph.targets == 3)
+
+ local entries = {}
+ for _, target in ipairs(graph.targets) do
+ entries[target.name] = target
+ end
+ t:are_equal(entries.core.deps, {})
+ t:are_equal(entries.ui.deps, {"core"})
+ t:are_equal(entries.app.deps, {"core", "ui"})
+ t:are_equal(entries.app.orderdeps, {"core", "ui"})
+ t:are_equal(entries.app.kind, "binary")
+end
+
+function test_target_graph_json_for_single_target(t)
+ local tempdir = os.tmpfile()
+ os.mkdir(tempdir)
+ _create_project(tempdir)
+
+ local homedir = path.join(tempdir, "home")
+ os.setenv("HOME", homedir)
+ os.mkdir(homedir)
+ os.mkdir(path.join(homedir, ".xmake"))
+
+ local xmake = _prepare_xmake_env()
+ local outdata = os.iorunv(xmake, {"show", "-P", tempdir, "--target_graph", "--target=app", "--json"})
+ local graph = json.decode(outdata)
+
+ t:are_equal(graph.root_targets, {"app"})
+ t:require(#graph.targets == 3)
+
+ local names = {}
+ for _, target in ipairs(graph.targets) do
+ table.insert(names, target.name)
+ end
+ t:are_equal(names, {"core", "ui", "app"})
+end
diff --git a/xmake/plugins/show/info/target_graph.lua b/xmake/plugins/show/info/target_graph.lua
new file mode 100644
index 000000000..30c977fc3
--- /dev/null
+++ b/xmake/plugins/show/info/target_graph.lua
@@ -0,0 +1,120 @@
+--!A cross-platform build utility based on Lua
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+-- http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+--
+-- Copyright (C) 2015-present, Xmake Open Source Community.
+--
+-- @author ruki
+-- @file target_graph.lua
+--
+
+-- imports
+import("core.base.option")
+import("core.base.json")
+import("core.project.config")
+import("core.project.project")
+import("private.detect.check_targetname")
+
+local function _collect_target_entry(target)
+ local deps = {}
+ for _, dep in pairs(target:deps() or {}) do
+ table.insert(deps, dep:name())
+ end
+ table.sort(deps)
+
+ local orderdeps = {}
+ for _, dep in ipairs(target:orderdeps() or {}) do
+ table.insert(orderdeps, dep:name())
+ end
+
+ return {
+ name = target:name(),
+ kind = target:kind(),
+ group = target:get("group"),
+ default = target:is_default(),
+ deps = deps,
+ orderdeps = orderdeps
+ }
+end
+
+local function _collect_target_graph(root_target)
+ local targets = {}
+ local selected = {}
+ if root_target then
+ selected[root_target:name()] = true
+ for _, dep in ipairs(root_target:orderdeps() or {}) do
+ selected[dep:name()] = true
+ end
+ end
+
+ for _, target in ipairs(project.ordertargets()) do
+ if not root_target or selected[target:name()] then
+ table.insert(targets, _collect_target_entry(target))
+ end
+ end
+
+ local roots = {}
+ if root_target then
+ table.insert(roots, root_target:name())
+ else
+ local indegrees = {}
+ for _, target in ipairs(targets) do
+ indegrees[target.name] = 0
+ end
+ for _, target in ipairs(targets) do
+ for _, depname in ipairs(target.deps) do
+ if indegrees[depname] ~= nil then
+ indegrees[depname] = indegrees[depname] + 1
+ end
+ end
+ end
+ for _, target in ipairs(targets) do
+ if indegrees[target.name] == 0 then
+ table.insert(roots, target.name)
+ end
+ end
+ end
+
+ return {
+ root_targets = roots,
+ targets = targets
+ }
+end
+
+local function _print_target_graph(graph)
+ print("The dependency graph of targets:")
+ for _, target in ipairs(graph.targets) do
+ local deps = #target.deps > 0 and table.concat(target.deps, ", ") or "(none)"
+ cprint(" ${color.dump.string}%s${clear}: %s", target.name, deps)
+ end
+end
+
+function main(name)
+ config.load()
+
+ local root_target
+ if name then
+ root_target = assert(check_targetname(name))
+ end
+
+ local graph = _collect_target_graph(root_target)
+ if option.get("json") then
+ local json_opt
+ if option.get("pretty") then
+ json_opt = {pretty = true, orderkeys = true}
+ end
+ print(json.encode(graph, json_opt))
+ else
+ _print_target_graph(graph)
+ end
+end
diff --git a/xmake/plugins/show/main.lua b/xmake/plugins/show/main.lua
index 9dc4f519a..2b337b13e 100644
--- a/xmake/plugins/show/main.lua
+++ b/xmake/plugins/show/main.lua
@@ -32,6 +32,8 @@ function main()
local listname = option.get("list")
if listname then
return _show_list(listname)
+ elseif option.get("target_graph") then
+ return assert(import("info.target_graph", {try = true, anonymous = true}))(option.get("target"))
else
-- show the information of the given object
for _, filepath in ipairs(os.files(path.join(os.scriptdir(), "info", "*.lua"))) do
diff --git a/xmake/plugins/show/xmake.lua b/xmake/plugins/show/xmake.lua
index 331aeb468..3e3709877 100644
--- a/xmake/plugins/show/xmake.lua
+++ b/xmake/plugins/show/xmake.lua
@@ -32,6 +32,7 @@ task("show")
{'g', "group", "kv", nil, "Filter targets by the given group name."},
{nil, "json", "k", false, "Show information with json format."},
{nil, "pretty", "k", false, "Enable pretty formatted json output."},
+ {nil, "target_graph", "k", false, "Show the dependency graph of targets."},
{'t', "target", "kv", nil, "Show the information of the given target.",
values = function (complete, opt)
return import("private.utils.complete_helper.targets")(complete, opt)
@@ -40,4 +41,3 @@ task("show")
}
-