deno pack

deno pack 命令会从 Deno 项目构建一个与 npm 兼容的 tarball（.tgz），因此你可以将 Deno 编写的库直接发布到 npm 注册表。它会将 TypeScript 转译为 JavaScript，生成 .d.ts 声明文件，重写导入标识符，并合成一个 npm 仅消费者能够理解的 package.json。

deno pack 不等同于 npm pack。它是一个构建步骤，用于将 Deno/JSR 项目转换为可发布到 npm 的包——更接近于 deno transpile 与 npm pack 的组合。 它不会读取现有的 package.json，不会遵循 .npmignore，也不会运行 prepublishOnly / prepare 生命周期脚本。

快速开始 Jump to heading#

deno pack

deno pack 会从 deno.json 中读取包元数据（你用于发布到 JSR 的 name、version 和 exports），并将一个 gzipped tarball 写入当前目录。

给定如下 deno.json：

{
  "name": "@scope/my-lib",
  "version": "1.0.0",
  "exports": "./mod.ts"
}

deno pack 会生成 scope-my-lib-1.0.0.tgz（会去掉 @，并将 / 替换为 -，这与 npm pack 的命名约定一致）。

tarball 中包含什么 Jump to heading#

仅包含通过从 exports 可达的模块图所能访问到的文件。 像数据文件或 WASM 这类非 JS 资产，只有在被 JS/TS 导入时才会包含。如果你需要打包任意文件，请将它们作为位置参数列出：

deno pack assets/icon.svg locales/*.json

标识符重写 Jump to heading#

为了让生成的包能在 Node 和其他 npm 消费者中正常工作，deno pack 会在转译时重写导入：

由于 JSR 导入会变成 @jsr/... 标识符，任何安装该已发布 tarball 的人都需要配置 JSR npm 注册表。最简单的方法是 在消费者项目中运行一次 npx jsr add；这会为 @jsr 作用域设置好 .npmrc 条目。

Deno API shim Jump to heading#

如果你的代码使用了 Deno.* 全局对象，deno pack 会添加 @deno/shim-deno 作为运行时 依赖，并注入该 shim，使包能够在 Node.js 下运行。该 shim 覆盖了能顺利映射到 Node API 的那部分 Deno.*——请查看该 shim 的文档以了解哪些内容被 polyfill 了。

传入 --no-deno-shim 可选择不使用，例如当你已经提供了自己的 抽象层，或者只打算让该包在 Deno-on-npm 下运行时。

发布到 npm Jump to heading#

deno pack
npm publish ./scope-my-lib-1.0.0.tgz

典型的发布流程：

# 1. 提升版本号
deno bump-version patch

# 2. 构建 tarball
deno pack

# 3. 验证内容（解压后的视图）
tar -tzf scope-my-lib-1.0.0.tgz

# 4. 推送到 npm
npm publish ./scope-my-lib-1.0.0.tgz

对于 JSR 发布，请使用 deno publish—— deno pack 是专门用于 npm 注册表的。

工作区支持 Jump to heading#

在 workspace 中，deno pack 会针对当前工作目录中的成员运行。要从根目录打包某个特定成员：

cd packages/my-lib
deno pack

跨工作区的 npm: / jsr: 依赖会在生成的 package.json 中被重写为指向它们已发布的版本，而不是其他工作区成员——在发布 tarball 之前，请确保这些依赖已独立发布。

示例 Jump to heading#

覆盖版本 Jump to heading#

在发布一次性预发布版本而不编辑 deno.json 时很有用：

deno pack --set-version 2.0.0-rc.1

选择输出路径 Jump to heading#

deno pack --output dist/my-package.tgz

预览而不写入 Jump to heading#

deno pack --dry-run

--dry-run 会打印 tarball 中本来会包含的内容，但不会真正生成 tarball——很适合在 CI 中验证文件包含规则。

允许慢类型 Jump to heading#

慢类型 会阻止生成 .d.ts。 仍要打包时可传入 --allow-slow-types；tarball 将不包含 声明文件。

deno pack --allow-slow-types

跳过 Deno shim Jump to heading#

deno pack --no-deno-shim

即使工作树脏也打包 Jump to heading#

deno pack --allow-dirty

默认情况下，当 git 工作树存在未提交更改时，deno pack 会拒绝打包，以便让发布可以从提交哈希复现。

排除文件 Jump to heading#

deno pack --ignore=tests/ --ignore='**/*.test.ts'

--ignore 接受 glob 模式。组合多个 --ignore 标志可添加更多 模式。

省略 source map Jump to heading#

deno pack --no-source-maps

默认情况下，source map 会以内联方式包含在生成的 .js 文件中。使用 --no-source-maps 可将其移除——tarball 会更小，但上游调试会更困难。

限制 Jump to heading#

• 没有 bin 条目。 deno pack 不会合成 package.json 中的 bin 字段。支持库发布；需要 node shebang 可执行文件的 CLI 工具仍然需要手工编写 npm 包。
• 没有原生插件。 依赖原生代码或包含 node-gyp 构建步骤的包不在支持范围内。
• 没有 .npmignore。 使用 --ignore 进行排除；.gitignore 会被遵循，用于决定哪些内容被视为项目的一部分。
• 没有生命周期脚本。 手写 package.json 中的 prepublishOnly / prepare / postinstall 钩子不会运行，因为 package.json 是生成的，不是读取的。

何时使用 deno pack 与 deno publish Jump to heading#

一个库可以同时发布到两者——先用 deno publish 发布到 JSR，然后用 deno pack 构建并 推送 tarball 到 npm，供尚未采用 JSR 的用户使用。

另请参阅 Jump to heading#

• deno publish — 发布到 JSR
• deno transpile — deno pack 在内部使用的 输出步骤
• deno bump-version — 在打包前提升 deno.json / package.json 中的 version
• 发布模块 — Deno 编写的库可以发布到何处的概览

deno pack [OPTIONS] [files]...