跳转到主要内容

API 历史记录功能介绍 (GSoC 2024)

·8 分钟阅读
piotrpdev
piotrpdev

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

你好 👋，我是 Peter，2024 年 Google Summer of Code (GSoC) 的 Electron 贡献者。

在 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（到主分支的根 PR），而不是像提案中那样硬编码版本字符串。

这可以作为单一事实来源，然后可以用来推导出确切的版本号，并且如果更改被反向移植到其他分支，则主分支上不需要进一步的文档更改。”

— 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

与原型基本相同。最显著的补充是使用了 语义版本 范围，选择此范围是为了更好地传达功能存在的版本（感谢 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 历史进行 linting 的脚本。
      • 有用的错误消息
      • 全面的文档/代码注释
      • 广泛的 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

    • React 表格组件，用于在文档网站上显示已解析的 API 历史数据。
      • 使用的样式遵循网站其余部分的设计。
      • 响应式、可访问性强、通常编写良好的 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 团队的其他成员，感谢他们回答我的问题并抽出时间对我的拉取请求提供反馈。我非常感谢。