# @git\.zone/tspublish 中文文档

规范地址：https://npmcn.com/package/%40git.zone/tspublish/

版本：2\.1\.0
npm 元数据更新时间：2026-10-20T16:52:21.673Z
中文译文更新时间：2026-11-16T13:40:45.094Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40git.zone/tspublish
原文对照：https://npmcn.com/package/%40git.zone/tspublish/?lang=original
项目主页：https://code.foss.global/git.zone/tspublish#readme
源码仓库：https://code.foss.global/git.zone/tspublish

弃用说明：@git\.zone/tspublish is deprecated: use @git\.zone/tsrepo \(tsrepo publish\)\. Migration: https://code\.foss\.global/git\.zone/tsrepo\#migrating-from-the-single-tools

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：122 kB，32 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2024-10-21T10:58:10.498Z
- 最新版本发布：2026-09-29T21:32:06.349Z
- 近 30 天下载量：2118（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：43（近 12 个月 14 个）

## 中文简介

一个用于规划和准备多件,简洁,从单重堆取来的小包的工具,专门用于TypeScript环境下的项目.

## 安装

```sh
npm install @git.zone/tspublish
```

也可以使用：`pnpm add @git.zone/tspublish`、`yarn add @git.zone/tspublish`、`bun add @git.zone/tspublish`

## README

# @git.zone/tspublish

从一个寄存器中计划并准备可独立安装的TypeScript包. 每个组成部分都有自己的依赖清单和数据包元数据;组成部分共享 存储器版本。 TsBuild拥有汇编. tspiblish 不发布 : `gitzone release` 在包装前准备所有包裹, 编辑和出版其中的任何出版物.

## 问题报告和安全

关于报告错误、问题或安全弱点,请访问 [社区. fos.global/](https://community.foss.global/)这是所有问题报告的中央社区中心。 签署和遵守我们缴款协议并经过身份验证的开发者也可获得 [代码.fos.global/](https://code.foss.global/) 账户直接提交 Pull 请求.

## 安装

```sh
pnpm install --save-dev @git.zone/tspublish @git.zone/tsbuild
```

## 仓库结构

当寄存器拥有整个寄存器时,保持显示的私有性 工具箱。 (笑声) 每个命名的模块成为单独的公共软件包,并带有过滤器 扶养表.

```text
package.json
tsconfig.json
license.md
ts_core/
  index.ts
  readme.md
  tspublish.json
ts_adapter/
  index.ts
  readme.md
  tspublish.json
```

仓库的 `package.json` 提供共享版本和外部依赖性 各个版本。 内部软件包依赖性使用准确的共享版本,即使 较旧的出版版本出现在根表。 未知的外部依赖性 失败验证而不是被指定寄存器版本 .

每个软件包都需要自己的 `readme.md`。根许可证被复制到每个 准备的成套材料. `license.md` 首选; 使用 `license` 继续支持.

## 模块配置

```json
{
  "name": "@example/adapter",
  "order": 2,
  "description": "Optional provider adapter for the example toolbox.",
  "dependencies": ["@example/core", "external-sdk"],
  "registries": ["useBase"],
  "bin": [],
  "engines": { "node": ">=24" },
  "sideEffects": false,
  "include": ["third-party-notices.md"]
}
```

支持的字段 :

| 外地 | 含义 |
| --- | --- |
| `name` | 已发布 npm 包名 。 未命名的描述词仍然可供 TsBuild 仅供订购 . |
| `order` | 排序具有依赖性的模块的偏好。 依赖总是先于消费者. |
| `dependencies` | 需要的软件包名称,通过兄弟会模块或根生产依赖解决. |
| `optionalDependencies` | 可选的受抚养人名,由同规则解决. |
| `devDependencyVersions` | 姓名来源 `dependencies` 或者说 `optionalDependencies` 其范围来自根 `devDependencies` 相反;参见"从根devdependents". |
| `peerDependencies` | 明确的对等版本范围 . |
| `peerDependenciesMeta` | 可选同级元数据. |
| `description` | 软件包描述; 根描述默认 . |
| `engines` | 运行时间要求; 默认为根引擎 . |
| `os`, (中文(简体) ), `cpu`, (中文(简体) ), `libc` | 非空的 npm 平台- 选择器阵列 。 可使用条目 `!` 以排除平台; 拒绝重复条目。 每个模块宣布自己的选择者. |
| `publishConfig.executableFiles` | 精确的 pnpm 软件包关联文件必须带有可执行权限 。 没有线索 `./`,可转动,可转动,可重复,可并联或目录. 每一个路径都必须包含在这个包中. 其它 `publishConfig` 密钥被拒绝 . |
| `sideEffects` | 标准包副作用声明. |
| `folders` | 额外 `ts_*` 此软件包拥有的文件夹。 文件夹可能只有一个所有者 . |
| `exports` | 明确子路径/有条件导出到包已编译文件夹中 。 默认输入根导出 . |
| `include` | 准确的寄存器-相对资产文件或目录,包括适用的通知. 没有光源或组件源/编译文件夹; 使用 `folders` 宣布来源所有权. |
| `externalRuntimeAssets` | 精确寄存器 - 相对文件或目录由另一个运行时间执行,例如Deno source. 没有 npm 导入验证而复制; 软件包所有者必须限定运行时间及其依赖性图表 。 与文件系统和文件夹所有性限制相同的 `include` 应用。 资产申报不能重叠. |
| `bin` | 使用模块导出的执行名 `runCli()` 进入点。 包装器是本地生成的. |
| `registries` | 目的地意图,返回计划 释放协调员验证. `gitzone release` 需求 `["useBase"]`。 。 。 . |

根作者、许可证、寄存器、主页、错误、关键词和供资元数据 保留下来了。 私有寄存器旗、 根脚本、 无关的依赖和 开发依赖不复制到已准备的软件包中;只复制范围 a 模块名称 `devDependencyVersions` 取自根发展 依赖性.

### 根依赖的版本

一个模块的外部依赖性取取出根的确切范围 `package.json` 声明于 `dependencies`当根不能将套件作为 生产依赖性,例如根部生产中的一切 依赖被编译成被封存的二进制, 在根中声明 `devDependencies` 在模块中命名它 `devDependencyVersions`数字 :

```json
{
  "name": "@example/bundle",
  "dependencies": ["@example/core", "@git.zone/tspack", "@push.rocks/smartdaemon"],
  "devDependencyVersions": ["@git.zone/tspack", "@push.rocks/smartdaemon"],
  "registries": ["useBase"]
}
```

已出版的软件包逐一列出其中的每个 `dependencies` (或 `optionalDependencies`,如果此处命名),其根在 `devDependencies`不变。 选入是每个模块和每个名字,所以是根 构建或测试工具从未意外到达已发布的软件包:依赖 仅在根中找到 `devDependencies` 未在 `devDependencyVersions` 失败 `Missing or unsupported published dependency version for <name>.` 财务报告和审定财务报表 名称选择进入。 条目也必须在 `dependencies` 或者说 `optionalDependencies`,并且不能命名兄弟姐妹模块(兄弟姐妹们使用 或根生产依赖性(每个范围一个来源)。 这个 范围规则是根生产依赖性的规则:缺失、空出、, `workspace:`, (中文(简体) ), `file:` 或者说 `link:` 区域被拒绝.

遗产 `main` 财务报告和审定财务报表 `types` 字段来源于根导出 `node`, (中文(简体) ), `import`, (中文(简体) ), `default`,以及 `types` 具备条件时。 他们从不指点 当根输出被定制时, 一个不相关的默认切入点.

本地软件包可以声明 `"os": ["linux"]`, (中文(简体) ), `"cpu": ["x64"]`, (中文(简体) ), `"libc": ["glibc"]` 财务报告和审定财务报表 `"publishConfig": { "executableFiles": ["dist_ts_native/native"] }`。 。 。 . 将已建成的有效载荷放入该模块汇编的文件夹中,然后编写和 包括其适用的通知。 准备保存有效载荷的字节并 源权限; pnpm 包装时应用可执行权限. 家长 模块可以在 `optionalDependencies`,使用 同样的精确的兄弟姐妹版本和依附顺序 与所需的依附.

发射 Deno 可以声明的包装器 `"include": ["deno.json", "deno.lock"]` 财务报告和审定财务报表 `"externalRuntimeAssets": ["mod.ts", "deno_src"]`复制这些文件 不变。 验证 Deno 配置、 锁定的依赖和执行 释放前分开。 此声明不添加 npm 依赖性或允许 组件 `ts*`编号 :`dist_ts*` 要绕过 npm 导入检查的文件夹。 节点源导入 声明不承认这些外部资产.

对于子路径,请包含额外的源文件夹并声明运行时间和 类型条目 :

```json
{
  "name": "@example/core",
  "order": 1,
  "dependencies": [],
  "registries": ["useBase"],
  "folders": ["ts_migration"],
  "exports": {
    ".": {
      "types": "./dist_ts_core/index.d.ts",
      "import": "./dist_ts_core/index.js"
    },
    "./migration": {
      "types": "./dist_ts_migration/index.d.ts",
      "import": "./dist_ts_migration/index.js"
    }
  }
}
```

## 进口和地方发展

通过已公布的软件包名称导入兄弟式组件并声明 内 `dependencies`。配置 TypeScript 路径到源条目 ; GitZone 的 TypeScript formatter 从中发现了这些映射 `tspublish.json`。这不需要工作空间的同义链接或本地软件包的依赖性.

在准备前运行正常的仓库构建 :

```sh
pnpm build
```

准备需要匹配 `dist_ts*` 产出和核实每出出口 目标。 它检查节点来源、申报和普通的进口 `include` 资产,并拒绝 未申报的依赖性和组成部分外的相对进口。 已计算 运行时间导入仍然是模块作者的责任。 内建节点 允许模块。 浏览器兼容性仍然必须由每个组件测试.

源文件夹、编译文件夹和明文资产分别复制 每个包裹。 链接、证书文件和本地依赖目录 拒绝,包括内部 `externalRuntimeAssets`。准备不捆绑 依赖性执行.

一个包裹离开 `tspublish.json` 编辑 `tsconfig.json` 每个文件夹 它拥有。 一个文件夹 `tsconfig.json` 设置该文件夹的 TypeScript 环境 例如, TsBuild `"lib": ["webworker", "esnext"]` 服务人员 "Folder tsconfig.json"在电影中被誉为"Folder tsconfig.json" `@git.zone/tsbuild` 读我。 包裹载着什么 TsBuild根据这些设置编译. 文件本身 `extends` 存储器 `tsconfig.json`,没有软件包,所以TypeScript无法在内部读取 软件包(TS5083). 只有 `tsconfig.json` 直接在自有文件夹内是 左出,一个Tsbuild读.

## 计划和筹备

```typescript
import { TsPublish } from '@git.zone/tspublish';

const publisher = new TsPublish();
const plan = await publisher.plan(process.cwd());
// plan.modules is in deterministic dependency order; order equals its array index.

const packages = await publisher.prepare(
  process.cwd(),
  '/absolute/existing-parent/new-package-directory',
);
// Each result contains folder, folders, name, version, order, manifest,
// include, licenseFile, registries and its prepared directory.
```

`plan()` 无需写作、构建或网络即可阅读清单和许可证 打电话 它拒绝重复的软件包名称、依赖周期、未知的外部 依赖版本,本地依赖链接和无效的软件包路径. A 类 `tspublish.json` 无效的 JSON 失败 `Invalid JSON in <path>: <reason>`, (中文(简体) ), 一个不是JSON的对象 `Invalid <path>: expected a JSON object.`, (中文(简体) ), tsBuild 用于同一文件的措辞。 仓库的 `package.json` 失败 同样的方式.

一个没有描述器命名软件包的仓库, 不管它是否只有 仅命令描述符或无 `ts*` 文件夹,计划为 `{ schemaVersion: 1, version, modules: [] }` 带根 `package.json` 版本. 这个计划没有许可证 所以放行协调员可以计划任何版本的 npm 寄存器和决定 `modules.length` 是否要发布软件包.

发现无声: `getModuleSubDirs()`, (中文(简体) ), `plan()` 财务报告和审定财务报表 `prepare()` 写什么给 控制台,因为建立工具 和释放协调员称它们为图书馆.

`prepare()` 重新制定计划并实现已经建成的软件包。 产出 目录决不能存在;其父目录必须已经存在于犬科路径上. 产出 无法嵌入输入文件夹。 准备删除自己的不完整 在失败时输出,并且绝不覆盖先前的结果。 来电成功 编制目录并进行清理.

两种方法都不安装依赖性,获取模板,联系人登记册, 发布软件包或终止进程.

CLI揭露相同的操作

```sh
pnpm exec tspublish plan
pnpm exec tspublish prepare /absolute/existing-parent/new-package-directory
```

任何其他援引,包括 `tspublish`,打印到 stderr 和 1级出入口. 失败 `plan` 或者说 `prepare` 将其信件打印到 stderr, 没有堆栈追踪, 留下 Stdout 空出, 并有状态 1 。 导出 `runCli()` 用这个错误拒绝; 二进制报告它.

发布协调员应验证每个模块的目的地意图,准备 所有模块,每包包,记录完整的不可移动文物,以及 然后按返回的依赖顺序发布。 出版物回收必须再利用 而不是再重建或准备.

## 出版

发布 tspiblish 模块 `gitzone release` 从 `@git.zone/cli` 7: 0或更晚时. 它在其期刊发行中按计划顺序出版每个命名单元 在根包之前,转入 `release.targets.npm`; 见 将“可独立安装的组件” `@git.zone/cli` 读我.

2.0.0版本删除了独立的出版商, `TsPublish.publish()` 赤裸的 `tspublish` 命令。 删除运行它的软件包脚本; `gitzone release` 拒绝 {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}放出一个.

## 发展

```sh
pnpm build
pnpm test
pnpm exec tsbuild check 'test/**/*'
```

包装测试使用可支配目录,不发布任何内容.

## 许可证和法律资料

这个寄存器包含根据麻省理工学院许可证许可的开源代码. 许可证副本可在 [许可证md](https://npmcn.com/package/%40git.zone/tspublish/license.md) 文档.

**请注意:** 麻省理工学院许可证不准许使用该项目的商品名、商标、服务标记或产品名称,除非在描述作品来源和复制NOTICE文件内容时需要合理和习惯使用.

### 商标

这个项目由Task Venture Capital GmbH拥有和维护。 与Task Venture Capital GmbH相关的名称和标志以及任何相关的产品或服务是Task Venture Capital GmbH或第三方的商标,不属于本文授予的麻省理工学院许可证的范围.

使用这些商标必须符合Wasure Venture Capital GmbH的商标准则或各自的第三方所有者的准则,任何使用都必须获得书面批准。 此处使用的第三方商标是其各自所有者的财产并仅以描述方式使用,例如用于实施API或类似的.

### 企业信息

任务风险资本股份有限公司 在德国不来梅地区法院注册的HRB 35230 HB

如欲了解任何法律查询或进一步情况,请通过电子邮件与我们联系 [你好@ task.vc](mailto:hello@task.vc)。 。 。 .

通过使用这个寄存器,你承认你读过这个部分,同意遵守它的条款,并且明白代码的许可并不意味着Task Venture Capital GmbH认可任何衍生作品.

## 常见问题

### @git\.zone/tspublish 是什么？

一个用于规划和准备多件,简洁,从单重堆取来的小包的工具,专门用于TypeScript环境下的项目\.注意：该包已被作者标记为弃用——@git\.zone/tspublish is deprecated: use @git\.zone/tsrepo \(tsrepo publish\)\. Migration: https://code\.foss\.global/git\.zone/tsrepo\#migrating-from-the-single-tools

### 如何安装 @git\.zone/tspublish？

在项目目录运行 npm install @git\.zone/tspublish，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 tspublish，可以用 npx tspublish 直接运行。

### @git\.zone/tspublish 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @git\.zone/tspublish 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @git\.zone/tspublish 可以商用吗？

@git\.zone/tspublish 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @git\.zone/tspublish 的下载量有多少？

根据 npm 官方下载统计，@git\.zone/tspublish 在 2026/10/17 – 2026/11/15 这 30 天内被下载 2,118 次，日均约 71 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @git\.zone/tspublish 还在维护吗？

最新版本 2\.1\.0 发布于 2026/09/30（1 个月前）；至今共发布 43 个版本，其中过去 12 个月发布了 14 个；首次发布于 2024/10/21。作者已将其标记为弃用，新项目建议寻找替代方案。

