我正在为Assemble v0.6.0创建一个 nunjucks 插件。似乎它正在使用Template(我认为它以前称为Engine),它也为Verb提供动力。
我应该将插件称为“engine-nunjucks”、“template-nunjucks”、“assemble-plugin-nunjucks”、“assemble-nunjucks”吗?
我正在为Assemble v0.6.0创建一个 nunjucks 插件。似乎它正在使用Template(我认为它以前称为Engine),它也为Verb提供动力。
我应该将插件称为“engine-nunjucks”、“template-nunjucks”、“assemble-plugin-nunjucks”、“assemble-nunjucks”吗?
通过查看您的存储库,我认为engine-nunjucks
最适合您,因为您正在为template
. 这类似于我们已经拥有的engine-handlebars
, engine-lodash
, engine-less
, 。engine-assemble
动词、组装、模板可以在这里称重
不确定您是否注意到,但@doowb 是所有这些项目的共同创建者;)
这是一个很好的问题,我们已经开始记录即将发布的 v0.6.0 版本,但我们可能应该加紧努力并发布这些内容。
简短的回答
assemble-*
这是一个好方法。插件遵循 gulp 约定和样式指南。不要使用旧的 pre-v0.6.0 组装插件/中间件的命名约定。我们正在请求糟糕的命名决策之神赦免我们的这些罪过,以便我们继续前进(并弃用它们)。希望我们能度过难关engine-*
用于命名。代码方面,引擎在异步时遵循合并约定,在同步时遵循 [engines][1] 约定(基本上是在没有回调的情况下合并)。由于可以使用同步和异步方法发布引擎,engine-foo
因此可能总是一个不错的选择。helper-*
. 如果它需要特定的引擎,请在名称中使用引擎:handlebars-helper-*
. 如果需要组装,请命名assemble-helper-*
loader-*
. 如果它是特定于 assemble 的加载器,则使用assemble-loader-*
,或者如果它可以被任何实现 Template 的库使用,则使用template-loader-*
.我认为最重要的约定是在明确命名模块所关联的内容方面犯错,因此社区中的其他开发人员更容易找到。唯一的例外是实际的插件,因为我们试图坚持 gulp 约定(而不是做assemble-plugin-*
)