# @bunli/plugin-completions 中文文档

规范地址：https://npmcn.com/package/%40bunli/plugin-completions/

版本：0\.3\.5
npm 元数据更新时间：2026-03-27T23:26:28.339Z
中文译文更新时间：2026-11-08T19:53:06.380Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bunli/plugin-completions
原文对照：https://npmcn.com/package/%40bunli/plugin-completions/?lang=original

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

- 包体积（解压后）：80.8 kB，29 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-01-30T09:37:50.315Z
- 最新版本发布：2026-03-27T23:26:28.248Z
- 近 30 天下载量：3220（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

Bunli CLI 框架的 Shell 补全插件

## 安装

```sh
npm install @bunli/plugin-completions
```

也可以使用：`pnpm add @bunli/plugin-completions`、`yarn add @bunli/plugin-completions`、`bun add @bunli/plugin-completions`

## README

# @bunli/ plugin- 完成

Bunli CLIs 的 Tab- 动力外壳完成 .

此插件代表脚本生成和动态补全协议( E)`complete -- <args>`改为: `@bomb.sh/tab`从 Bunli 生成的元数据中创建 Tab 命令树(`.bunli/commands.gen.ts`) (中文(简体) ).

## 安装

```bash
bun add @bunli/plugin-completions
```

## 设置

```ts
import { defineConfig } from '@bunli/core'
import { completionsPlugin } from '@bunli/plugin-completions'

export default defineConfig({
  name: 'my-cli',
  plugins: [
    completionsPlugin({
      // generatedPath: '.bunli/commands.gen.ts',
      // commandName: 'my-cli',
      // executable: 'my-cli',
      // includeAliases: true,
      // includeGlobalFlags: true
    })
  ]
})
```

你一定有过 `.bunli/commands.gen.ts` 可用(运行) `bunli generate`,或启用您的建筑中的代码.

## 图标

### 生成一个补全脚本

```bash
my-cli completions zsh
my-cli completions bash
my-cli completions fish
my-cli completions powershell
```

### 动态补全协议召回( 被 shell 脚本使用)

```bash
my-cli complete -- <args...>
```

不要在 Bunli 的解析中构建自己的整合 `positional` 此路径的参数 : Tab 依赖于后端的空字符串 sentinel(`''`Bunli 解析器会空出字符串 。 实施用途 `runtime.args` 直接说.

## Shell 设置示例

### 巴许

```bash
source <(my-cli completions bash)
```

### 日语

```bash
source <(my-cli completions zsh)
```

### 鱼

```bash
my-cli completions fish > ~/.config/fish/completions/my-cli.fish
```

### 动力壳

```powershell
my-cli completions powershell | Out-String | Invoke-Expression
```

## 页:1

### 运行时间包装

`@bunli/plugin-completions` 发布捆绑的运行时间( i)`dist/index.js`)已经包括 Tab 。 下游消费者只安装 `@bunli/plugin-completions` 并且不需要单独的运行时间依赖 `@bomb.sh/tab`。 。 。 .

### `@bomb.sh/tab` 类型注释

截止 `@bomb.sh/tab@0.0.13`,已发布的软件包参考文献 `dist/t.d.ts` 但只有舰只 `dist/t-<hash>.d.ts`. Bunli的单雷波用途 `bun patch` 在开发/CI期间保持TypeScript所构建的屏蔽,直到上游修复包装.

## 常见问题

### @bunli/plugin-completions 是什么？

Bunli CLI 框架的 Shell 补全插件

### 如何安装 @bunli/plugin-completions？

在项目目录运行 npm install @bunli/plugin-completions，或使用 pnpm add / yarn add / bun add。

### @bunli/plugin-completions 支持 TypeScript 吗？

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

### @bunli/plugin-completions 支持 ESM 还是 CommonJS？

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

### @bunli/plugin-completions 可以商用吗？

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

### @bunli/plugin-completions 的下载量有多少？

根据 npm 官方下载统计，@bunli/plugin-completions 在 2026/10/09 – 2026/11/07 这 30 天内被下载 3,220 次，日均约 107 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bunli/plugin-completions 还在维护吗？

最新版本 0\.3\.5 发布于 2026/03/28（7 个月前）；至今共发布 12 个版本，其中过去 12 个月发布了 12 个；首次发布于 2026/01/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。