Merge pull request #6142 from Shiffted/invalid-target-errors

Improve targetname input checks

3 files changed, 129 insertions, 1 deletions

diff --git a/xmake/modules/cli/amalgamate.lua b/xmake/modules/cli/amalgamate.lua
index b1ec3bf7c..8c7ec6fd7 100644
--- a/xmake/modules/cli/amalgamate.lua
+++ b/xmake/modules/cli/amalgamate.lua
@@ -24,6 +24,7 @@ import("core.base.graph")
 import("core.project.config")
 import("core.project.task")
 import("core.project.project")
+import("private.detect.check_targetname")
 
 -- the options
 local options =
@@ -159,7 +160,7 @@ function main(...)
     -- generate amalgamate code
     args.outputdir = args.outputdir or config.buildir()
     if args.target then
-        local target = assert(project.target(args.target), "target(%s): not found!", args.target)
+        local target = assert(check_targetname(args.target))
         _generate_amalgamate_code(target, args)
     else
         for _, target in ipairs(project.ordertargets()) do
diff --git a/xmake/modules/private/detect/check_targetname.lua b/xmake/modules/private/detect/check_targetname.lua
new file mode 100644
index 000000000..8beabe2b7
--- /dev/null
+++ b/xmake/modules/private/detect/check_targetname.lua
@@ -0,0 +1,56 @@
+--!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, TBOOX Open Source Group.
+--
+-- @author      Shiffted
+-- @file        check_targetname.lua
+--
+
+-- imports
+import("core.project.project")
+import("private.detect.find_similar_targetnames")
+
+-- check if a target name is valid
+--
+-- @param targetname the target name to check for
+-- @param opt        the argument options, e.g. {find_similar = false, max_similar = 5}
+-- @return           target or nil, errors
+--
+-- @code
+--
+-- local target, errors = check_targetname("mytarget")
+-- local target, errors = check_targetname("mytarget", {find_similar = false})
+--
+-- @endcode
+--
+function main(targetname, opt)
+    opt = opt or {}
+
+    local target = project.target(targetname)
+    if target then
+        return target
+    end
+
+    local errors = "'" .. targetname .. "' is not a valid target name for this project."
+    if opt.find_similar ~= false then
+        local matching_targetnames = find_similar_targetnames(targetname)
+        if #matching_targetnames > 0 then
+            local max_index = math.min(#matching_targetnames, opt.max_similar or 14)
+            errors = errors .. "\nValid target names closest to input:\n - "
+                    .. table.concat(matching_targetnames, '\n - ', 1, max_index)
+        end
+    end
+    return nil, errors
+end
diff --git a/xmake/modules/private/detect/find_similar_targetnames.lua b/xmake/modules/private/detect/find_similar_targetnames.lua
new file mode 100644
index 000000000..3ef023254
--- /dev/null
+++ b/xmake/modules/private/detect/find_similar_targetnames.lua
@@ -0,0 +1,71 @@
+--!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, TBOOX Open Source Group.
+--
+-- @author      Shiffted
+-- @file        find_similar_targetnames.lua
+--
+
+-- imports
+import("core.project.project")
+
+-- find targets with a similar name
+--
+-- @param targetname the target name to check against
+-- @return           table of matching target names
+--
+-- @code
+--
+-- local tool = find_similar_targetnames("mytarget")
+--
+-- @endcode
+--
+function main(targetname)
+    local targetname_lower = targetname:lower()
+    local matching_targetnames = {}
+    local matching_levenshtein = {}
+
+    for _, target in ipairs(project.ordertargets()) do
+        local name = target:name()
+        if name:lower():find(targetname_lower, 1, true) then
+            table.insert(matching_targetnames, name)
+        else
+            local distance = targetname:levenshtein(name, {sub = 2})
+            if distance < 5 then
+                matching_levenshtein[name] = distance
+            end
+        end
+    end
+
+    table.sort(matching_targetnames, function(a, b)
+        if #a == #b then
+            return a < b
+        end
+        return #a < #b
+    end)
+
+    local levenshtein_keys = table.keys(matching_levenshtein)
+    table.sort(levenshtein_keys, function(a, b)
+        local a_distance = matching_levenshtein[a]
+        local b_distance = matching_levenshtein[b]
+        if a_distance == b_distance then
+            return a < b
+        end
+        return a_distance < b_distance
+    end)
+
+    table.join2(matching_targetnames, levenshtein_keys)
+    return matching_targetnames
+end