Konwencje nazewnictwa projektów Node.js dla plików i folderów

Jakie są konwencje nazewnictwa plików i folderów w dużym projekcie Node.js?

Powinienem używać wielkich liter, camelCase czy zaniżać punkty?

To znaczy. czy to jest uważane za ważne?

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

Po kilku latach z node, mogę powiedzieć, że nie ma żadnych konwencji dotyczących struktury katalogów / plików. Jednak większość (profesjonalnych) aplikacji ekspresowych używa konfiguracji takiej jak:

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

Przykładem używającym tej konfiguracji jest nodejs-starter .

Osobiście zmieniłem tę konfigurację na:

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

Moim zdaniem ten drugi lepiej pasuje do struktury katalogów w stylu uniksowym (podczas gdy ten pierwszy trochę to miesza).

Podoba mi się też ten wzorzec do oddzielania plików:

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

};

Pozwala to na dokładne oddzielenie całego kodu źródłowego bez konieczności przejmowania się zależnościami. Naprawdę dobre rozwiązanie do walki z okropnym Javascriptem. W pobliżu znajduje się przykład ze świata rzeczywistego, który korzysta z tej konfiguracji.

Aktualizacja (nazwy plików):

Dotyczące nazwy plików są najczęściej krótkie , małe nazwy plików. Jeśli plik można opisać tylko dwoma słowami, większość projektów JavaScript używa znaku podkreślenia jako separatora.

Aktualizacja (zmienne):

W odniesieniu do zmiennych obowiązują te same „zasady”, jak w przypadku nazw plików. Prototypy lub klasy powinny jednak używać camelCase .

Aktualizacja (przewodniki stylistyczne):

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

Użyj kebab-casedla wszystkich nazw pakietów, folderów i plików.

Czemu?

Powinieneś sobie wyobrazić, że dowolny folder lub plik może pewnego dnia zostać rozpakowany do własnego pakietu. Pakiety nie mogą zawierać wielkich liter.

Nowe pakiety nie mogą mieć w nazwie wielkich liter. https://docs.npmjs.com/files/package.json#name

Dlatego camelCasenigdy nie należy go używać. To pozostawia snake_casei kebab-case.

kebab-casejest obecnie zdecydowanie najpowszechniejszą konwencją. Jedyne użycie podkreślenia dotyczy pakietów węzłów wewnętrznych i jest to po prostu konwencja z wczesnych dni.

Nie ma żadnych konwencji. Istnieje pewna logiczna struktura.

Jedyne, co mogę powiedzieć: nigdy nie używaj nazw plików i katalogów camelCase. Czemu? Działa, ale na komputerach Mac i Windows nie ma różnicy między niektórymi akcjami a niektórymi akcjami. Spotkałem się z tym problemem i to nie raz. Potrzebowałbym takiego pliku:

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

Ale niestety ja utworzony plik z pełnym małymi literami: lib/ishidden.js. U mnie zadziałało na Macu. Działało dobrze na komputerze Mac mojego współpracownika. Testy przebiegają bez błędów. Po wdrożeniu otrzymaliśmy ogromny błąd:

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

O tak. To linux box. Więc struktura katalogów camelCase może być niebezpieczna. To wystarczy koledze, który tworzy program na Windows lub Mac.

Więc jeśli potrzebujesz, użyj separatora podkreślenia (_) lub myślnika (-).

Na podstawie „ Przewodnika po stylach Google JavaScript ”

Nazwy plików muszą być pisane małymi literami i mogą zawierać podkreślenia (_) lub myślniki (-), ale nie mogą zawierać dodatkowych znaków interpunkcyjnych. Postępuj zgodnie z konwencją używaną w Twoim projekcie. Nazwy plików muszą mieć rozszerzenie .js.

Większość ludzi używa camelCasew JS. Jeśli chcesz cokolwiek open-source, proponuję użyć tego :-)

Node.js nie wymusza żadnych konwencji nazewnictwa plików (z wyjątkiem index.js). I ogólnie język Javascript też nie. Znajdziesz tutaj dziesiątki wątków sugerujących camelCase, łączniki i podkreślenia, z których każdy działa doskonale. Więc to zależy od Ciebie. Wybierz jeden i trzymaj się go.

Według mnie: w przypadku plików używaj małej wielkości wielbłąda, jeśli module.exports jest obiektem, mam na myśli moduł singleton. Dotyczy to również plików JSON, ponieważ są one również w pewnym sensie jedną toną. Użyj wielkich liter wielbłąda, jeśli module.exports zwraca funkcję konstruktora, w której zachowuje się jak klasa.

W przypadku folderów użyj krótkich nazw. Jeśli potrzeba wielu słów, niech będą one całkowicie małe i oddzielone znakiem „-”, aby działało spójnie na wszystkich platformach.