组装模板插件的命名规范是什么？

Question

我正在为Assemble v0.6.0创建一个nunjucks插件。看起来它正在使用Template（我认为以前称为Engine），这也支持Verb。

我应该将插件命名为"engine-nunjucks"、"template-nunjucks"、"assemble-plugin-nunjucks"还是"assemble-nunjucks"？

- airtonix

Answer 1

从查看您的代码库，我认为engine-nunjucks最适合您，因为您正在创建一个用于template的渲染引擎。这类似于我们已经有的engine-handlebars, engine-lodash, engine-less和engine-assemble。

- doowb

---

那是我的第一个猜测，但 Engine 已经不存在了。我希望 Verb、Assemble、Template 的创建者能够参与并开始制定 Assemble、Template 和 Verb 命名约定的官方指南。 - airtonix

抱歉，@dwoob，出了点小问题。 - airtonix

Answer 2

动词，组装，模板可以在这里发挥作用

不知道你是否注意到，@doowb是所有这些项目的共同创建者；）

这是一个好问题，我们已经开始记录即将发布的v0.6.0版本，但我们可能应该加快速度并发布这些内容。

简短回答

• 如果它是一个插件（例如gulp插件），那么assemble-*是一个很好的选择。插件遵循gulp惯例和样式指南。不要按照旧的v0.6.0之前的assemble插件/中间件命名约定进行命名。我们请求不好的命名决策之神原谅我们这些罪孽，这样我们就可以继续前进（并弃用它们）。希望我们能够克服这一点。
• 如果它是一个引擎，则使用engine-*进行命名。从代码上看，引擎遵循consolidate约定，当异步时，遵循[engines][1]约定，当同步时（基本上只是没有回调的整合）。由于引擎可以使用同步和异步方法发布，因此engine-foo可能总是一个不错的选择。
• 如果它是一个帮助程序并且是通用的，请使用helper-*。如果需要特定引擎，请在名称中使用引擎：handlebars-helper-*。如果需要组装，请将其命名为assemble-helper-*
• 如果它是一个加载器，请使用loader-*。如果它是特定于组装的加载器，则使用assemble-loader-*，或者如果它可以被实现Template的任何库使用，则使用template-loader-*。

我认为最重要的约定是在明确命名模块所关联的内容方面犯错误，这样其他开发人员就可以更容易地找到它们。唯一的例外是实际插件，因为我们试图遵循gulp惯例（而不是执行assemble-plugin-*）

- jonschlinkert

---

这是一个足够好的起点，可以直接转储到关于此主题的文档中。 - airtonix

我希望至少能够开始着手处理它。这让我更加清晰地思考了一些问题，谢谢！ - jonschlinkert