Dosyalar ve klasörler için Node.js projesi adlandırma kuralları

Büyük bir Node.js projesindeki dosyalar ve klasörler için adlandırma kuralları nelerdir?

Büyük harf mi kullanmalıyım, camelCase mi yoksa alt puan mı almalıyım?

Yani. bu geçerli kabul edilir mi?

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

Düğümle birkaç yıl geçirdikten sonra , dizin / dosya yapısı için herhangi bir konvansiyonun olmadığını söyleyebilirim . Ancak çoğu (profesyonel) ekspres uygulama aşağıdaki gibi bir kurulum kullanır:

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

Bu kurulumu kullanan bir örnek nodejs-starter'dır .

Bu kurulumu kişisel olarak şu şekilde değiştirdim:

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

Kanımca, ikincisi Unix tarzı dizin yapısıyla daha iyi eşleşiyor (oysa eski bunu biraz karıştırıyor).

Dosyaları ayırmak için bu kalıbı da seviyorum:

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

};

Bu, bağımlılıkları rahatsız etmeden tüm kaynak kodunun düzgün bir şekilde ayrıştırılmasına izin verir. Kötü Javascript ile savaşmak için gerçekten iyi bir çözüm. Yakında bu kurulumu kullanan gerçek dünya örneği var .

Güncelleme (dosya adları):

Dosya adlarıyla ilgili olarak en yaygın olanı kısa , küçük harfli dosya adlarıdır. Dosyanız yalnızca iki kelimeyle açıklanabiliyorsa, çoğu JavaScript projesi sınırlayıcı olarak bir alt çizgi kullanır.

Güncelleme (değişkenler):

Değişkenlerle ilgili olarak, dosya adlarıyla aynı "kurallar" geçerlidir. Ancak prototipler veya sınıflar camelCase kullanmalıdır .

Güncelleme (stil kılavuzları):

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

kebab-caseTüm paket, klasör ve dosya adları için kullanın .

Neden?

Herhangi bir klasör veya dosyanın bir gün kendi paketine çıkarılabileceğini hayal etmelisiniz. Paketler büyük harf içeremez.

Yeni paketlerin adında büyük harf olmamalıdır. https://docs.npmjs.com/files/package.json#name

Bu nedenle camelCaseasla kullanılmamalıdır. Bu bırakır snake_caseve kebab-case.

kebab-casebugün açık farkla en yaygın sözleşmedir. Alt çizgilerin tek kullanımı dahili düğüm paketleri içindir ve bu sadece ilk günlerden kalma bir kuraldır.

Konvansiyon yok. Bazı mantıksal yapılar var.

Söyleyebileceğim tek şey: CamelCase dosya ve dizin adlarını asla kullanmayın. Neden? Çalışır, ancak Mac ve Windows'ta bazıAction ve bazı eylemler arasında fark yoktur. Bu problemle bir kez karşılaşmadım. Bunun gibi bir dosyaya ihtiyacım var:

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

Ama ne yazık ki ben küçük harf dolu olan bir dosya oluşturuldu: lib/ishidden.js. Mac'te benim için çalıştı. İş arkadaşımın Mac'inde iyi çalıştı. Testler hatasız çalışır. Dağıtımdan sonra büyük bir hata aldık:

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

Ah evet. Bu bir linux kutusu. Bu nedenle camelCase dizin yapısı tehlikeli olabilir. Windows veya Mac'te geliştirme yapan bir meslektaş için yeterli.

Bu nedenle, gerekirse alt çizgi (_) veya kısa çizgi (-) ayırıcı kullanın.

" Google JavaScript Stil Kılavuzu " na göre

Dosya adlarının tümü küçük harf olmalıdır ve alt çizgi (_) veya kısa çizgi (-) içerebilir, ancak ek noktalama işareti içeremez. Projenizin kullandığı kuralı izleyin. Dosya adlarının uzantısı .js olmalıdır.

Çoğu insan camelCaseJS'de kullanır . Herhangi bir şeyi açık kaynak yapmak istiyorsanız, bunu kullanmanızı öneririm :-)

Node.js herhangi bir dosya adlandırma kuralını (hariç index.js) zorlamaz . Ve genel olarak Javascript dili de değil. Burada camelCase, tire ve alt çizgi öneren düzinelerce ileti dizisi bulabilirsiniz ve bunlardan herhangi biri mükemmel şekilde işe yarar. Bu size kalmış. Birini seçin ve ona bağlı kalın.

Bana göre: Eğer module.exports bir nesne ise, dosyalar için daha düşük deve durumunu kullanın, yani singleton modülü kastediyorum. Bu aynı zamanda JSON dosyaları için de geçerlidir, çünkü bunlar da tek tondur. Module.exports bir sınıf gibi davrandığı bir yapıcı işlevi döndürürse, üst deve durumunu kullanın.

Klasörler için kısa isimler kullanın. Birden fazla kelimeye ihtiyaç varsa, tüm platformlarda tutarlı bir şekilde çalışması için "-" ile birbirinden tamamen küçük harflerle ayrılmış olmasına izin verin.