跳转到主要内容
在本页

deno init，新建一个项目

命令行用法

deno init [OPTIONS] [dir]

搭建一个包含脚本、测试和配置文件的基本 Deno 项目


选项 跳转到标题

--lib 跳转到标题

生成一个示例库项目。

--serve 跳转到标题

生成一个用于 deno serve 的示例项目。

示例 跳转到标题

$ deno init
✅ Project initialized
Run these commands to get started

  // Run the program
  deno run main.ts

  // Run the program and watch for file changes
  deno task dev

  // Run the tests
  deno test

$ deno run main.ts
Add 2 + 3 = 5

$ deno test
Check file:///dev/main_test.ts
running 1 test from main_test.ts
addTest ... ok (6ms)

ok | 1 passed | 0 failed (29ms)

init 子命令会创建两个文件（main.ts 和 main_test.ts）。这些文件提供了一个关于如何编写 Deno 程序以及如何为其编写测试的基本示例。main.ts 文件导出一个将两个数字相加的 add 函数，而 main_test.ts 文件包含此函数的测试。

您也可以为 deno init 指定一个参数，以便在特定目录中初始化项目。

$ deno init my_deno_project
✅ Project initialized

Run these commands to get started

  cd my_deno_project

  // Run the program
  deno run main.ts

  // Run the program and watch for file changes
  deno task dev

  // Run the tests
  deno test

初始化 JSR 包跳转到标题

通过运行 deno init --lib，Deno 将引导一个准备在 JSR 上发布的项目。

$ deno init --lib
✅ Project initialized

Run these commands to get started

  # Run the tests
  deno test

  # Run the tests and watch for file changes
  deno task dev

  # Publish to JSR (dry run)
  deno publish --dry-run

在 deno.json 文件中，您将看到 name、exports 和 version 的条目已预先填写。

{
  "name": "my-lib",
  "version": "0.1.0",
  "exports": "./mod.ts",
  "tasks": {
    "dev": "deno test --watch mod.ts"
  },
  "imports": {
    "@std/assert": "jsr:@std/assert@1"
  }
}

初始化 Web 服务器跳转到标题

运行 deno init --serve 会引导一个可与 deno serve 配合使用的 Web 服务器。

$ deno init --serve
✅ Project initialized

Run these commands to get started

  # Run the server
  deno serve -R main.ts

  # Run the server and watch for file changes
  deno task dev

  # Run the tests
  deno -R test

您的 deno.json 文件将如下所示

{
  "tasks": {
    "dev": "deno serve --watch -R main.ts"
  },
  "imports": {
    "@std/assert": "jsr:@std/assert@1",
    "@std/http": "jsr:@std/http@1"
  }
}

现在，您可以通过运行 deno task dev 来启动您的 Web 服务器，该服务器会监视更改。

$ deno task dev
Task dev deno serve --watch -R main.ts
Watcher Process started.
deno serve: Listening on http://0.0.0.0:8000/

生成库项目跳转到标题

您可以附加 --lib 标志来向 deno.json 添加额外的参数，例如“name”、“version”和“exports”字段。

$ deno init my_deno_project --lib
✅ Project initialized

生成的 `deno.json 如下所示

{
  "name": "my_deno_project",
  "version": "0.1.0",
  "exports": "./mod.ts",
  "tasks": {
    "dev": "deno test --watch mod.ts"
  },
  "license": "MIT",
  "imports": {
    "@std/assert": "jsr:@std/assert@1"
  }
}