archbelt

用于处理阿基兰蓝图和氙码模块的工具；主要用于版本控制系统和CI/CD。

特性

以下特性处于开发中

• 将蓝图中的代码作为 .xc 文件提取
• 将蓝图复制到当前位置以进行打包
• 初始化版本控制
• Shell 完成提示

使用方法

A tool to work with Archean blueprints and XenonCode modules

Usage: archbelt [COMMAND]

Commands:
  yank      Yank code files from a blueprint
  watch     watch for changes to blueprint file(s); will yank on change as if -f is set
  package   Gather metadata and files from blueprint for packaging
  info      Display information about the blueprint
  complete  Generate shell completion for zsh & bash
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

提取

注意，[BLUEPRINT]... 是不带 .json 扩展名的蓝图名称，且不带引号。这将使用游戏保存中保存的蓝图的确切名称，让您在保存之前使用 Ctrl-C 复制名称，然后将其粘贴到命令行中。

Yank code files from a blueprint

Usage: archbelt yank [OPTIONS] [BLUEPRINT]...

Arguments:
  [BLUEPRINT]...  name of the blueprint without .json

Options:
      --blueprint-path <PATH>  path to blueprints folder
  -x, --no-collate             do not collate the files by component
  -f, --folder                 yank blueprint files to folder named after blueprint
  -w, --watch                  watch for changes to the blueprint; yanks files on change; assumes -f
  -h, --help                   Print help

监视

注意，[TARGET]... 是不带 .json 扩展名的蓝图名称，且不带引号。这将使用游戏保存中保存的蓝图的确切名称，让您在保存之前使用 Ctrl-C 复制名称，然后将其粘贴到命令行中。

watch for changes to blueprint file(s); will yank on change as if -f is set

Usage: archbelt watch [OPTIONS] [TARGET]...

Arguments:
  [TARGET]...  target blueprint name (if none given, watches all)

Options:
      --blueprint-path <PATH>  path to blueprints folder
  -x, --no-collate             do not collate the files by component (use at own risk; this can get very messy..)
  -h, --help                   Print help

打包

主要用于将事物组合成有利于打包分发或版本控制的文件夹结构。这将创建一个以蓝图命名的文件夹，并将所有的 xc 文件放入其中。它还将创建一个包含蓝图元数据的 archbelt.json 文件，并将其与蓝图 json 的副本一起放置。

这将把所有内容放在您运行命令的文件夹中；例如 - archbelt package example 将创建一个名为 example 的文件夹，一个名为 archbelt.json 的文件，以及当前目录中的蓝图 .json 文件副本。然后，它将把蓝图中的所有 xc 文件放入 example 文件夹中。

这仍然是一个正在进行中的项目，且 archbelt.json 的格式可能发生变化。

Gather metadata and files from blueprint for packaging

Usage: archbelt package [OPTIONS] [BLUEPRINT]...

Arguments:
  [BLUEPRINT]...  name of the blueprint without .json

Options:
      --blueprint-path <PATH>  path to blueprints folder
  -h, --help                   Print help

信息

输出有关环境的通用信息。目前这里没有太多信息。

Display information about the blueprint

Usage: archbelt info [OPTIONS]

Options:
      --blueprint-path <PATH>  path to blueprints folder
  -h, --help                   Print help

Shell 完成提示

archbelt complete --help
Generate shell completion for zsh & bash

Usage: archbelt complete [OPTIONS]

Options:
      --shell <target>  [possible values: bash, elvish, fish, powershell, zsh]
  -h, --help            Print help

已知问题

• 在用 yank 或 watch 创建文件时，archbelt 会为蓝图中的每个具有硬盘的组件创建一个文件夹。如果有别名，它将使用该别名作为文件夹名称；如果没有，它将使用模块类型的名称。这意味着如果有多个计算机，它们都将保存在 ARCHEAN_computer 文件夹中。这可能会导致文件被覆盖。