deno.com
在本页中

deno task

命令行用法

deno task [OPTIONS] [TASK]

运行配置文件中定义的任务。

deno task build

列出所有可用的任务

deno task

从字符串评估任务

deno task --eval "echo $(pwd)"

选项 Jump to heading

--config Jump to heading

短标记: -c

配置 deno 的不同方面，包括 TypeScript、代码检查和代码格式化。通常配置文件将被称为 deno.json 或 deno.jsonc 并自动检测；在这种情况下，此标记不是必需的。

--cwd Jump to heading

指定在哪个目录中运行任务。

--eval Jump to heading

评估传递的值，就像它是一个配置文件中的任务一样。

--filter Jump to heading

短标记: -f

按名称过滤工作区成员 - 应与 --recursive 一起使用。

--recursive Jump to heading

短标记: -r

在工作区中的所有项目中运行任务。

依赖管理选项 Jump to heading

--node-modules-dir Jump to heading

设置 npm 包的 node modules 管理模式。

描述 Jump to heading

deno task 提供了一种跨平台的方式来定义和执行特定于代码库的自定义命令。

要开始使用，请在代码库的 Deno 配置文件 中的 "tasks" 键下定义你的命令。

例如

{
  "tasks": {
    "data": "deno task collect && deno task analyze",
    "collect": "deno run --allow-read=. --allow-write=. scripts/collect.js",
    "analyze": {
      "description": "Run analysis script",
      "command": "deno run --allow-read=. scripts/analyze.js"
    }
  }
}

指定当前工作目录 Jump to heading

默认情况下，deno task 使用 Deno 配置文件的目录（例如 deno.json）作为当前工作目录来执行命令。这允许任务使用相对路径，并继续工作，而无需考虑您在目录树中的哪个位置执行 deno task。在某些情况下，可能不希望这样做，并且可以使用 INIT_CWD 环境变量覆盖此行为。

如果尚未设置，INIT_CWD 将设置为任务运行所在目录的完整路径。这与 npm run 的行为一致。

例如，以下任务会将任务的当前工作目录更改为用户运行任务所在的目录，然后输出当前工作目录，现在是该目录（请记住，这在 Windows 上也有效，因为 deno task 是跨平台的）。

{
  "tasks": {
    "my_task": "cd $INIT_CWD && pwd"
  }
}

获取运行 deno task 的目录 Jump to heading

由于任务是使用 Deno 配置文件的目录作为当前工作目录运行的，因此了解 deno task 执行的目录可能很有用。这可以通过在从 deno task 启动的任务或脚本中使用 INIT_CWD 环境变量来实现（工作方式与 npm run 相同，但以跨平台的方式）。

例如，要将此目录提供给任务中的脚本，请执行以下操作（请注意，目录用双引号引起来，以使其在包含空格时保持为单个参数）

{
  "tasks": {
    "start": "deno run main.ts \"$INIT_CWD\""
  }
}

任务的通配符匹配 Jump to heading

deno task 命令可以通过传递通配符模式并行运行多个任务。通配符模式用 * 字符指定。

deno.json
{
  "tasks": {
    "build-client": "deno run -RW client/build.ts",
    "build-server": "deno run -RW server/build.ts"
  }
}

运行 deno task "build-*" 将运行 build-client 和 build-server 任务。

注意

当使用通配符时，请确保引用任务名称（例如 "build-*"），否则您的 shell 可能会尝试扩展通配符，从而导致意外的错误。

任务依赖 Jump to heading

你可以为任务指定依赖项

deno.json
{
  "tasks": {
    "build": "deno run -RW build.ts",
    "generate": "deno run -RW generate.ts",
    "serve": {
      "command": "deno run -RN server.ts",
      "dependencies": ["build", "generate"]
    }
  }
}

在上面的例子中，运行 deno task serve 将首先并行执行 build 和 generate 任务，一旦它们都成功完成，serve 任务将被执行

$ deno task serve
Task build deno run -RW build.ts
Task generate deno run -RW generate.ts
Generating data...
Starting the build...
Build finished
Data generated
Task serve deno run -RN server.ts
Listening on https://127.0.0.1:8000/

依赖任务并行执行，默认并行限制等于机器上的核心数。要更改此限制，请使用 DENO_JOBS 环境变量。

依赖项被跟踪，如果多个任务依赖于同一任务，则该任务只会运行一次

deno.json
{
  //   a
  //  / \
  // b   c
  //  \ /
  //   d
  "tasks": {
    "a": {
      "command": "deno run a.js",
      "dependencies": ["b", "c"]
    },
    "b": {
      "command": "deno run b.js",
      "dependencies": ["d"]
    },
    "c": {
      "command": "deno run c.js",
      "dependencies": ["d"]
    },
    "d": "deno run d.js"
  }
}

$ deno task a
Task d deno run d.js
Running d
Task c deno run c.js
Running c
Task b deno run b.js
Running b
Task a deno run a.js
Running a

如果发现依赖项之间存在循环，将返回错误

deno.json
{
  "tasks": {
    "a": {
      "command": "deno run a.js",
      "dependencies": ["b"]
    },
    "b": {
      "command": "deno run b.js",
      "dependencies": ["a"]
    }
  }
}

$ deno task a
Task cycle detected: a -> b -> a

你还可以指定一个具有 dependencies 但没有 command 的任务。这对于逻辑上将多个任务组合在一起很有用

deno.json
{
  "tasks": {
    "dev-client": "deno run --watch client/mod.ts",
    "dev-server": "deno run --watch sever/mod.ts",
    "dev": {
      "dependencies": ["dev-client", "dev-server"]
    }
  }
}

运行 deno task dev 将并行运行 dev-client 和 dev-server。

工作区支持 Jump to heading

deno task 可以在工作区中使用，以并行运行来自多个成员目录的任务。要从所有工作区成员执行 dev 任务，请使用 --recursive 标志

deno.json
{
  "workspace": [
    "client",
    "server"
  ]
}
client/deno.json
{
  "name": "@scope/client",
  "tasks": {
    "dev": "deno run -RN build.ts"
  }
}
server/deno.json
{
  "name": "@scope/server",
  "tasks": {
    "dev": "deno run -RN server.ts"
  }
}

$ deno task --recursive dev
Task dev deno run -RN build.ts
Task dev deno run -RN server.ts
Bundling project...
Listening on https://127.0.0.1:8000/
Project bundled

要运行的任务可以根据工作区成员进行过滤

$ deno task --filter "client" dev
Task dev deno run -RN build.ts
Bundling project...
Project bundled

请注意，过滤器与每个成员的 deno.json 文件的 name 字段中指定的工作区成员名称匹配。

语法 Jump to heading

deno task 使用跨平台 shell，它是 sh/bash 的子集，用于执行定义的任务。

布尔列表 Jump to heading

布尔列表提供了一种基于初始命令的退出代码执行附加命令的方法。它们使用 && 和 || 运算符分隔命令。

&& 运算符提供了一种执行命令的方法，如果它*成功*（退出代码为 0），它将执行下一个命令

deno run --allow-read=. --allow-write=. collect.ts && deno run --allow-read=. analyze.ts

|| 运算符则相反。它提供了一种执行命令的方法，只有当它*失败*（退出代码为非零）时，它才会执行下一个命令

deno run --allow-read=. --allow-write=. collect.ts || deno run play_sad_music.ts

顺序列表 Jump to heading

顺序列表与布尔列表类似，但无论列表中之前的命令通过还是失败，都会执行。命令用分号 (;) 分隔。

deno run output_data.ts ; deno run --allow-net server.ts

异步命令 Jump to heading

异步命令提供了一种使命令异步执行的方法。这在启动多个进程时可能很有用。要使命令异步，请在其末尾添加一个 &。例如，以下命令将同时执行 sleep 1 && deno run --allow-net client.ts 和 deno run --allow-net server.ts

sleep 1 && deno run --allow-net client.ts & deno run --allow-net server.ts

与大多数 shell 不同，第一个失败的异步命令将导致所有其他命令立即失败。在上面的例子中，这意味着如果 client 命令失败，则 server 命令也将失败并退出。您可以通过在命令末尾添加 || true 来选择退出此行为，这将强制退出代码为 0。例如

deno run --allow-net client.ts || true & deno run --allow-net server.ts || true

环境变量 Jump to heading

环境变量的定义方式如下

export VAR_NAME=value

这是一个在任务中使用环境变量的例子，使用了 shell 变量替换，然后将其导出为派生的 Deno 进程环境的一部分（请注意，在 JSON 配置文件中，双引号需要用反斜杠转义）

export VAR=hello && echo $VAR && deno eval "console.log('Deno: ' + Deno.env.get('VAR'))"

将输出

hello
Deno: hello

为命令设置环境变量 Jump to heading

要在命令之前指定环境变量，请像这样列出它们

VAR=hello VAR2=bye deno run main.ts

这将专门为以下命令使用这些环境变量。

Shell 变量 Jump to heading

Shell 变量与环境变量类似，但不会导出到派生的命令。它们的定义语法如下

VAR_NAME=value

如果我们在一个类似的例子中使用 shell 变量而不是环境变量，就像前面 "环境变量" 部分中显示的那样

VAR=hello && echo $VAR && deno eval "console.log('Deno: ' + Deno.env.get('VAR'))"

我们将得到以下输出

hello
Deno: undefined

当我们想要重用一个值，但不希望它在任何派生的进程中可用时，Shell 变量会很有用。

退出状态变量 Jump to heading

先前运行的命令的退出代码在 $? 变量中可用。

# outputs 10
deno eval 'Deno.exit(10)' || echo $?

管道 Jump to heading

管道提供了一种将一个命令的输出管道传输到另一个命令的方法。

以下命令将 stdout 输出 "Hello" 管道传输到派生的 Deno 进程的 stdin

echo Hello | deno run main.ts

要管道传输 stdout 和 stderr，请改用 |&

deno eval 'console.log(1); console.error(2);' |& deno run main.ts

命令替换 Jump to heading

$(command) 语法提供了一种在其他要执行的命令中使用命令输出的方法。

例如，要将获取最新 git 修订版本的输出提供给另一个命令，您可以执行以下操作

deno run main.ts $(git rev-parse HEAD)

另一个使用 shell 变量的例子

REV=$(git rev-parse HEAD) && deno run main.ts $REV && echo $REV

取反退出码 Jump to heading

要取反退出代码，请在命令前添加一个感叹号和空格

# change the exit code from 1 to 0
! deno eval 'Deno.exit(1);'

重定向 Jump to heading

重定向提供了一种将 stdout 和/或 stderr 管道传输到文件的方法。

例如，以下命令将 deno run main.ts 的 *stdout* 重定向到文件系统上名为 file.txt 的文件

deno run main.ts > file.txt

要改为重定向 *stderr*，请使用 2>

deno run main.ts 2> file.txt

要重定向 stdout *和* stderr，请使用 &>

deno run main.ts &> file.txt

要追加到文件，而不是覆盖现有文件，请使用两个右尖括号而不是一个

deno run main.ts >> file.txt

通过重定向到 /dev/null，可以抑制命令的 stdout、stderr 或两者。这以跨平台方式工作，包括在 Windows 上。

# suppress stdout
deno run main.ts > /dev/null
# suppress stderr
deno run main.ts 2> /dev/null
# suppress both stdout and stderr
deno run main.ts &> /dev/null

或将 stdout 重定向到 stderr，反之亦然

# redirect stdout to stderr
deno run main.ts >&2
# redirect stderr to stdout
deno run main.ts 2>&1

也支持输入重定向

# redirect file.txt to the stdin of gzip
gzip < file.txt

请注意，目前不支持重定向多个重定向。

跨平台 Shebang Jump to heading

从 Deno 1.42 开始，deno task 将在所有平台上以相同的方式执行以 #!/usr/bin/env -S 开头的脚本。

例如

script.ts
#!/usr/bin/env -S deno run
console.log("Hello there!");
deno.json
{
  "tasks": {
    "hi": "./script.ts"
  }
}

然后在 Windows 机器上

> pwd
C:\Users\david\dev\my_project
> deno task hi
Hello there!

Glob 扩展 Jump to heading

Deno 1.34 及更高版本支持 Glob 扩展。这允许以跨平台方式指定 glob 来匹配文件。

# match .ts files in the current and descendant directories
echo **/*.ts
# match .ts files in the current directory
echo *.ts
# match files that start with "data", have a single number, then end with .csv
echo data[0-9].csv

支持的 glob 字符为 *、? 和 [/]。

内置命令 Jump to heading

deno task 附带了几个内置命令，这些命令在 Windows、Mac 和 Linux 上开箱即用。

  • cp - 复制文件。
  • mv - 移动文件。
  • rm - 删除文件或目录。
    • 例如: rm -rf [FILE]... - 常用于递归删除文件或目录。
  • mkdir - 创建目录。
    • 例如. mkdir -p DIRECTORY... - 常用于创建目录及其所有父目录，如果目录已存在则不报错。
  • pwd - 打印当前/工作目录的名称。
  • sleep - 延迟指定的时间量。
    • 例如. sleep 1 睡眠 1 秒，sleep 0.5 睡眠半秒，或 sleep 1m 睡眠一分钟
  • echo - 显示一行文本。
  • cat - 连接文件并在 stdout 上输出它们。当没有提供参数时，它读取并输出 stdin。
  • exit - 导致 shell 退出。
  • head - 输出文件的第一部分。
  • unset - 取消设置环境变量。
  • xargs - 从 stdin 构建参数并执行命令。

如果您发现某个命令缺少有用的标志，或者对应该开箱即用的其他命令有任何建议，请在 deno_task_shell 仓库上打开一个 issue。

请注意，如果您希望在 Mac 或 Linux 上以非跨平台方式执行这些命令中的任何一个，则可以通过 sh 运行它：sh -c <command> (例如 sh -c cp source destination)。

package.json 支持 Jump to heading

如果发现 package.json 文件，deno task 会回退到从 package.json 文件中的 "scripts" 条目读取。请注意，Deno 不尊重或支持任何 npm 生命周期事件，如 preinstall 或 postinstall—您必须显式运行要运行的脚本条目（例如 deno install --entrypoint main.ts && deno task postinstall）。

您找到您需要的信息了吗？

编辑此页面
隐私政策