构建系统

文件格式¶

.构建系统 文件使用JSON. 以下是一个例子:

{
    "cmd": ["python", "-u", "$file"],
    "file_regex": "^[ ]*File "(...*?)", line ([0-9]*)",
    "selector": "source.python"
}

选项¶

cmd

Array containing the command to run and its desired arguments. If you don’t specify an absolute path, the external program will be searched in your PATH, one of your system’s environmental variables.

cmd

包括命令及其参数数组。如果不指定绝对路径，外部程序会在你系统的:const:PATH 环境变量中搜索。

On Windows, GUIs are supressed.

在Windows 系统中，*TBT*

file_regex

Optional. Regular expression (Perl-style) to capture error output of cmd. See the next section for details.

file_regex

可选。 Perl格式的正则表达式可以获取``cmd``的错误输出，详情参考下一节

line_regex

Optional. If file_regex doesn’t match on the current line, but line_regex exists, and it does match on the current line, then walk backwards through the buffer until a line matching file regex is found, and use these two matches to determine the file and line to go to.

line_regex

可选。当``file_regex``与该行不匹配，如果``line_regex``存在，并且确实与当前行匹配， 则遍历整个缓冲区，直到与``file regex``匹配的行出现，并用这两个匹配决定最终要跳转的文件 或行。

selector

Optional. Used when Tools | Build System | Automatic is set to true. Sublime Text uses this scope selector to find the appropriate build system for the active view.

selector

可选。在选定 Tools | Build System | Automatic 时使用。Sublime Text使用这个 选择器自动为活动试图选择构建系统。

working_dir

Optional. Directory to change the current directory to before running cmd. The original current directory is restored afterwards.

working_dir

可选。在运行``cmd``前会切换到该目录。运行结束后会切换到原来的目录。

encoding

Optional. Output encoding of cmd. Must be a valid python encoding. Defaults to UTF-8.

encoding

可选。输出``cmd``的编码。必须是合法的Python编码，缺省为``UTF-8``。

target

Optional. Sublime Text command to run. Defaults to exec (Packages/Default/exec.py). This command receives the configuration data specified in the .build-system file.

Used to override the default build system command. Note that if you choose to override the default command for build systems, you can add arbitrary variables in the .sublime-build file.

target

可选。运行的Sublime Text命令，缺省为``exec`` (Packages/Default/exec.py)。该命令从 *.build-system*中获取配置数据。

用来替代缺省的构建系统命令。注意，如果你希望替代构建系统的缺省命令，请在*.sublime-build* 文件中专门设置。

env

Optional. Dictionary of environment variables to be merged with the current process’ before passing them to cmd.

Use this element, for example, to add or modify environment variables without modifying your system’s settings.

env

可选。在环境变量被传递给``cmd``前，将他们封装成词典。

shell

Optional. If true, cmd will be run through the shell (cmd.exe, bash…).

shell

可选。如果该选项为``true`` ，``cmd``则可以通过shell运行。

path

Optional. This string will replace the current process’ PATH before calling cmd. The old PATH value will be restored after that.

Use this option to add directories to PATH without having to modify your system’s settings.

path

可选。该选项可以在调用``cmd``前替换当前进程的’ PATH 。原来的’ PATH 将在运行后恢复。

使用这个选项可以在不修改系统设置的前提下将目录添加到’ PATH 中。

variants

Optional. A list of dictionaries of options to override the main build system’s options. Variant ``name``s will appear in the Command Palette for easy access if the build system’s selector matches for the active file.

variants

可选。用来替代主构建系统的备选。如果构建系统的选择器与激活的文件匹配，变量的``名称``则 会出现在 Command Palette 中。

name

Only valid inside a variant (see variants). Identifies variant build systems. If name is Run, the variant will show up under the Tools | Build System menu and be bound to Ctrl + Shift + B.

name

仅在variant中是合法的 (详见 variants)。用来标识系统中不同的构建系统。如果 ``name``是*Run* ,则会显示在**Tools | Build System** 下，并且可以使用 *Ctrl + Shift + B*调用。

``windows``, ``osx`` 以及 ``linux``元素可以帮助你在构建系统中设定平台相关

{
    "selector": "source.python",
    "cmd": ["date"],

    "variants": [

        { "cmd": ["ls -l *.py"],
          "name": "List Python Files",
          "shell": true
        },

        { "cmd": ["wc", "$file"],
          "name": "Word Count (current file)"
        },

        { "cmd": ["python", "-u", "$file"],
          "name": "Run"
        }
    ]
}

构建系统变量¶

Build systems expand the following variables in .sublime-build files:

在*.sublime-build* 中包括如下构建系统变量。

${project_name:Default}

${file/.php/.txt/}

运行构建系统¶

Select the desired build system from Tools | Build System, and then select Tools | Build or press F7.

从**Tools | Build System**选择构建系统，然后选择**Tools | Build** ，再按``F7``。

构建系统常见问题¶

Build systems will look for executables in your PATH, unless you specify an absolute path to the executable. Therefore, your PATH variable must be correctly set.

如果你没有为构建系统指定一个可执行文件的绝对路径，构建系统怎么会在你的 PATH 中进行查找。 所以，你需要正确设置 PATH 。

On some operating systems, the value for PATH will vary from a terminal window to a graphical application. Thus, even if the command you are using in your build system works in the command line, it may not work from Sublime Text. This is due to user profiles in shells.

在某些操作系统中，终端和图形化应用的 PATH 值会有所不同。所以即便你的构建系统在命令行下 可以正常工作，在Sublime Text也不见得能够正常。这与Shell中的用户设置有关。

To solve this issue, make sure you set the desired PATH so that graphical applications such as Sublime Text can find it. See the links below for more information.

为了解决这个问题，请确认你正确设置了 PATH ，以便类似Sublime Text一类的图形化应用 可以正确找到。更多内容，请参考一下链接

Alternatively, you can use the path element in .sublime-build files to override the PATH used to locate the executable specified in cmd. This new value for PATH will only be in effect for as long as your build system is running. After that, the old PATH will be restored.

另外，你也可以在 .sublime-build 文件中设定 path 来替代:const:PATH ，并在 path 指定的路径中查找 cmd 可执行文件。新设定的值，仅在构建系统运行期间有效，过后将会恢复为原始的

PATH