# @gplane/cue 中文文档

规范地址：https://npmcn.com/package/%40gplane/cue/

版本：0\.2\.0
npm 元数据更新时间：2024-01-14T07:19:16.826Z
中文译文更新时间：2026-11-16T21:11:07.497Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gplane/cue
原文对照：https://npmcn.com/package/%40gplane/cue/?lang=original
项目主页：https://github.com/g-plane/cue#readme
源码仓库：https://github.com/g-plane/cue

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

- 包体积（解压后）：73 kB，21 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-04-01T03:55:15.092Z
- 最新版本发布：2024-01-14T07:19:16.458Z
- 近 30 天下载量：254279（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

用于处理 Cue 工作表的库 .

## 安装

```sh
npm install @gplane/cue
```

也可以使用：`pnpm add @gplane/cue`、`yarn add @gplane/cue`、`bun add @gplane/cue`

## README

# 提示

用于处理 Cue 工作表的图书馆, 带有宽容的解析器 .

## 使用量

### 分析

```javascript
import { parse } from '@gplane/cue'

const { sheet, errors } = parse('')
```

您可以通过 `sheet`。 。 。 .

默认情况下,parser对语法是宽容的. 如果出现语法错误,可以通过 `errors`, (中文(简体) ), 您还可以得到解析结果 `sheet`。 。 。 .

#### `fatal` 选项

错误将被丢弃而不是被收集到 `errors` 若为 `fatal` 选项设定为 `true`。 。 。 .

```javascript
import { parse } from '@gplane/cue'

const { sheet, errors } = parse('', { fatal: true })
```

#### `checkAtLeastOneTrack` 选项

如果 `checkAtLeastOneTrack` 选项设定为 `true`。 。 。 .

```javascript
import { parse } from '@gplane/cue'

const { sheet, errors } = parse('', { checkAtLeastOneTrack: true })
```

#### `strictFileCommandPosition` 选项

立场 `FILE` 如果 `strictFileCommandPosition` 选项设定为 `true`。 。 。 .

```javascript
import { parse } from '@gplane/cue'

const { sheet, errors } = parse('', { strictFileCommandPosition: true })
```

#### `strictPerformerLength` 选项

超过80个字符的表演者字符串,如果 `strictPerformerLength` 选项设定为 `true`。 。 。 .

```javascript
import { parse } from '@gplane/cue'

const { sheet, errors } = parse('', { strictPerformerLength: true })
```

#### `strictSongWriterLength` 选项

超过80个字符的歌曲作者字符串,如果 `strictSongWriterLength` 选项设定为 `true`。 。 。 .

```javascript
import { parse } from '@gplane/cue'

const { sheet, errors } = parse('', { strictSongWriterLength: true })
```

#### `strictTitleLength` 选项

标题字符串中, 超过 80 个字符将被视为错误, 如果 `strictTitleLength` 选项设定为 `true`。 。 。 .

```javascript
import { parse } from '@gplane/cue'

const { sheet, errors } = parse('', { strictTitleLength: true })
```

### 倾销

```javascript
import { dump } from '@gplane/cue'

const sheet = {
  /* ... */
}
const text = dump(sheet)
```

您可以通过 Cue 工作表对象(例如 `sheet` 从 `parse` 页:1.

有一些限制:

-   通过使用 `REM` 命令不支持.
-   它不会验证 Cue Sheet。 例如,如果文件名称为 `FILE` 命令是一个空字符串,它仍然会被丢弃而不检查.

#### `lineBreak` 选项

仅 `'\n'` 或者说 `'\r\n'` 允许。 默认值是 `'\n'`。 。 。 .

```javascript
import { dump } from '@gplane/cue'

const sheet = {
  /* ... */
}
const text = dump(sheet, { lineBreak: '\r\n' })
```

#### `indentKind` 选项

仅 `'\t'` 或者说 `' '` 允许。 默认值是 `' '`。 。 。 .

```javascript
import { dump } from '@gplane/cue'

const sheet = {
  /* ... */
}
const text = dump(sheet, { indentKind: '\t' })
// or
const text = dump(sheet, { indentKind: ' ' })
```

#### `indentSize` 选项

只允许正整数 。 默认值是 `2`。 。 。 .

```javascript
import { dump } from '@gplane/cue'

const sheet = {
  /* ... */
}
const text = dump(sheet, { indentSize: 4 })
```

## 参考资料

-   [语法参考 1](https://web.archive.org/web/20151023011544/http://digitalx.org/cue-sheet/syntax/index.html)
-   [语法参考 2](https://web.archive.org/web/20070614044112/http://www.goldenhawk.com/download/cdrwin.pdf)

## 许可证

MIT 许可证

版权(c)2021年至今

## 常见问题

### @gplane/cue 是什么？

用于处理 Cue 工作表的库 \.

### 如何安装 @gplane/cue？

在项目目录运行 npm install @gplane/cue，或使用 pnpm add / yarn add / bun add。

### @gplane/cue 支持 TypeScript 吗？

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

### @gplane/cue 支持 ESM 还是 CommonJS？

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

### @gplane/cue 可以商用吗？

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

### @gplane/cue 的下载量有多少？

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

### @gplane/cue 还在维护吗？

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

