quy tắc đặt tên tác vụ grunt tùy chỉnh

Question

Có quy ước nào về việc đặt tên các tác vụ grunt tùy chỉnh bao gồm nhiều từ không? Ví dụ: grunt-json-schema plugin grunt có json_schema task. Một tên bao gồm dấu gạch ngang (-), tên còn lại bao gồm dấu gạch dưới (_).

Rõ ràng, tiêu tan-tên không thể được sử dụng như một chìa khóa đối tượng JavaScript:

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

họ phải được kèm theo trong dấu ngoặc kép:

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

Tôi đã kiểm tra tất cả các plugin chính thức (grunt-contrib-*) nhưng tất cả chúng chỉ bao gồm một từ. Động cơ thúc đẩy câu hỏi này rất đơn giản: tôi chỉ muốn theo các quy ước.

Answer 1

Câu trả lời ngắn: Tên tác vụ trình cắm/tùy chỉnh không phải tương quan với tên đối tượng cấu hình cụ thể.

Api Grunt.js cho phép truy cập đối tượng cấu hình bằng cách sử dụng methodgrunt.config. Công việc & Plugin có quyền truy cập vào toàn bộ đối tượng, không chỉ đối tượng phụ tương quan với tên.

Ví dụ, tôi có thể tạo ra một nhiệm vụ gọi foo mà truy cập vào cấu hình từ bar:

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

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

nhất thực hành: phát triển Plugin nên đặt tên chìa khóa cho đối tượng cấu hình của họ tương tự như tên plugin riêng của mình. Điều này giúp giảm thiểu xung đột với các plugin khác có thể tham chiếu tương tự.

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

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

Answer 2

Tôi nghĩ quy ước chung là sử dụng camelCase cho các tác vụ bao gồm nhiều từ.