如何轻松驾驭 Venera 配置，无需额外折腾
我最近偶然发现了 venera-configs 仓库。如果你关注开源自动化工具或自定义客户端应用的开发，你可能听说过 Venera。这类项目的问题往往是相同的：当你需要快速为任务创建配置时，你要么只能猜测属性名，要么得深入研究应用的源代码。
venera-configs 的作者选择了最简单的方式，提供了一个简单但功能完善的管理设置的结构。
这对开发者意味着什么
随着项目规模扩大，把所有设置都记在脑子里变得不可能。更糟糕的是，当你一个月后再打开配置文件时，你已经记不清哪些字段是必需的，哪些是可选的。这个仓库实现了我在个人项目中经常使用的方法：用 JS 文件代替静态的 JSON 或 YAML。
这给了你两个巨大的优势。首先，你可以在配置中直接使用逻辑。其次，也是这里最重要的，团队添加了一个用于 IDE 自动补全的辅助文件。不再需要从文档中复制粘贴参数名了。
仓库里有什么
项目结构极其精简。根目录下有两个关键文件，作为创建自己配置的基础：
_template_.js— 这是你未来配置的骨干。它已经包含了注释，解释每个部分负责什么。_venera_.js— 一个技术文件，向你的开发环境（VS Code、WebStorm 等）"提示"应用期望的数据类型。
有趣的是，作者没有费心构建复杂的 CLI 工具来生成文件。设置过程看起来非常老派，简单得令人耳目一新。
如何在几分钟内构建你的配置
如果你决定尝试一下，这是工作流程：
- 将
_template_.js和_venera_.js放入你的工作目录。重要的是它们要放在一起。 - 将模板重命名为你自己的名字，例如
my-cool-setup.js。 - 在你喜欢的编辑器中打开它并开始编辑。
多亏了 _venera_.js，你的 IDE 将开始提供自动补全建议。当你需要快速配置 Venera 应用中的解析或路由时，这真的节省了很多时间。
技术细节和观察
这个项目使用纯 JavaScript 编写。这是一个合理的选择：无需编译，没有复杂的依赖。你只需要编写导出包含设置的对象的代码。
这个仓库现在有超过 700 颗星，对于一个简单的配置集来说相当多了。这表明主要的 Venera 应用有一个活跃的社区。不过请记住，这里的 README 非常简洁。如果你从未运行过 Venera 应用本身，即使有注释，理解模板中特定字段的用途也会很困难。
我注意到仓库里大约有 60 个未解决的 issue。这看起来可能令人担忧，但对于与各种外部服务配置相关的项目来说，这是正常的情况——API 会变化，配置会失效，人们会请求更新。
谁应该关注这个仓库
首先是那些已经在使用 Venera 并且厌倦了手动编辑文件而没有提示的人。这也是一个很好的例子，展示了如何在不切换到 TypeScript 的情况下为 JS 配置组织"类型"——只需通过 JSDoc 和辅助定义文件。
如果你计划通过这个平台自动化一些任务，venera-configs 将成为你的主要入口。我建议从研究 _template_.js 开始——那里的注释可以替代官方文档的一大半。
应该把这个用到生产环境吗？仓库正在活跃更新（最近的提交非常频繁），所以这个项目是活跃的。但要做好准备，某些参数可能会在没有任何警告的情况下发生变化——这就是在使用活跃开发的开源工具的配置时需要面对的现实。
相关项目