组装模板插件的命名约定是什么？

Question

我为Assemble v0.6.0创建了一个nunjucks插件。它似乎正在使用Template（我认为之前称之为Engine），它也支持Verb。

我应该调用插件＆＃34; engine-nunjucks＆＃34;，＆＃34; template-nunjucks＆＃34;，＆＃34; assemble-plugin-nunjucks＆＃34;，＆＃34;汇编 - nunjucks＆＃34 ;?

Answer 1

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

Answer 2

  

动词，汇编，模板可以在这里权衡

不确定您是否注意到，但@doowb是所有这些项目的共同创建者;）

这是一个很好的问题，我们已经开始记录未来的v0.6.0版本，但我们应该踩油门并发布这些内容。

简短回答

• 如果它是一个插件（如gulp插件）那么assemble-*是一个很好的方法。插件遵循gulp约定和样式指南。不要通过旧的pre-v0.6.0汇编插件/中间件的命名约定。我们要求那些命名不好的神灵让我们解除这些罪恶，这样我们就可以继续前进（并弃用它们）。希望我们能够超越
• 如果是引擎，则使用engine-*进行命名。代码方面，引擎在异步时遵循合并约定，并且在同步时遵循[引擎] [1]约定（这基本上是在没有回调的情况下合并）。由于可以使用同步和异步方法发布引擎，engine-foo可能总是一个不错的选择。
• 如果它是帮手并且它是通用的，请使用helper-*。如果需要特定引擎，请使用名称为handlebars-helper-*的引擎。如果需要汇编，请将其命名为assemble-helper-*
• 如果是加载程序，请使用loader-*。如果它是一个特定于汇编的加载器，那么使用assemble-loader-*，或者如果它可以被任何实现模板的库使用，那么使用template-loader-*。

我认为最重要的惯例是错误地明确命名与模块相关联的内容，因此社区中的其他开发人员更容易找到它。唯一的例外是实际的插件，因为我们试图坚持gulp约定（而不是做assemble-plugin-*）