@gplane/cue

中文文档
0.2.0发布于 2024/01/14MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 25.4万

用于处理 Cue 工作表的库 .

中文使用文档
文档目录5 节
  1. 使用量
  2. 分析
  3. 倾销
  4. 参考资料
  5. 许可证

提示

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

使用量

分析

import { parse } from '@gplane/cue'

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

您可以通过 sheet。 。 。 .

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

fatal 选项

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

import { parse } from '@gplane/cue'

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

checkAtLeastOneTrack 选项

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

import { parse } from '@gplane/cue'

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

strictFileCommandPosition 选项

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

import { parse } from '@gplane/cue'

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

strictPerformerLength 选项

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

import { parse } from '@gplane/cue'

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

strictSongWriterLength 选项

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

import { parse } from '@gplane/cue'

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

strictTitleLength 选项

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

import { parse } from '@gplane/cue'

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

倾销

import { dump } from '@gplane/cue'

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

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

有一些限制:

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

lineBreak 选项

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

import { dump } from '@gplane/cue'

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

indentKind 选项

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

import { dump } from '@gplane/cue'

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

indentSize 选项

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

import { dump } from '@gplane/cue'

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

参考资料

许可证

MIT 许可证

版权(c)2021年至今

版本与发布记录

@gplane/cue 共发布 3 个版本,首次发布于 2023/04/01;过去 12 个月发布了 0 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.2.0latest2024/01/142 年前
0.1.12023/04/243 年前
0.1.02023/04/013 年前

关于 @gplane/cue 的常见问题

@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 和提交记录判断。