参见

• get_env
• shell展开
• dotenv
• env和vars继承

dotenv

dotenv属性用于定义文件中所有任务可用的环境变量。该属性的值是一个字符串，或包含包含环境变量的文件路径的字符串列表。路径可以是绝对路径，也可以是相对于文件位置的相对路径。

env属性中定义的值优先于使用dotenv属性定义的值。

vars

vars属性用于定义文件中所有任务可用的变量。这与env属性的行为类似，但变量不会被导出到环境变量中，并且可以比字符串更复杂。

例如，您可以定义一个变量如下

vars:
  user:
    age: 20
    name: John

然后像这样在任务中使用它

tasks:
  say_hi:
    cmd: echo "Hi, {{ vars.user.name }}!"

incl

incl属性用于定义文件中所有任务可用的Tera包括/模板。该属性的值是键值对映射，其中键是模板的名称，值是模板本身。然后可以在任务中使用具有名称incl.<name>的模板。

模板可以包含其他模板，但它们的定义顺序很重要。

例如，您可以定义一个模板如下

incl:
  say_hi: "Hi from {{ TASK.name }}!"
  say_bye: "Bye from {% include "incl.say_hi" %}!"

但是以下将不会工作

incl:
  say_bye: "Bye from {% include "incl.say_hi" %}!"
  say_hi: "Hi from {{ TASK.name }}!"

模板也可以在任务中定义，并且它们将优先于文件中定义的模板。

模板也可以用来定义宏。请参阅Tera的包含文档。

任务文件属性

除了通用属性外，任务文件中还可以定义以下属性

• 任务：文件中定义的任务。
• version：文件的较大版本。虽然目前没有使用，但它对于未来的兼容性是必需的。版本可以是数字或字符串。在撰写本文时，版本应该是1。
• extend：继承自的mom文件。

tasks

使用tasks属性来定义文件中的任务。属性的值是键值对映射，其中键是任务的名称，值是任务定义。

任务名称必须以ASCII字母字符或下划线开头，后跟任意数量的字母、数字、-或_。名称也可以以.windows、.linux或.macos结尾，以定义一个操作系统特定的任务。您可以按照惯例，使用前导下划线命名私有任务，例如_private_task。

文件扩展

在文件中，使用extend属性来定义要继承的mom文件。它可能是一个相对于文件位置的路径或路径列表，或是一个绝对路径。例如

version: 1

# Extend from a file in the same directory
extend: mom.base.yml

# Extend from a file in a subdirectory
extend: base/mom.base.yml

# Extend from multiple files
extend:
  - mom.base.yml
  - base/mom.base.yml

继承的值是

• wd

合并的值（文件值优先）是

• env
• vars
• incl
• tasks

dotenv在从文件继承或合并到父文件之前加载并与同一文件中的env合并。这意味着它被视为env的一部分。

任务属性

除了通用属性外，任务还可以具有以下属性

• help：帮助消息。
• script：要执行的脚本。
• script_runner：用于解析脚本程序和参数的模板。
• script_extension：脚本文件的扩展名。
• script_ext：script_extension的别名。
• cmds：要执行的命令。
• program：要执行的程序。
• args：传递给程序的参数。
• args_extend：传递给程序的参数，如果存在基本任务，则追加到这些参数。
• args+：args_extend的别名。
• linux：在linux中执行的任务版本。
• windows：在windows中执行的任务版本。
• mac：在mac中执行的任务版本。
• private：任务是否为私有。
• 继承: 要继承的任务。

help

help 属性用于定义任务的帮助信息。属性的值是一个包含帮助信息的字符串。

与注释不同，当运行 mom -i <TASK> 时，会打印帮助信息。

condition

condition 属性用于定义执行任务的条件。属性的值是一个包含 Tera 模板的字符串。如果模板计算结果为 true，则执行任务，否则跳过。

只有 true（不区分大小写）值被视为真，所有其他值被视为假。这是因为 Tera 条件将返回 true 或 false。

示例

tasks:
  say_hi:
    condition: "{{ env.ENVIRONMENT == 'production' }}"  # will evaluate to true if ENVIRONMENT is production, false otherwise
    script: echo "Hi!"

这也可以根据某些条件选择不同的任务，例如。

tasks:
  greet:
    cmds:
      - task:
          condition: "{{ env.ENVIRONMENT == 'production' }}"
          script: echo "Hi!"
      - task:
          condition: "{{ env.ENVIRONMENT != 'production' }}"
          script: echo "Bye!"

脚本

⚠️警告：不要在脚本中将敏感信息作为参数传递。脚本存储在系统的临时目录中的文件中，由操作系统负责删除，但无法保证何时以及是否删除。因此，任何传递的敏感参数都可能无限期地保留。

任务内的 script 值将在命令行中执行（在 Windows 上默认为 cmd，在 Unix 上默认为 bash）。脚本可以包含多行，并包含 shell 内置程序和程序。

生成的脚本存储在临时目录中，文件名将是哈希值，这样如果脚本以前曾使用相同的参数调用，我们可以重用以前的文件，本质上作为缓存。

script_runner

script_runner 属性用于定义解析脚本程序和参数的模板。必须包含一个程序和一个 {{ script_path }} 模板，例如 python {{ script_path }}。参数的分离方式与 args 相同。此参数支持展开环境变量，如 `$A

script_extension

script_extension 属性用于定义脚本文件的扩展名。例如，对于 Python 脚本，可以是 py 或 .py。

程序

任务内的 program 值将以单独的进程执行，如果传递了 args，则将传递这些参数。

参数

任务内的 args 值将作为参数传递给程序，如果有的话。值是一个包含空格分隔的参数的字符串。包含空格的值可以用引号引起来作为单个参数处理，例如 "hello world"。引号可以用反斜杠转义，例如 \"。

参数扩展

args_extend 的值将追加到 args（之间有空格），如果有的话。值与 args 的形式相同。

命令

cmds的值是一个要执行的命令列表。每个命令可以是字符串，或者包含一个task键的映射。

如果命令是字符串，它将以程序的方式执行，第一个值是程序，其余的是参数。参数的分隔方式与args相同。为了方便，echo是mom中的一个内置命令，因此相同的命令可以在Windows和Unix中正常工作。

如果命令是映射，task的值可以是要执行的任务的名称，或者要执行的任务的定义。

示例

tasks:
  say_hi:
    script: echo "hi"

  say_bye:
    cmds:
      - echo "bye"
  
  greet:
    cmds:
      - python -c "print('hello')"
      - task: say_hi
      - task:
          extend: say_bye

私有

private的值是一个布尔值，表示任务是否为私有。私有任务不能直接执行，但可以从其他任务继承。

任务扩展

在任务中，extend属性用于定义要继承的任务。它可能是一个字符串或字符串列表。例如

tasks:
  base_task:
    program: echo
    args: "Hello, world!"
  task:
    extend: base_task

  other_task:
    extend:
      - base_task
      - task

任务会合并，父任务优先于基础任务。

继承的值是

• wd
• help
• condition
• script
• script_runner
• script_extension
• script_ext（script_extension的别名）
• program
• args
• cmds

合并的值（父值优先）包括

• env
• vars
• incl

就像在文件中一样，在从任务扩展或合并到父任务之前，dotenv被加载并与同一任务中的env合并。这意味着它被视为任务中env的一部分。

没有继承的值是

• args_extend（追加到继承的args）
• [args+][#args_extend]（args_extend的别名）
• private
• windows
• linux
• macos

特定于操作系统的任务

可以为每个任务设置不同的OS版本。如果没有找到当前OS的任务，如果存在非OS特定的任务，它将回退到该任务。即

tasks:
  ls:
    script: "ls {{ args.0 }}"

  ls.windows:
    script: "dir {{ args.0 }}"

可以在单个键中指定OS特定的任务，即以下示例与上面的示例等效。

tasks:
  ls: 
    script: "ls {{ args.0 }}"

  ls.windows:
    script: "dir {{ args.0 }}"

请注意，OS特定的任务不会隐式地从非OS特定的任务继承，如果您想这样做，您必须显式地定义extend，即

tasks:
  ls:
    env:
      DIR: "."
    script: "ls {{ env.DIR }}"

  ls.windows:
    extend: ls
    script: "dir {{ env.DIR }}"

传递参数

任务参数可以是键值对传递，例如--name "John Doe"，或者作为位置参数传递，例如"John Doe"。

命名参数必须以一个或两个连字符开头，后跟一个ASCII字母或下划线，后跟任意数量的字母、数字、-或_。值将是下一个参数或等于号后面的值，即--name "John Doe"，--name-person1="John Doe"，-name_person1 John都是有效的。请注意，"--name John"不是命名参数，因为它被引号包围且包含空格，然而"--name=John"是一个有效的命名参数。

version: 1

# Default values. The tasks can override these values.
env:
  ENV1: "env1"
  ENV2: "env2"

vars:
  VAR1: "var1"
  VAR2: "var2"

tasks:
  test1:
    env:
      ENV2: "test1_env2"
      ENV3: "test1_env3"
    vars:
      VAR2: "test1_var2"
      VAR3: "test1_var3"
    cmds:
      - echo "{{ env.ENV1 }} {{ env.ENV2 }} {{ env.ENV3 }}"
      - echo "{{ vars.VAR1 }} {{ vars.VAR2 }} {{ vars.VAR3 }}"
      
      # env and vars from the parent will take precedence
      - task: test2
      
      # This subtask will inherit the env and vars from the parent
      # but its own bases, envs and vars will take precedence
      - task:
          # Bases will take precedence over the parent task
          extend: test2

          # env and vars take precedence over the parent task and the bases
          env:
            ENV2: "subtask_env2"
          vars:
            VAR2: "subtask_var2"
  
  test2:
    env:
      ENV2: "test2_env2"
      ENV3: "test2_env3"
    vars:
      VAR2: "test2_var2"
      VAR3: "test2_var3"
    cmds:
      - echo "{{ env.VAR1 }} {{ env.VAR2 }} {{ env.VAR3 }}"
      - echo "{{ vars.VAR1 }} {{ vars.VAR2 }} {{ vars.VAR3 }}"

$ mom test1
env1 test1_env2 test1_env3
var1 test1_var2 test1_var3
env1 test1_env2 test1_env3
var1 test1_var2 test1_var3
env1 subtask_env2 test2_env3
var1 subtask_var2 test2_var3

env1 test1_env2 test1_env3
var1 test1_var2 test1_var3

env1 test1_env2 test1_env3
var1 test1_var2 test1_var3

env1 subtask_env2 test2_env3
var1 subtask_var2 test2_var3

tasks:
  test:
    vars:
      var1: "value1"
      var2: "value2"
      var3: "value3"
    script: echo "{{ env | exclude(val='var2') | json_encode() }} {{ [1, 2, 3] | exclude(val=2) }}"

$ mom test
{"var1": "value1", "var3": "value3"} [1, 3]

tasks:
  test:
    script: echo "{{ input(label='What is your name?', default='John Doe') }}"

$ mom test
What is your name? [John Doe]: 

tasks:
  test:
    script: echo "{{ input(label='What is your name?', default='John Doe', if=args is containing("--default")) }}"

$ mom test --default
John Doe

tasks:
  test:
    script: echo "{{ get_env(name='VAR1', default='default') }}"

$ mom test
default

$ VAR1="value1"
$ mom test
value1