跳转到主要内容

Electron 的 API 文档作为结构化数据

·3 分钟阅读
zeke
zeke

今天，我们宣布对 Electron 的文档进行一些改进。现在，每个新版本都包含一个 JSON 文件，详细描述了 Electron 的所有公共 API。我们创建此文件是为了使开发人员能够以有趣的新方式使用 Electron 的 API 文档。

模式概述​

每个 API 都是一个对象，具有诸如名称、描述、类型等属性。诸如 BrowserWindow 和 Menu 之类的类具有额外的属性，用于描述它们的实例方法、实例属性、实例事件等。

以下是描述 BrowserWindow 类的模式摘录

{
  name: 'BrowserWindow',
  description: 'Create and control browser windows.',
  process: {
    main: true,
    renderer: false
  },
  type: 'Class',
  instanceName: 'win',
  slug: 'browser-window',
  websiteUrl: 'https://electron.js.cn/docs/api/browser-window',
  repoUrl: 'https://github.com/electron/electron/blob/v1.4.0/docs/api/browser-window.md',
  staticMethods: [...],
  instanceMethods: [...],
  instanceProperties: [...],
  instanceEvents: [...]
}

以下是一个方法描述的示例，在本例中是 apis.BrowserWindow.instanceMethods.setMaximumSize 实例方法

{
  name: 'setMaximumSize',
  signature: '(width, height)',
  description: 'Sets the maximum size of window to width and height.',
  parameters: [{
    name: 'width',
    type: 'Integer'
  }, {
    name: 'height',
    type: 'Integer'
  }]
}

使用新数据​

为了方便开发人员在其项目中使用此结构化数据，我们创建了 electron-docs-api，这是一个小的 npm 包，每当有新的 Electron 版本发布时，它都会自动发布。

npm install electron-api-docs --save

为了立即获得满足感，请在您的 Node.js REPL 中试用该模块

npm i -g trymodule && trymodule electron-api-docs=apis

如何收集数据​

Electron 的 API 文档遵循 Electron 编码风格 和 Electron 风格指南，因此其内容可以以编程方式解析。

electron-docs-linter 是 electron/electron 存储库的一个新的开发依赖项。它是一个命令行工具，用于检查所有 markdown 文件并强制执行风格指南的规则。如果发现错误，它们会被列出，并且发布过程会停止。如果 API 文档有效，则会创建 electron-json.api 文件，并作为 Electron 发布的一部分上传到 GitHub。

标准 JavaScript 和标准 Markdown​

今年早些时候，Electron 的代码库已更新为对所有 JavaScript 使用 standard linter。Standard 的 README 总结了此选择背后的原因

采用标准风格意味着将代码清晰度和社区约定置于个人风格之上。这对于 100% 的项目和开发文化可能没有意义，但是开源对于新手来说可能是一个充满敌意的地方。建立明确的、自动化的贡献者期望会使项目更健康。

我们最近还创建了 standard-markdown，以验证我们文档中的所有 JavaScript 代码段都是有效的，并且与代码库本身的风格一致。

这些工具共同帮助我们使用持续集成 (CI) 自动查找拉取请求中的错误。这减轻了人类进行代码审查的负担，并使我们对文档的准确性更有信心。

社区努力​

Electron 的文档在不断改进，我们要感谢我们出色的开源社区。截至撰写本文时，已有近 300 人为文档做出了贡献。

我们很高兴看到人们如何使用这种新的结构化数据。可能的用途包括