Namenskonventionen für Node.js-Projekte für Dateien und Ordner

Was sind die Namenskonventionen für Dateien und Ordner in einem großen Node.js-Projekt?

Soll ich groß schreiben, camelCase oder unterschätzen?

Dh. Wird dies als gültig angesehen?

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

Nach einigen Jahren mit Node kann ich sagen, dass es keine Konventionen für die Verzeichnis- / Dateistruktur gibt. Die meisten (professionellen) Express-Anwendungen verwenden jedoch ein Setup wie:

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

Ein Beispiel, das dieses Setup verwendet, ist nodejs-Starter .

Ich persönlich habe dieses Setup geändert in:

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

Meiner Meinung nach passt Letzteres besser zur Unix-ähnlichen Verzeichnisstruktur (während Ersteres dies ein wenig durcheinander bringt).

Ich mag dieses Muster auch, um Dateien zu trennen:

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

};

Dies ermöglicht eine saubere Entkopplung des gesamten Quellcodes, ohne sich um Abhängigkeiten kümmern zu müssen. Eine wirklich gute Lösung, um böses Javascript zu bekämpfen. Ein reales Beispiel ist in der Nähe , das dieses Setup verwendet.

Update (Dateinamen):

In Bezug auf Dateinamen am häufigsten sind kurz , Klein Kleindateinamen.Wenn Ihre Datei nur mit zwei Wörtern beschrieben werden kann, verwenden die meisten JavaScript-Projekte einen Unterstrich als Trennzeichen.

Update (Variablen):

In Bezug auf Variablen gelten die gleichen "Regeln" wie für Dateinamen. Prototypen oder Klassen sollten jedoch camelCase verwenden .

Update (Styleguides):

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

Verwenden kebab-case für alle Paket-, Ordner- und Dateinamen.

Warum?

Sie sollten sich vorstellen, dass ein Ordner oder eine Datei eines Tages in ein eigenes Paket extrahiert werden könnte. Pakete dürfen keine Großbuchstaben enthalten.

Neue Pakete dürfen keine Großbuchstaben im Namen enthalten. https://docs.npmjs.com/files/package.json#name

Daher camelCasesollte niemals verwendet werden. Dies lässt snake_caseund kebab-case.

kebab-caseist heute bei weitem die häufigste Konvention. Unterstriche werden nur für interne Knotenpakete verwendet, und dies ist einfach eine Konvention von Anfang an.

Es gibt keine Konventionen. Es gibt einige logische Strukturen.

Das einzige, was ich sagen kann: Verwenden Sie niemals camelCase-Datei- und Verzeichnisnamen. Warum? Es funktioniert, aber unter Mac und Windows gibt es keinen Unterschied zwischen someAction und some action. Ich bin diesem Problem begegnet und nicht ein einziges Mal. Ich benötige eine Datei wie diese:

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

Leider habe ich eine Datei mit Kleinbuchstaben erstellt : lib/ishidden.js. Es hat bei mir auf dem Mac funktioniert. Auf dem Mac meines Kollegen hat es gut funktioniert. Tests laufen ohne Fehler. Nach der Bereitstellung haben wir einen großen Fehler erhalten:

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

Oh ja. Es ist eine Linux-Box. Die Verzeichnisstruktur von camelCase kann daher gefährlich sein. Es ist genug für einen Kollegen, der unter Windows oder Mac entwickelt.

Verwenden Sie daher bei Bedarf einen Unterstrich (_) oder einen Bindestrich (-).

Basierend auf ' Google JavaScript Style Guide '

Dateinamen müssen in Kleinbuchstaben geschrieben sein und dürfen Unterstriche (_) oder Bindestriche (-) enthalten, jedoch keine zusätzliche Interpunktion. Befolgen Sie die Konvention, die Ihr Projekt verwendet. Die Dateinamenerweiterung muss .js sein.

Die meisten Leute verwenden camelCasein JS. Wenn Sie etwas als Open Source veröffentlichen möchten, empfehle ich Ihnen, dieses zu verwenden :-)

Node.js erzwingt keine Dateinamenskonventionen (außer index.js). Und die Javascript-Sprache im Allgemeinen auch nicht. Hier finden Sie Dutzende von Threads, die auf camelCase, Bindestriche und Unterstriche hinweisen, von denen jeder perfekt funktioniert. Es liegt also an Ihnen. Wählen Sie eine und bleiben Sie dabei.

Meiner Meinung nach: Verwenden Sie für Dateien Kleinbuchstaben, wenn module.exports ein Objekt ist, ich meine ein Singleton-Modul. Dies gilt auch für JSON-Dateien, da sie ebenfalls in einer Tonne vorliegen. Verwenden Sie Großbuchstaben, wenn module.exports eine Konstruktorfunktion zurückgibt, die sich wie eine Klasse verhält.

Verwenden Sie für Ordner Kurznamen. Wenn mehrere Wörter erforderlich sind, lassen Sie es vollständig durch "-" getrennt, damit es auf allen Plattformen konsistent funktioniert.