版本：v3

创建 Capacitor 插件

Capacitor 中的插件使 JavaScript 能够直接与原生 API 交互。

本指南将帮助你开始创建一个可共享的 Capacitor 插件，并将其发布到 npm。你也可以创建仅用于你应用的 Capacitor 插件。请参阅 iOS 和 Android 的自定义原生代码指南。

理念

如果你的插件面向公众，我们在你开始之前分享一些关于 Capacitor 插件的理念。

我们相信合作比竞争更能产生高质量的插件。这是我们创建 Capacitor Community GitHub 组织的原因之一，与插件托管在个人仓库相比，这促进了社区中更轻松的合作。

如果 Capacitor Community 中已存在某个主题的插件，请考虑为其做出贡献！如果某个插件缺少主要维护者，Capacitor 团队很乐意考虑将你添加到 GitHub 组织中。

我们相信 Capacitor 插件的范围应该保持适度小巧。Capacitor 插件会向应用中添加可能使用也可能不使用的原生代码。通过保持插件范围小巧，我们可以确保应用只包含最必要的原生代码。这避免了不必要的应用臃肿，以及因缺少使用说明等 API 问题导致的 App Store 警告或拒绝。

当然，范围小巧还能带来其他好处，例如更快的部署、更轻松的合作、更好的可维护性等。

Capacitor 插件应努力在跨平台间提供统一的体验，并且对 JavaScript 开发者来说感觉自然。这意味着可能需要对来自原生平台的值进行转换。

以下是一些指导原则和示例，展示如何创建统一且地道的体验：

优先使用 undefined 而非 null 和其他非值。 例如：如果 Android API 返回 0.0 表示"无值"，则应将值转换为 undefined 再传递给 JavaScript 层。
优先使用相同的单位。 例如：如果 iOS API 使用摄氏度而 Android API 使用华氏度，则应在值到达 JavaScript 消费者之前将其统一为其中一种。
优先使用带时区的 ISO 8601 日期时间格式，而非其他格式。 例如：从 "2020-12-13T20:21:58.415Z" 这样的字符串可以轻松获取准确的 JavaScript Date 对象，但如果给定 Unix 时间戳（JavaScript 时间戳以毫秒为单位），则会令人困惑。始终包含时区，否则日期时间可能会因不同地区而被错误解析。

准备开始了吗？Capacitor 有一个插件生成器，你可以使用它来开始开发你的插件。

在继续之前，你可能需要确保使用的是最新的 Node LTS 版本和 npm 6+。

在一个新的终端中，运行以下命令：

npm init @capacitor/plugin

生成器会提示你输入信息。你也可以提供命令行选项（请参阅 GitHub 仓库）。