风格指南

这是对 Taskfile.yml 文件的官方风格指南。包含了一些基本的介绍来帮助 Taskfile 更简洁易懂。

本文包含的风格指南是建议性质，不用强制遵循。如果有目标或想法，可以随意提出不同观点。当然，也可以提交 pull request 帮助完善风格指南。

用 `Taskfile.yml` 不用 `taskfile.yml`

# bad
taskfile.yml


# good
Taskfile.yml

这点很重要，尤其是对 Linux 用户。Windows 和 macOS 对大小写不敏感，所以叫 taskfile.yml 也可以正常使用，虽然官方使用的不是这个名字。但在 Linux 中，只有 Taskfile.yml 才能正常使用。

关键字顺序

version:
includes:
可选配置命令，比如 output:, silent:, method: and run:
vars:
env:, dotenv:
tasks:

2 个空格缩进

这是最常用的 YAML 风格，Task 也这样建议。

# bad
tasks:
    foo:
        cmds:
            - echo 'foo'


# good
tasks:
  foo:
    cmds:
      - echo 'foo'

用空行分隔模块

# bad
version: '3'
includes:
  docker: ./docker/Taskfile.yml
output: prefixed
vars:
  FOO: bar
env:
  BAR: baz
tasks:
  # ...


# good
version: '3'

includes:
  docker: ./docker/Taskfile.yml

output: prefixed

vars:
  FOO: bar

env:
  BAR: baz

tasks:
  # ...

用空行分隔 task

# bad
version: '3'

tasks:
  foo:
    cmds:
      - echo 'foo'
  bar:
    cmds:
      - echo 'bar'
  baz:
    cmds:
      - echo 'baz'


# good
version: '3'

tasks:
  foo:
    cmds:
      - echo 'foo'

  bar:
    cmds:
      - echo 'bar'

  baz:
    cmds:
      - echo 'baz'

用大写字母命名变量

# bad
version: '3'

vars:
  binary_name: myapp

tasks:
  build:
    cmds:
      - go build -o {{.binary_name}} .


# good
version: '3'

vars:
  BINARY_NAME: myapp

tasks:
  build:
    cmds:
      - go build -o {{.BINARY_NAME}} .

变量模板内不加空格

# bad
version: '3'

tasks:
  greet:
    cmds:
      - echo '{{ .MESSAGE }}'


# good
version: '3'

tasks:
  greet:
    cmds:
      - echo '{{.MESSAGE}}'

这种习惯是大多数人在 Go 模板中遵守的。

用横线分隔任务名字中的单词

# bad
version: '3'

tasks:
  do_something_fancy:
    cmds:
      - echo 'Do something'


# good
version: '3'

tasks:
  do-something-fancy:
    cmds:
      - echo 'Do something'

用冒号表示 task 命名空间

# good
version: "3"

tasks:
  docker:build:
    cmds:
      - docker ...

  docker:run:
    cmds:
      - docker-compose ...

引用其它 Taskfile 时，会按这种规则自动添加命名空间。