跳到主要内容

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

·阅读 4 分钟
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 代码检查器。Standard 的 README 总结了做出此选择的原因

采用标准风格意味着将代码清晰度和社区惯例的重要性置于个人风格之上。这可能不适用于 100% 的项目和开发文化，但开源对于新手来说可能是一个不太友好的地方。建立清晰、自动化的贡献者期望会使项目更健康。

我们最近还创建了 standard-markdown，以验证我们文档中所有 JavaScript 代码片段的有效性以及与代码库自身风格的一致性。

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

社区贡献​

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

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