deno.json and package.json

您可以使用 deno.json 文件来配置 Deno。该文件可用于配置 TypeScript 编译器、代码检查器、格式化工具以及其他 Deno 工具。

该配置文件支持 .json 和 .jsonc 扩展名。

如果在当前工作目录或父目录中检测到 deno.json 或 deno.jsonc 配置文件，Deno 将自动识别。可以使用 --config 标志指定不同的配置文件。

package.json 支持 Jump to heading#

Deno 还支持 package.json 文件，以兼容 Node.js 项目。如果您有一个 Node.js 项目，则不必创建 deno.json 文件。Deno 将使用 package.json 文件来配置项目。

如果在同一目录中同时存在 deno.json 和 package.json 文件，Deno 将理解两个文件中指定的依赖项；并使用 deno.json 文件进行 Deno 特定配置。有关更多信息，请阅读 Deno 中的 Node 兼容性。

依赖项 Jump to heading#

在您的 deno.json 文件中，"imports" 字段允许您指定项目中使用的依赖项。您可以使用它将简单的指定符映射到 URL 或文件路径，从而更轻松地管理依赖关系和模块解析。

例如，如果您想在项目中使用标准库中的 assert 模块，可以使用以下导入映射：

{
  "imports": {
    "@std/assert": "jsr:@std/assert@^1.0.0",
    "chalk": "npm:chalk@5"
  }
}

然后，您的脚本可以使用简单的指定符 std/assert：

import { assertEquals } from "@std/assert";
import chalk from "chalk";

assertEquals(1, 2);
console.log(chalk.yellow("Hello world"));

您还可以在 package.json 中使用 "dependencies" 字段：

{
  "dependencies": {
    "express": "express@^1.0.0"
  }
}

import express from "express";

const app = express();

请注意，这将要求您运行 deno install。

有关更多信息，请阅读 模块导入和依赖项。

自定义路径映射 Jump to heading#

deno.json 中的导入映射可用于更一般的指定符路径映射。您可以将确切的指定符映射到第三方模块或文件，或将导入指定符的一部分映射到一个目录。

{
  "imports": {
    // 映射到一个确切的文件
    "foo": "./some/long/path/foo.ts",
    // 映射到一个目录，使用方法: "bar/file.ts"
    "bar/": "./some/folder/bar/"
  }
}

用法：

import * as foo from "foo";
import * as bar from "bar/file.ts";

导入路径映射在较大的代码库中通常用于简化代码。

要使用项目根目录进行绝对导入：

{
  "imports": {
    "/": "./",
    "./": "./"
  }
}

import { MyUtil } from "/util.ts";

这会导致以 / 开头的导入指定符相对于导入映射的 URL 或文件路径解析。

任务 Jump to heading#

您在 deno.json 文件中的 tasks 字段用于定义可以使用 deno task 命令执行的自定义命令，并允许您根据项目的具体需求调整命令和权限。

这与 package.json 文件中的 scripts 字段类似，也受支持。

{
  "tasks": {
    "start": "deno run --allow-net --watch=static/,routes/,data/ dev.ts",
    "test": "deno test --allow-net",
    "lint": "deno lint"
  }
}

{
  "scripts": {
    "dev": "vite dev",
    "build": "vite build"
  }
}

要执行任务，请使用 deno task 命令后跟任务名称。例如：

deno task start
deno task test
deno task lint
deno task dev
deno task build

有关更多信息，请阅读 deno task。

代码检查 Jump to heading#

deno.json 文件中的 lint 字段用于配置 Deno 内置代码检查器的行为。这允许您指定要包含或排除在哪些文件中进行代码检查，以及自定义代码检查规则以满足项目的需求。

例如：

{
  "lint": {
    "include": ["src/"],
    "exclude": ["src/testdata/", "src/fixtures/**/*.ts"],
    "rules": {
      "tags": ["recommended"],
      "include": ["ban-untagged-todo"],
      "exclude": ["no-unused-vars"]
    }
  }
}

此配置将：

• 仅检查 src/ 目录中的文件，
• 不检查 src/testdata/ 目录中的文件或 src/fixtures/ 目录中的任何 TypeScript 文件。
• 指定应应用推荐的代码检查规则，
• 添加 ban-untagged-todo
• 移除排除的 no-unused-vars 规则。

您可以在 规则列表 文档页面中找到所有可用的代码检查规则的完整列表。

有关更多信息，请阅读 使用 Deno 进行代码检查。

格式化 Jump to heading#

deno.json 文件中的 fmt 字段用于配置 Deno 内置代码格式化程序的行为。这允许您自定义代码的格式，以确保项目的一致性，使其更易于阅读和协作。以下是您可以配置的关键选项：

{
  "fmt": {
    "useTabs": true,
    "lineWidth": 80,
    "indentWidth": 4,
    "semiColons": true,
    "singleQuote": true,
    "proseWrap": "preserve",
    "include": ["src/"],
    "exclude": ["src/testdata/", "src/fixtures/**/*.ts"]
  }
}

此配置将：

• 使用制表符而不是空格进行缩进，
• 将行限制为 80 个字符，
• 使用 4 个空格的缩进宽度，
• 在语句结束时添加分号，
• 对字符串使用单引号，
• 保留文本换行，
• 格式化 src/ 目录中的文件，
• 排除 src/testdata/ 目录中的文件和任何 TypeScript 文件。

有关更多信息，请阅读 使用 Deno 格式化代码。

锁定文件 Jump to heading#

deno.json 文件中的 lock 字段用于指定 Deno 使用的锁定文件的配置，以 确保依赖项的完整性。锁定文件记录了您的项目所依赖模块的确切版本和完整性哈希，确保在每次运行项目时使用相同的版本，即使依赖项被更新或远程更改。

{
  "lock": {
    "path": "./deno.lock",
    "frozen": true
  }
}

此配置将：

• 指定锁定文件位置为 ./deno.lock（这是默认值，可以省略）
• 告诉 Deno 如果有任何依赖项更改则返回错误

Deno 默认使用锁定文件，您可以使用以下配置禁用它：

{
  "lock": false
}

Node 模块目录 Jump to heading#

默认情况下，如果您的项目目录中有 package.json 文件，Deno 将使用本地 node_modules 目录。

您可以使用 deno.json 文件中的 nodeModulesDir 字段来控制此行为。

{
  "nodeModulesDir": "auto"
}

您可以将此字段设置为以下值：

不需要指定此设置，以下默认值会被应用：

• 如果您的项目目录中没有 package.json 文件，则为 "none"
• 如果您的项目目录中有 package.json 文件，则为 "manual"

使用工作区时，此设置只能在工作区根目录中使用。在任何成员中指定此设置都会导致警告。只有在工作区根目录中有 package.json 文件时，"manual" 设置才会被自动应用。

TypeScript 编译器选项 Jump to heading#

deno.json 文件中的 compilerOptions 字段用于配置 TypeScript 编译器设置 以符合您的 Deno 项目。这允许您自定义 TypeScript 代码的编译方式，确保与项目的要求和编码标准一致。

另请参见 在 Deno 中配置 TypeScript。

不稳定特性 Jump to heading#

deno.json 文件中的 unstable 字段用于启用 Deno 项目的特定不稳定特性。

这些特性仍在开发中，尚未成为稳定 API 的一部分。通过在 unstable 数组中列出特性，您可以在它们正式发布之前进行实验和使用这些新功能。

{
  "unstable": ["cron", "kv", "webgpu"]
}

了解更多。

include 和 exclude Jump to heading#

许多配置（例如 lint, fmt）都有 include 和 exclude 属性来指定要包含的文件。

include Jump to heading#

这里指定的路径或模式仅会被包含。

{
  "lint": {
    // 仅格式化 src/ 目录
    "include": ["src/"]
  }
}

exclude Jump to heading#

这里指定的路径或模式将被排除。

{
  "lint": {
    // 不检查 dist/ 文件夹
    "exclude": ["dist/"]
  }
}

此项优先级高于 include，如果在 include 和 exclude 中都匹配路径，则以 exclude 为准。

您可能希望排除一个目录，但包含一个子目录。在 Deno 1.41.2 及更高版本中，可以通过在更一般的排除下指定否定通配符来取消排除更具体的路径：

{
  "fmt": {
    // 不格式化 "fixtures" 目录，
    // 但格式化 "fixtures/scripts"
    "exclude": [
      "fixtures",
      "!fixtures/scripts"
    ]
  }
}

顶级排除 Jump to heading#

如果有一个目录您永远不希望 Deno 格式化、检查、类型检查、分析等，则在顶级排除数组中指定它：

{
  "exclude": [
    // 从所有子命令和 LSP 中排除 dist 文件夹
    "dist/"
  ]
}

有时您可能会发现希望取消排除顶级排除中已排除的路径或模式。在 Deno 1.41.2 及更高版本中，可以在更具体的配置中通过指定否定通配符取消排除路径：

{
  "fmt": {
    "exclude": [
      // 格式化 dist 文件夹，即使在顶级被排除
      "!dist"
    ]
  },
  "exclude": [
    "dist/"
  ]
}

发布 - 覆盖 .gitignore Jump to heading#

.gitignore 会被考虑在 deno publish 命令中。在 Deno 1.41.2 及更高版本中，您可以使用否定的排除通配符来选择不包含在 .gitignore 中的排除文件：

dist/
.env

{
  "publish": {
    "exclude": [
      // 包含被 git 忽略的 dist 文件夹
      "!dist/"
    ]
  }
}

另一种方法是将 git 忽略的路径明确指定在 "include" 中：

{
  "publish": {
    "include": [
      "dist/",
      "README.md",
      "deno.json"
    ]
  }
}

一个示例 deno.json 文件 Jump to heading#

{
  "compilerOptions": {
    "allowJs": true,
    "lib": ["deno.window"],
    "strict": true
  },
  "lint": {
    "include": ["src/"],
    "exclude": ["src/testdata/", "src/fixtures/**/*.ts"],
    "rules": {
      "tags": ["recommended"],
      "include": ["ban-untagged-todo"],
      "exclude": ["no-unused-vars"]
    }
  },
  "fmt": {
    "useTabs": true,
    "lineWidth": 80,
    "indentWidth": 4,
    "semiColons": false,
    "singleQuote": true,
    "proseWrap": "preserve",
    "include": ["src/"],
    "exclude": ["src/testdata/", "src/fixtures/**/*.ts"]
  },
  "lock": false,
  "nodeModulesDir": "auto",
  "unstable": ["webgpu"],
  "test": {
    "include": ["src/"],
    "exclude": ["src/testdata/", "src/fixtures/**/*.ts"]
  },
  "tasks": {
    "start": "deno run --allow-read main.ts"
  },
  "imports": {
    "oak": "jsr:@oak/oak"
  },
  "exclude": [
    "dist/"
  ]
}

This is an example of a deno.json file that configures the TypeScript compiler options, linter, formatter, node modules directory, etc. For a full list of available fields and configurations, see the Deno configuration file schema.

This is an example of a deno.json file that configures the TypeScript compiler options, linter, formatter, node modules directory, etc. For a full list of available fields and configurations, see the Deno configuration file schema.

JSON 模式 Jump to heading#

可用于编辑器提供自动完成的 JSON Schema 文件可在以下位置获得： https://github.com/denoland/deno/blob/main/cli/schemas/config-file.v1.json

代理 Jump to heading#

Deno 支持用于模块下载和 fetch API 的代理。代理配置从 环境变量 中读取：HTTP_PROXY，HTTPS_PROXY 和 NO_PROXY。

如果您使用的是 Windows - 如果未找到环境变量，Deno 将退回到从注册表读取代理。