javascript - 自定义 grunt 任务命名约定

Question

关于命名包含多个单词的自定义 grunt 任务是否有任何约定？例如:grunt-json-schema grunt 插件有 json_schema task .一个名称包含破折号 (-)，另一个名称包含下划线 (_)。

显然，dashed-name 不能用作 JavaScript 对象键:

grunt.initConfig({
    json-schema: { // WON'T work

它们必须用引号引起来:

grunt.initConfig({
    'json-schema': { // will work

我检查了所有官方插件(grunt-contrib-*)，但它们都只有一个词。这个问题的动机很简单:我只是想遵循惯例。

Answer 1

简答:插件/自定义任务名称不必与特定的配置对象名称相关联。

Grunt.js api 允许使用 method 访问配置对象grunt.config。任务和插件可以访问整个对象，而不仅仅是与名称相关的子对象。

例如，我可以创建一个名为 foo 的任务，它从 bar 访问配置:

grunt.initConfig({
    bar: {
        baz: true
    }
});

grunt.registerTask('foo', 'example custom task', function () {
    var config = grunt.config('bar');
    grunt.log.ok(config);
});

最佳实践:插件开发人员应该将其配置对象的 key 命名为类似于插件名称本身。这有助于减轻与其他可能引用类似插件的冲突。

grunt.initConfig({
    foo: {
        baz: true
    }
});

grunt.registerTask('foo', 'example custom task', function () {
    var config = grunt.config('foo');
    grunt.log.ok(config);
});