Benutzerdefinierte Grunt Aufgabe Benennungskonvention

Question

Gibt es eine Konvention in Bezug auf die Benennung von benutzerdefinierten Grunt Aufgaben, die mehr als ein Wort enthalten? Zum Beispiel: grunt-json-schema grunt plugin hat json_schema task. Ein Name enthält Bindestriche (-), der andere enthält Unterstriche (_).

Offensichtlich strichName kann nicht als JavaScript-Objekt-Schlüssel verwendet werden:

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

sie in Anführungszeichen eingeschlossen werden:

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

Ich habe alle offiziellen Plugins (grunt-contrib-*) aber sie bestehen alle aus nur einem Wort. Die Motivation für diese Frage ist einfach: Ich möchte nur Konventionen befolgen.

Answer 1

Kurze Antwort: Plug-in/benutzerdefinierte Aufgabennamen müssen nicht mit einem bestimmten Konfigurationsobjektnamen korrelieren.

Die Grunt.js-API ermöglicht den Zugriff auf das Konfigurationsobjekt unter Verwendung der methodgrunt.config. Aufgaben & Plugins haben Zugriff auf das gesamte Objekt, nicht nur auf das Unterobjekt, das mit dem Namen korreliert.

Zum Beispiel könnte ich eine Aufgabe namens erstellen foo, die die Konfiguration von bar greift:

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

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

Best Practice: Plugin-Entwickler sollten die Schlüssel für ihr Config Objekt ähnlich den Plugin-Namen selbst nennen. Dies hilft Konflikte mit anderen Plugins zu mildern, die ähnliche Referenzen haben könnten.

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

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

Answer 2

Ich denke, die allgemeine Konvention camelCase für Aufgaben zu verwenden, die aus mehreren Wörtern bestehen.