Quy ước đặt tên dự án Node.js cho tệp & thư mục

Quy ước đặt tên cho các tệp và thư mục trong một dự án Node.js lớn là gì?

Tôi nên viết hoa, camelCase, hay điểm dưới?

I E. điều này có được coi là hợp lệ không?

project-name
    app
        controllers
            someThings.js
            users.js
        models
                someThing.js
                user.js
        views
            some-things
                index.jade
            users
                logIn.jade
                signUp.jade
    ...

Sau một số năm sử dụng nút, tôi có thể nói rằng không có quy ước nào cho cấu trúc thư mục / tệp. Tuy nhiên, hầu hết các ứng dụng express (chuyên nghiệp) sử dụng thiết lập như:

/
  /bin - scripts, helpers, binaries
  /lib - your application
  /config - your configuration
  /public - your public files
  /test - your tests

Một ví dụ sử dụng thiết lập này là nodejs-starter .

Cá nhân tôi đã thay đổi thiết lập này thành:

/
  /etc - contains configuration
  /app - front-end javascript files
    /config - loads config
    /models - loads models
  /bin - helper scripts
  /lib - back-end express files
    /config - loads config to app.settings
    /models - loads mongoose models
    /routes - sets up app.get('..')...
  /srv - contains public files
  /usr - contains templates
  /test - contains test files

Theo ý kiến ​​của tôi, cái sau phù hợp hơn với cấu trúc thư mục kiểu Unix (trong khi cái trước kết hợp điều này một chút).

Tôi cũng thích mẫu này để tách các tệp:

lib / index.js

var http = require('http');
var express = require('express');

var app = express();

app.server = http.createServer(app);

require('./config')(app);

require('./models')(app);

require('./routes')(app);

app.server.listen(app.settings.port);

module.exports = app;

lib / static / index.js

var express = require('express');

module.exports = function(app) {

  app.use(express.static(app.settings.static.path));

};

Điều này cho phép phân tách gọn gàng tất cả mã nguồn mà không phải bận tâm đến các phần phụ thuộc. Một giải pháp thực sự tốt để chống lại Javascript khó chịu. Một ví dụ trong thế giới thực ở gần đây đó sử dụng thiết lập này.

Cập nhật (tên tệp):

Về tên tệp, thông thường nhất là viết thường , ngắn tên tệp . Nếu tệp của bạn chỉ có thể được mô tả bằng hai từ, hầu hết các dự án JavaScript sử dụng dấu gạch dưới làm dấu phân cách.

Cập nhật (biến):

Về các biến, các "quy tắc" tương tự cũng được áp dụng như đối với tên tệp. Tuy nhiên, các nguyên mẫu hoặc lớp nên sử dụng camelCase .

Cập nhật (styleguides):

• https://github.com/feross/standard
• https://github.com/airbnb/javascript

Sử dụng kebab-casecho tất cả các gói, thư mục và tên tệp.

Tại sao?

Bạn nên tưởng tượng rằng một ngày nào đó bất kỳ thư mục hoặc tệp nào cũng có thể được giải nén vào gói của chính nó. Các gói không được chứa chữ hoa.

Các gói mới không được có chữ hoa trong tên. https://docs.npmjs.com/files/package.json#name

Do đó, camelCasekhông bao giờ được sử dụng. Điều này để lại snake_casevà kebab-case.

kebab-casecho đến nay là quy ước phổ biến nhất hiện nay. Việc sử dụng duy nhất của dấu gạch dưới là cho các gói nút bên trong và đây chỉ đơn giản là một quy ước từ những ngày đầu.

Không có quy ước. Có một số cấu trúc hợp lý.

Điều duy nhất tôi có thể nói: Không bao giờ sử dụng tên tệp và thư mục camelCase. Tại sao? Nó hoạt động nhưng trên Mac và Windows không có sự khác biệt giữa someAction và một số action. Tôi đã gặp vấn đề này, và không phải một lần. Tôi yêu cầu một tệp như thế này:

var isHidden = require('./lib/isHidden');

Nhưng thật đáng buồn tôi đã tạo ra một tập tin với đầy đủ các chữ thường: lib/ishidden.js. Nó làm việc cho tôi trên mac. Nó hoạt động tốt trên mac của đồng nghiệp của tôi. Các thử nghiệm chạy không có lỗi. Sau khi triển khai, chúng tôi gặp một lỗi lớn:

Error: Cannot find module './lib/isHidden'

Ồ vâng. Đó là một hộp linux. Vì vậy, cấu trúc thư mục camelCase có thể nguy hiểm. Nó đủ cho một đồng nghiệp đang phát triển trên Windows hoặc Mac.

Vì vậy, hãy sử dụng dấu gạch dưới (_) hoặc dấu gạch ngang (-) nếu bạn cần.

Dựa trên ' Hướng dẫn Kiểu JavaScript của Google '

Tất cả tên tệp phải là chữ thường và có thể bao gồm dấu gạch dưới (_) hoặc dấu gạch ngang (-), nhưng không có dấu câu bổ sung. Tuân theo quy ước mà dự án của bạn sử dụng. Phần mở rộng của tên tệp phải là .js.

Hầu hết mọi người sử dụng camelCasetrong JS. Nếu bạn muốn mở bất cứ thứ gì nguồn mở, tôi khuyên bạn nên sử dụng cái này :-)

Node.js không thực thi bất kỳ quy ước đặt tên tệp nào (ngoại trừ index.js). Và ngôn ngữ Javascript nói chung cũng vậy. Bạn có thể tìm thấy hàng tá chủ đề ở đây đề xuất camelCase, dấu gạch ngang và dấu gạch dưới, bất kỳ chuỗi nào hoạt động hoàn toàn tốt. Vì vậy, nó vào bạn. Chọn một cái và gắn bó với nó.

Theo tôi: Đối với tệp, hãy sử dụng trường hợp camel thấp hơn nếu module.exports là một đối tượng, ý tôi là một mô-đun singleton. Điều này cũng có thể áp dụng cho các tệp JSON vì chúng cũng theo một cách riêng lẻ. Sử dụng chữ hoa camel trên nếu module.exports trả về một hàm khởi tạo trong đó nó hoạt động giống như một lớp.

Đối với các thư mục sử dụng tên ngắn. Nếu cần phải có nhiều từ, hãy viết chữ thường hoàn toàn được phân tách bằng "-" để nó hoạt động nhất quán trên tất cả các nền tảng.