本页内容
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
--frozen
Jump to heading
如果锁定文件过期,则报错。
--lock
Jump to heading
检查指定的锁文件。(如果未提供值,则默认为 "./deno.lock")。
--no-lock
Jump to heading
禁用锁定文件的自动发现。
--node-modules-dir
Jump to heading
设置 npm 包的 node 模块管理模式。
描述 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
命令可以通过传递通配符模式来并行运行多个任务。通配符模式由 *
字符指定。
{
"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
你可以为任务指定依赖项
{
"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 http://localhost:8000/
依赖任务并行执行,默认并行限制等于你机器上的核心数量。要更改此限制,请使用 DENO_JOBS
环境变量。
依赖项会被跟踪,如果多个任务依赖于同一个任务,该任务将只运行一次。
{
// 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
如果发现依赖之间存在循环,将返回错误。
{
"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
的任务。这对于将多个任务逻辑地组合在一起很有用。
{
"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
。
Node 和 npx 二进制支持 Jump to heading
默认情况下,deno task
会使用 deno
二进制文件执行命令。如果你需要确保命令使用 npm
或 npx
二进制文件运行,你可以分别调用 npm
或 npx
的 run
命令来实现。例如:
{
"tasks": {
"test:node": "npm run test"
}
}
工作区支持 Jump to heading
deno task
可用于工作区,以并行运行多个成员目录中的任务。要执行所有工作区成员的 dev
任务,请使用 --recursive
标志。
{
"workspace": [
"client",
"server"
]
}
{
"name": "@scope/client",
"tasks": {
"dev": "deno run -RN build.ts"
}
}
{
"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 http://localhost: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 来执行定义的任务,该 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 server.ts
和 deno run --allow-net client.ts
。
sleep 1 && deno run --allow-net server.ts & deno run --allow-net client.ts
与大多数 shell 不同,第一个失败的异步命令将导致所有其他命令立即失败。在上面的例子中,这意味着如果服务器命令失败,则客户端命令也将失败并退出。你可以通过在命令末尾添加 || true
来选择退出此行为,这将强制退出码为 0
。例如:
deno run --allow-net server.ts || true & deno run --allow-net client.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
管道提供了一种将一个命令的输出传递给另一个命令的方式。
以下命令将标准输出 "Hello" 通过管道传递给派生 Deno 进程的标准输入。
echo Hello | deno run main.ts
要同时传递标准输出和标准错误,请改用 |&
。
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
重定向提供了一种将标准输出和/或标准错误导入文件的方式。
例如,以下命令将 deno run main.ts
的标准输出重定向到文件系统上的 file.txt
文件。
deno run main.ts > file.txt
要重定向标准错误,请使用 2>
。
deno run main.ts 2> file.txt
要同时重定向标准输出和标准错误,请使用 &>
。
deno run main.ts &> file.txt
要将内容追加到文件而不是覆盖现有文件,请使用两个右尖括号而不是一个。
deno run main.ts >> file.txt
通过重定向到 /dev/null
,可以抑制命令的标准输出、标准错误或两者。这在包括 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
或者将标准输出重定向到标准错误,反之亦然。
# 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
开头的脚本。
例如
#!/usr/bin/env -S deno run
console.log("Hello there!");
{
"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
延迟 1 分钟。
- 例:
echo
- 显示一行文本。cat
- 连接文件并将其输出到标准输出。如果未提供参数,则读取并输出标准输入。exit
- 使 shell 退出。head
- 输出文件的开头部分。unset
- 取消设置环境变量。xargs
- 从标准输入构建参数并执行命令。
如果你发现命令缺少有用的标志,或对应该开箱即用支持的额外命令有任何建议,请在 deno_task_shell 仓库中 提出问题。
请注意,如果你希望在 Mac 或 Linux 上以非跨平台方式执行这些命令中的任何一个,可以通过 sh
运行它们:sh -c <command>
(例如,sh -c cp source destination
)。
package.json 支持 Jump to heading
如果发现 package.json 文件,deno task
会回退到读取其中的 "scripts"
条目。请注意,Deno 不尊重或支持任何 npm 生命周期事件,例如 preinstall
或 postinstall
——你必须明确运行你想要运行的脚本条目(例如,deno install --entrypoint main.ts && deno task postinstall
)。