summaryrefslogtreecommitdiffstats
path: root/python/mach/mach/commands/settings.py
blob: 8e168a3921ca9cf668c9a9e682d6ad96db5bb951 (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
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
# You can obtain one at http://mozilla.org/MPL/2.0/.

from textwrap import TextWrapper

from mach.config import TYPE_CLASSES
from mach.decorators import Command, CommandArgument


# Interact with settings for mach.

# Currently, we only provide functionality to view what settings are
# available. In the future, this module will be used to modify settings, help
# people create configs via a wizard, etc.


@Command("settings", category="devenv", description="Show available config settings.")
@CommandArgument(
    "-l",
    "--list",
    dest="short",
    action="store_true",
    help="Show settings in a concise list",
)
def run_settings(command_context, short=None):
    """List available settings."""
    types = {v: k for k, v in TYPE_CLASSES.items()}
    wrapper = TextWrapper(initial_indent="# ", subsequent_indent="# ")
    for i, section in enumerate(sorted(command_context._mach_context.settings)):
        if not short:
            print("%s[%s]" % ("" if i == 0 else "\n", section))

        for option in sorted(command_context._mach_context.settings[section]._settings):
            meta = command_context._mach_context.settings[section].get_meta(option)
            desc = meta["description"]

            if short:
                print("%s.%s -- %s" % (section, option, desc.splitlines()[0]))
                continue

            if option == "*":
                option = "<option>"

            if "choices" in meta:
                value = "{%s}" % ", ".join(meta["choices"])
            else:
                value = "<%s>" % types[meta["type_cls"]]

            print(wrapper.fill(desc))
            print(";%s=%s" % (option, value))