跳到主要内容

引入 API 历史 (GSoC 2024)

·7 分钟阅读
piotrpdev
piotrpdev

Electron API 的历史更改现在将在文档中详细说明。

嗨 👋，我是 Peter，Electron 的 2024 年 Google 编程之夏 (GSoC) 贡献者。

在 GSoC 计划期间，我为 Electron 文档及其函数、类等实现了一个 API 历史记录功能，类似于 Node.js 文档：允许在 API 文档 Markdown 文件中使用简单但功能强大的 YAML 模式，并在 Electron 文档网站上很好地显示它。

详细信息​

API 历史文档系统/YAML 模式​

在 Markdown API 文档中，函数/类等的历史记录现在直接放置在该项的标题之后，形式为 HTML 注释封装的 YAML 代码块。

#### `win.setTrafficLightPosition(position)` _macOS_

<!--
```YAML history
added:
  - pr-url: https://github.com/electron/electron/pull/22533
changes:
  - pr-url: https://github.com/electron/electron/pull/26789
    description: "Made `trafficLightPosition` option work for `customButtonOnHover` window."
deprecated:
  - pr-url: https://github.com/electron/electron/pull/37094
    breaking-changes-header: deprecated-browserwindowsettrafficlightpositionposition
```
-->

* `position` [Point](structures/point.md)

Set a custom position for the traffic light buttons. Can only be used with `titleBarStyle` set to `hidden`.

我认为像 Node.js 文档那样使用 YAML 是最佳方法，因为它易于阅读。API 历史记录不是非常复杂，理想情况下应该尽可能易于编写和阅读。

上面显示的最终设计实际上与我提出的设计有很大不同

<!--
```YAML history
added: v10.0.0
deprecated: v25.0.0
removed: v28.0.0
changes:
  - version: v13.0.0
    pr-url: https://github.com/electron/electron/pull/26789
    description: Made `trafficLightPosition` option work for `customButtonOnHover` window.
```
-->

一个很大的变化是删除了版本号

“[...] 我们想指出关于该提案的一个稍微重要的变化，这是在审查提案时讨论中提出的。[...]

[我们] 决定采用 [最少] 缺点的方案是仅使用 PR URL（指向 main 的根 PR），而不是像提案中那样硬编码的版本字符串。

这可以作为单一的真理来源，然后可以用于推导出准确的版本号，并且如果更改被反向移植到其他分支，则无需在 main 上进行进一步的文档更改。”

— David Sanders (@dsanders11) 通过 Slack

我们也没有在 API 历史记录中包含删除，因为当 API 从 Electron 中删除时，它也会从文档中删除。

JavaScript 实现​

我最初计划创建一个新的 @electron/docs-api-history-tools npm 包，其中包含用于提取、验证/lint 和转换文档文件中 API 历史记录的脚本。

在编码期开始前大约一周，在与我的导师进行了一些讨论后，我意识到这可能是不必要的

“大家好，我在我们的小组讨论后思考了这个项目：考虑到提取逻辑必须在 e/website 和 e/lint-roller 中因其依赖项而进行不同的处理，也许没有必要为 API 历史记录内容设置单独的包？”

提议修订
proposedrevised

— Piotr Płaczek（我）通过 Slack

我们最终决定不进行我最初的想法

“@Piotr Płaczek 我觉得这很好！我认为如果我们发现无论如何我们需要在两个实现之间共享大量代码，我们总是可以在以后的迭代中重构为一个单独的模块🙂"

— Erick Zhao (@erickzhao) 通过 Slack

相反，我们将这些不同的工具分配到与它们最相关的 Electron 仓库中

Electron 文档网站的 UI 和样式​

我最初提出使用一个简单的表格来显示 API 历史数据

设计原型（关闭）设计原型（打开）
demo1demo2

这是最终实现的设计的样子

demo3

与原型几乎相同。最重要的补充是使用了 SemVer 范围，选择它是为了更好地传达功能存在于哪些版本中（感谢 Samuel Attard (@MarshallOfSound) 的建议！）。

这很重要，因为更改经常在支持的 Electron 发布线之间进行反向移植，例如，修复可能会进入 Electron v32.0.0、v31.1.0 和 v30.2.0。这意味着它不存在于 v31.0.0 中，用户可能会根据它存在于 v30.x.x 版本中而错误地推断出来。

使用/风格指南​

我添加了一个专门用于为新功能编写 API 历史文档的使用/风格指南。我详细描述了 YAML 模式的正确用法，提供了典型/有用的示例等。您可以在这里找到它。

迁移指南​

由于现有的 API 必须迁移到新的文档系统，我创建了一个迁移指南。它介绍了开发人员在迁移旧 API 时必须执行的典型步骤：查看破坏性更改、浏览过去的版本、可能查看旧的提交等。然后指导开发人员遵循使用/风格指南，为每个先前存在的类/函数等添加 API 历史文档。

遗憾的是，我没有想到一种有效实现自动化的方法。这可能是一个 AI/ML 工程师的绝佳任务；但是，我不具备这些技能，并且太害怕不小心将幻觉引入 API 历史中。即使自动化了，最终信息可能仍然需要人工验证😕。这项任务可能必须逐个文件手动完成，就像为 Node.js 文档所做的那样。

交付物​

  • api-history.schema.json

  • lint-markdown-api-history.ts

    • 用于根据自定义 YAML（技术上是 JSON）模式检查 YAML API 历史的脚本。
      • 有用的错误消息
      • 全面的文档/代码注释
      • 广泛的 Jest Vitest 测试
      • 良好的性能
    • 在以下位置实施：electron/lint-roller#73
    • 在以下位置使用：electron/electron#42982

  • preprocess-api-history.ts

    • 执行简单的验证，以防止不正确的 API 历史进入存储库。还删除了包裹 API 历史块的 HTML 注释标签，因为 Docusaurus 无法解析它们。
    • 在以下位置实施/使用：electron/website#594

  • transformers/api-history.ts

    • 用于将 Markdown 文档文件中的 YAML API 历史块转换为 Markdown/HTML React 表格 (ApiHistoryTable.tsx) 的脚本。
    • 在以下位置实施/使用：electron/website#594

  • ApiHistoryTable.tsx

    • 用于在文档网站上显示已解析的 API 历史数据的 React 表格组件。
      • 使用的样式遵循网站其余部分的设计。
      • 响应式、可访问且通常编写良好的 HTML、CSS 和 JS。
    • 在以下位置实施/使用：electron/website#594

  • styleguide.md

    • 新的 API 历史文档系统的使用/风格指南部分。
      • 易于理解
      • 编写良好
      • 包含示例
    • 在以下位置实施/使用：electron/electron#42982

  • api-history-migration-guide.md

    • 新的 API 历史文档系统的迁移指南。
      • 易于理解
      • 编写良好
      • 包含示例
    • 在以下位置实施/使用：electron/electron#42982

结论​

我非常喜欢开发这个功能，并且从代码审查和与团队讨论其各种实现细节中获得了宝贵的经验。

我相信，在文档中添加 API 历史将使使用 Electron 的开发人员的生活更加轻松，特别是那些试图将现有应用程序从几年前的 Electron 版本迁移的开发人员。

我也要衷心感谢我的导师

...以及 Electron 团队的其他成员，感谢他们回答我的问题并花时间对我的拉取请求提供反馈。非常感谢。