开发者文档已经迁移!请访问 https://www.popclip.app/dev/ 获取最新文档。
PopClip 扩展
本仓库包含了官方 PopClip 扩展目录 中发布的许多扩展的源文件。
仓库结构
主要文件夹:
source
- 已发布扩展的源文件(由我维护和支持)contrib
- 未发布/用户贡献/实验性/小众/归档扩展的文件夹(不维护或支持)
贡献
欢迎通过拉取请求对现有扩展进行修复和改进。
要向目录贡献新的扩展,首选方式是从您自己的仓库直接提交到目录服务器。扩展的目录页面将链接到您的仓库,您将自行维护和更新扩展。请联系我 mailto:support@pilotmoon.com 获取提交说明。
或者,可以通过在本仓库的 contrib
文件夹中提交拉取请求来提交新扩展。(如果我发布了它,我会自己将其移至 source
文件夹。)
质量指南
请注意,我不会发布所有提交的内容。要发布的扩展必须具有高质量,并满足以下标准:
- 扩展具有明确的单一目的,对广大用户有用。
- 扩展"开箱即用",只需用户进行最少的配置。
- 名称选择得当,符合其他扩展的命名风格。名称通常为一到两个词;例如 ✅"Instapaper",而不是 ❌"Send to Instapaper";✅"Uppercase" 而不是 ❌"Convert to Uppercase"。
- 一个好的图标,清晰地表示该操作。(如果您不是设计师,请使用 Iconify 或 SF Symbols。)
- 在配置中,有一个清晰、简洁的一句话
description
,描述扩展的功能。这将显示在网站上扩展名称旁边。 - 除了最简单的扩展外,包含一个
readme.md
文件,简要解释如何使用扩展,特别提及任何特殊功能和配置选项。在 readme 底部添加更新日志。 - 如需 API 密钥,应在 readme 中清楚地记录,并附上获取密钥的说明和链接。
- 不要使用无意义的脚本。例如,当您可以使用
url
操作时,不要使用 bash 脚本来打开 URL。 - 除非特定操作确实需要 shell 脚本或 AppleScript,否则优先选择 JavaScript 操作而不是 Shell 脚本或 AppleScript 操作。
- Shell 脚本扩展必须在最新 macOS 的默认安装上开箱即用。我不会发布需要用户安装额外脚本语言或库的扩展。
- 使用 Readme 来标注您作为作者的贡献,并确认任何其他贡献者、开源库或图标创作者。
- 不允许使用已编译的二进制文件。所有提交必须仅为源代码。
- 与网站或应用程序交互的扩展应在配置中包含
app
字典,定义name
和link
字段。名称将在扩展描述中自动链接。 - 对于与第三方 macOS 应用程序配合使用的扩展,还应使用带有
checkInstalled: true
选项的bundleIdentifiers
键。 - 不允许旨在规避版权、绕过付费墙等的扩展。
- 不允许链接到主要索引受版权保护内容的种子/文件共享网站。
- 不允许"回传"、收集用户数据或以任何方式修改用户系统的内容。
- 不允许任何非法、有害或您不愿向祖母展示的内容。
- 以上列表并非详尽无遗,我保留因任何其他原因拒绝提交的权利。
话虽如此...请提交您的扩展!我期待看到您的创意。
致谢
致谢信息包含在各个扩展的 readme 文件中。
许可
除非在扩展 readme 文件中另有说明,否则所有源代码均根据 MIT 许可证发布(LICENSE.txt)。
更新日志
各个扩展的更新日志包含在其 readme 文件中。