CoE CLI 开发文档（已弃用）

2024-10-16

备注

CoE CLI 已被弃用，并且将在未来版本中被删除。使用 Power Platform 项目安装向导来设置和管理您的 ALM Accelerator for Power Platform 项目。

文档是了解 CLI 工作原理的关键。添加新命令时，请考虑参考以下文档：

添加 Markdown 页面 - 描述面向最终用户的功能。
录制命令行以演示该过程。

添加 Markdown 页面

向帮助添加新页面，描述新命令并向用户解释预期用法。

考虑向页面中添加以下内容：

汇总操作的静态图像。
录制命令行以演示该过程。

图表

对于决策树，图表是通过 mermaid 生成的。

示例图表：

图表样式

设置图表 sample.mmd 的样式。

使用子组样式。

graph
    subgraph journey[Journey]
      start(Start) --> finish(Finish Here)
    end

    style journey fill:transparent,stroke:green,stroke-width:2px

对同一文件夹中的文件应用 CSS 样式。例如，在上面的示例中，在与 mmd 文件相同的文件夹中创建 sample.css。

#L-start-finish path {
   stroke: red
}

注释

查看节点形状以控制显示的符号。
可以使用以下方法对圆圈进行样式设置。

graph TD
   subgraph Journey
      start(Start Here) ---> finish((End Here))
   end

要使用 css 将结尾圆圈着色为绿色，从选择器开始。这是必需的，因为每个项都将具有 mermaid 分配的唯一 ID。

[id^=flowchart-finish] circle {
   stroke: green;
   fill: lightgreen
}

为行着色。 path 中每个行的格式为 L-start-finish，即行和类 .path，它是围绕箭头的行。

#L-start-finsh path,
#L-start-finsh .path
 {
   stroke: green;
}

更新图表

每个图表的静态图像按如下方式生成。

转到 coe-cli 文件夹。

cd coe-cli

生成静态文件。

npm run diagrams

添加帮助页面

向帮助添加新帮助页面。帮助中的每个页面提供有关命令和选项的详细信息。可以使用 help 命令访问帮助 Markdown 文件，该命令将在控制台窗口中显示相关的帮助 Markdown 文件。

coe help alm

上面的命令将显示帮助的内容。

记录命令行

要包含演示预期输出的命令的简短动画记录，您可以使用以下过程。

在基于 Unix 的终端中安装 termtosvg。

pip3 install --user termtosvg

此流程将跨平台运行，可以使用以下任何选项：

macOS 或 Linux 发行版本上的本机 Unix shell。
带有 Unix shell 的 Docker 映像。
适用于 Windows 上的 Linux 的 Windows 子系统。

将会话记录到转换文件。

termtosvg record test.cast

生成的转换文件是一个简单的文本文件，可以使用任何文本编辑器进行编辑。

使用 term-trim.ps1 删除暂停。

./term-trim.ps1 -Input test.cast -Output test2.cast -Trim 1

生成 svg 文件。

termtosvg render test2.cast test.svg -t window_frame

通过