@ barmark/ cli (英语)
这个 barmark 命令:检查、格式、部件、渲染、转接、导出和导入
标记 和弦图.chart.md 文档) a
终端或CI。 运行一样 barmark 翻译和 @barmark/render
变形为barmark.dev @barmark/musicxml 用于MusicXML,精确
版本,所以一个图表在任何地方都意味着同样的东西.
安装
与节点20.6或后:
npx @barmark/cli check . # run once
npm install --save-dev @barmark/cli # or keep it in a project
没有节点,请从中下载您的系统的二进制
GitHub 发布
(单位:千美元)barmark-linux-x64, (中文(简体) ), barmark-linux-arm64, (中文(简体) ), barmark-darwin-x64, (中文(简体) ),
barmark-darwin-arm64, (中文(简体) ), barmark-windows-x64.exe) (中文(简体) ). 二进制不是
尚未签名; 在 macOS 上, 在第一次运行前清除下载标记 :
chmod +x barmark-darwin-arm64
xattr -d com.apple.quarantine barmark-darwin-arm64
图标
文件夹表示每个 *.chart.md 中文件, 跳过 node_modules, (中文(简体) ),
点字和相通. - 从stdin读取.
barmark check songs # errors and warnings, file:line
barmark export --musicxml song.chart.md --out song.musicxml # for MuseScore, Dorico…
barmark import song.musicxml --out song.chart.md # or a compressed song.mxl
barmark check --strict --format github songs # warnings fail too; PR annotations
barmark format song.chart.md # print it in standard form
barmark format --write songs # rewrite the files that change
barmark format --check songs # list them and fail, for CI
barmark part Bass song.chart.md # one part of a chart of several
barmark render song.chart.md --out song.html # a standalone page, font included
barmark transpose song.chart.md --to E # or --semitones -2
check --format json 打印其他工具的诊断. render
以渲染器的选项为旗帜 : --theme auto|light|dark, (中文(简体) ),
--numerals nashville|roman, (中文(简体) ), --no-bar-numbers, (中文(简体) ), --rehearsal-letters, (中文(简体) ),
--no-wrap, (中文(简体) ), --diagnostics, (中文(简体) ), --part <label> 绘制一部分 --font-url <url> 链接字体
而不是嵌入它. barmark <command> --help 列出每个命令的
旗帜; barmark --version 打印 CLI 及其版本
图书馆.
export --musicxml 写 MusicXML 4.0 标记程序打开并
按图表顺序播放; --part <label> 出口一部分。 图表
不导出出出错。 无标题的图表取其文件名 .
import 读取 MusicXML 分数(.musicxml, (中文(简体) ), .xml 或压缩 .mxl(中文(简体) )
作为图表。 图表不能结转的东西 列出在stderr,一行
各项,作为 check 打印其结论 : song.mxl: measure 12 (Piano): warning: message (该措施在电文列出
(b) 衡量标准本身. --part <name> 联合国
部分名称、缩写或 id, 忽略大小写和标出) 导入
仅此一部分,其注解为注解。 当一张图表出来时,它从0出口,
即使警告,或警告,或警告者 .mxl 情况很糟 没有
读取 stdin.
退出代码
| 代码 | 含义 |
|---|---|
| 0 个 | 完成(允许发出警告,除非 --strict(中文(简体) ) |
| 1个 | 图表有问题:错误,警告 --strict,或文件 format --check 将会改变 |
| 2个 | 命令被错误使用: 未知的旗帜、 缺失或无法读取的文件 |
在CI语中
- uses: actions/setup-node@v4
with:
node-version: 22
- run: npx -y @barmark/[email protected] check --strict --format github songs
- run: npx -y @barmark/[email protected] format --check songs
键入版本:新版本可以不同读取图表,并被绑住 版本将它变成一个调取请求,你审查.
许可证
麻省理工学院. render 嵌入爱德温 @barmark/render sIL下的船只
打开字体许可证( O)fonts/OFL.txt 在那里;二进制的释放带它
作为 Edwin-OFL.txt) (中文(简体) ).