summaryrefslogtreecommitdiff
path: root/xmake/plugins/format/xmake.lua
blob: 964fa1d34a51b06d30d722d212ccf6c4a7ebdb56 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
--!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        format.lua
--

task("format")
    set_category("plugin")
    on_run("main")
    set_menu {
        usage = "xmake format [options] [arguments]",
        description = "Format the current project.",
        options = {
            {'s', "style",   "kv", nil, "Set the path of .clang-format file, a coding style",
                                        values = {"LLVM", "Google", "Chromium", "Mozilla", "WebKit"}},
            {nil, "create",  "k",  nil, "Create a .clang-format file from a coding style"},
            {'n', "dry-run", "k",  nil, "Do not make any changes, just show the files that would be formatted."},
            {'e', "error",   "k",  nil, "If set, changes formatting warnings to errors."},
            {'j', "jobs",    "kv", tostring(os.default_njob()),
                                        "Set the number of parallel format jobs."},
            {'a', "all",     "k",  nil, "Format all targets."},
            {'g', "group",   "kv", nil, "Format all targets of the given group. It supports path pattern matching.",
                                        "e.g.",
                                        "    xmake format -g test",
                                        "    xmake format -g test_*",
                                        "    xmake format --group=benchmark/*"},
            {'f', "files",   "kv", nil, "Build the given source files.",
                                        "e.g.",
                                        "    - xmake format --files=src/main.c",
                                        "    - xmake format --files='src/*.c' [target]",
                                        "    - xmake format --files='src/**.c|excluded_file.c'",
                                        "    - xmake format --files='src/main.c" .. path.envsep() .. "src/test.c'"},
            {},
            {nil, "targets", "vs", nil, "The target names. It will format all default targets if this parameter is not specified.",
                                        "e.g.",
                                        "    xmake format target1 target2 ...",
                                        values = function (complete, opt)
                                            return import("private.utils.complete_helper.targets")(complete, opt)
                                        end},
        }
    }