deno.json 和 package.json

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

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

如果 deno.json 或 deno.jsonc 配置文件位于您当前工作目录或父目录中，Deno 将自动检测它。 --config 标志可用于指定不同的配置文件。

package.json 支持跳转到标题

为了兼容 Node.js 项目，Deno 也支持 package.json 文件。如果您有一个 Node.js 项目，则无需创建 deno.json 文件。Deno 将使用 package.json 文件来配置项目。

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

依赖项跳转到标题

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

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

deno.json

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

然后，您的脚本可以使用裸说明符 std/assert

script.ts

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

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

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

package.json

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

script.ts

import express from "express";

const app = express();

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

阅读更多关于模块导入和依赖项

自定义路径映射跳转到标题

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

deno.jsonc

{
  "imports": {
    // Map to an exact file
    "foo": "./some/long/path/foo.ts",
    // Map to a directory, usage: "bar/file.ts"
    "bar/": "./some/folder/bar/"
  }
}

用法

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

导入说明符的路径映射通常用于较大的代码库中，以提高简洁性。

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

deno.json

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

main.ts

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

这将导致以 / 开头的导入说明符相对于导入映射的 URL 或文件路径进行解析。

任务跳转到标题

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

它类似于 package.json 文件中的 scripts 字段，Deno 也支持该字段。

deno.json

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

package.json

{
  "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。

代码检查跳转到标题

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

例如

deno.json

{
  "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 代码检查文档中找到可用代码检查规则的完整列表。

阅读更多关于使用 Deno 进行代码检查。

格式化跳转到标题

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

deno.json

{
  "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/ 目录中的文件以及 src/fixtures/ 目录中的所有 TypeScript 文件。

阅读更多关于使用 Deno 格式化代码的信息。

锁定文件跳转到标题

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

deno.json

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

此配置将

将锁定文件位置指定为 ./deno.lock（这是默认设置，可以省略）；
告诉 Deno 如果有任何依赖项更改，您希望它报错；

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

deno.json

{
  "lock": false
}

Node 模块目录跳转到标题

如果您的项目目录中有一个 package.json 文件，Deno 默认会使用本地 node_modules 目录。

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

deno.json

{
  "nodeModulesDir": "auto"
}

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

值	行为
`“none”`	不使用本地 `node_modules` 目录。而是使用 `$DENO_DIR` 中的全局缓存，Deno 会自动使其保持最新。
`“auto”`	使用本地 `node_modules` 目录。该目录由 Deno 自动创建并保持最新。
`“manual”`	使用本地 `node_modules` 目录。用户必须手动保持此目录的最新状态，例如，使用 `deno install` 或 `npm install`。

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

如果项目目录中没有 package.json 文件，则为 "none"；
如果项目目录中存在 package.json 文件，则为 "manual"。

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

TypeScript 编译器选项跳转到标题

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

信息

Deno 建议使用默认的 TypeScript 配置。这在共享代码时会有所帮助。

另请参阅在 Deno 中配置 TypeScript。

不稳定特性跳转到标题

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

这些特性仍在开发中，还不是稳定 API 的一部分。通过在 unstable 数组中列出特性，您可以在这些新功能正式发布之前体验和使用它们。

deno.json

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

了解更多.

包含和排除跳转到标题

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

包含跳转到标题

仅包含此处指定的路径或模式。

{
  "lint": {
    // only format the src/ directory
    "include": ["src/"]
  }
}

排除跳转到标题

此处指定的路径或模式将被排除。

{
  "lint": {
    // don't lint the dist/ folder
    "exclude": ["dist/"]
  }
}

这比 include 具有更高的优先级，如果一个路径在 include 和 exclude 中都匹配，则 exclude 将优先。

您可能希望排除一个目录，但包含一个子目录。在 Deno 1.41.2+ 中，您可以通过在更通用的排除项下方指定一个否定 glob 来取消排除更具体的路径。

{
  "fmt": {
    // don't format the "fixtures" directory,
    // but do format "fixtures/scripts"
    "exclude": [
      "fixtures",
      "!fixtures/scripts"
    ]
  }
}

顶层排除跳转到标题

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

{
  "exclude": [
    // exclude the dist folder from all sub-commands and the LSP
    "dist/"
  ]
}

有时您可能会发现想要取消排除在顶层排除中排除的路径或模式。在 Deno 1.41.2+ 中，您可以通过在更具体的配置中指定否定 glob 来取消排除路径。

{
  "fmt": {
    "exclude": [
      // format the dist folder even though it's
      // excluded at the top level
      "!dist"
    ]
  },
  "exclude": [
    "dist/"
  ]
}

发布 - 覆盖 .gitignore 跳转到标题

deno publish 命令会考虑 .gitignore。在 Deno 1.41.2+ 中，您可以选择不排除在 .gitignore 中忽略的文件，方法是使用否定排除 glob。

.gitignore

dist/
.env

deno.json

{
  "publish": {
    "exclude": [
      // include the .gitignored dist folder
      "!dist/"
    ]
  }
}

或者，在 "include" 中显式指定 gitignore 路径也可以。

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

完整示例跳转到标题

{
  "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/"
  ]
}

JSON 模式跳转到标题

提供了一个 JSON 模式文件供编辑器提供自动补全。该文件已版本化，可在此处获取：https://deno.land/x/deno/cli/schemas/config-file.v1.json

代理跳转到标题

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

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

deno.json 和 package.json

package.json 支持 跳转到标题#

依赖项 跳转到标题#

自定义路径映射 跳转到标题#

任务 跳转到标题#

代码检查 跳转到标题#

格式化 跳转到标题#

锁定文件 跳转到标题#

Node 模块目录 跳转到标题#

TypeScript 编译器选项 跳转到标题#

不稳定特性 跳转到标题#

包含和排除 跳转到标题#

包含 跳转到标题#

排除 跳转到标题#

顶层排除 跳转到标题#

发布 - 覆盖 .gitignore 跳转到标题#

完整示例 跳转到标题#

JSON 模式 跳转到标题#

代理 跳转到标题#

package.json 支持跳转到标题

依赖项跳转到标题

自定义路径映射跳转到标题

任务跳转到标题

代码检查跳转到标题

格式化跳转到标题

锁定文件跳转到标题

Node 模块目录跳转到标题

TypeScript 编译器选项跳转到标题

不稳定特性跳转到标题

包含和排除跳转到标题

包含跳转到标题

排除跳转到标题

顶层排除跳转到标题

发布 - 覆盖 .gitignore 跳转到标题

完整示例跳转到标题

JSON 模式跳转到标题

代理跳转到标题