Konvensi penamaan proyek Node.js untuk file & folder

Apa konvensi penamaan untuk file dan folder dalam proyek Node.js yang besar?

Haruskah saya memanfaatkan, camelCase, atau under-score?

Yaitu. apakah ini dianggap valid?

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

Setelah beberapa tahun dengan node, saya dapat mengatakan bahwa tidak ada konvensi untuk struktur direktori / file. Namun kebanyakan aplikasi ekspres (profesional) menggunakan pengaturan seperti:

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

Contoh yang menggunakan penyiapan ini adalah nodejs-starter .

Saya pribadi mengubah pengaturan ini menjadi:

/
  /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

Menurut pendapat saya, yang terakhir lebih cocok dengan struktur direktori bergaya Unix (sedangkan yang pertama mencampurkannya sedikit).

Saya juga menyukai pola ini untuk memisahkan file:

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));

};

Hal ini memungkinkan pemisahan semua kode sumber dengan rapi tanpa harus mengganggu dependensi. Solusi yang sangat bagus untuk melawan Javascript yang buruk. Contoh dunia nyata ada di dekatnya yang menggunakan penyiapan ini.

Perbarui (nama file):

Mengenai nama file yang paling umum adalah nama file pendek dan huruf kecil . Jika file Anda hanya dapat dideskripsikan dengan dua kata, sebagian besar proyek JavaScript menggunakan garis bawah sebagai pemisah.

Perbarui (variabel):

Mengenai variabel, "aturan" yang sama berlaku untuk nama file. Prototipe atau kelas, bagaimanapun, harus menggunakan camelCase .

Perbarui (styleguides):

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

Gunakan kebab-caseuntuk semua nama paket, folder dan file.

Mengapa?

Anda harus membayangkan bahwa folder atau file apa pun mungkin diekstrak ke paketnya sendiri suatu hari nanti. Paket tidak boleh berisi huruf besar.

Paket baru tidak boleh memiliki huruf besar di namanya. https://docs.npmjs.com/files/package.json#name

Oleh karena itu, camelCasesebaiknya jangan pernah digunakan. Daun ini snake_casedan kebab-case.

kebab-casesejauh ini merupakan konvensi paling umum saat ini. Satu-satunya penggunaan garis bawah adalah untuk paket node internal, dan ini hanyalah konvensi dari masa-masa awal.

Tidak ada konvensi. Ada beberapa struktur logis.

Satu-satunya hal yang dapat saya katakan: Jangan pernah menggunakan file camelCase dan nama direktori. Mengapa? Ini berfungsi tetapi di Mac dan Windows tidak ada perbedaan antara someAction dan some action. Saya menemui masalah ini, dan tidak sekali pun. Saya membutuhkan file seperti ini:

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

Tapi sayangnya saya buat file dengan penuh huruf kecil: lib/ishidden.js. Ini berhasil untuk saya di mac. Ini bekerja dengan baik di Mac rekan kerja saya. Tes berjalan tanpa kesalahan. Setelah penerapan, kami mendapat kesalahan besar:

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

Oh ya. Ini kotak linux. Jadi struktur direktori camelCase bisa berbahaya. Ini cukup untuk kolega yang mengembangkan di Windows atau Mac.

Jadi gunakan pemisah garis bawah (_) atau tanda hubung (-) jika Anda perlu.

Berdasarkan ' Panduan Gaya JavaScript Google '

Nama file harus semuanya huruf kecil dan dapat menyertakan garis bawah (_) atau tanda hubung (-), tetapi tidak ada tanda baca tambahan. Ikuti konvensi yang digunakan proyek Anda. Ekstensi nama file harus .js.

Kebanyakan orang menggunakan camelCaseJS. Jika Anda ingin membuat sesuatu menjadi open-source, saya sarankan Anda menggunakan yang ini :-)

Node.js tidak memberlakukan konvensi penamaan file apa pun (kecuali index.js). Dan bahasa Javascript secara umum juga tidak. Anda dapat menemukan lusinan utas di sini yang menyarankan camelCase, tanda hubung, dan garis bawah, yang semuanya berfungsi dengan baik. Jadi terserah kamu. Pilih satu dan pertahankan.

Menurut saya: Untuk file, gunakan huruf kecil jika module.exports adalah objek, maksud saya modul tunggal. Ini juga berlaku untuk file JSON karena mereka juga satu ton. Gunakan huruf besar unta jika module.exports mengembalikan fungsi konstruktor yang bertindak seperti kelas.

Untuk folder gunakan nama pendek. Jika ada kebutuhan untuk memiliki lebih dari satu kata, biarkan itu dipisahkan dengan huruf kecil sepenuhnya oleh "-" agar berfungsi di semua platform secara konsisten.