Conventions de dénomination des projets Node.js pour les fichiers et dossiers

Quelles sont les conventions de dénomination des fichiers et des dossiers dans un grand projet Node.js?

Dois-je capitaliser, camelCase ou sous-score?

C'est à dire. est-ce considéré comme valide?

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

Après quelques années avec node, je peux dire qu'il n'y a pas de conventions pour la structure répertoire / fichier. Cependant, la plupart des applications express (professionnelles) utilisent une configuration telle que:

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

Un exemple qui utilise cette configuration est nodejs-starter .

J'ai personnellement changé cette configuration en:

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

À mon avis, ce dernier correspond mieux à la structure de répertoires de style Unix (alors que le premier mélange un peu cela).

J'aime aussi ce modèle pour séparer les fichiers:

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

};

Cela permet de découpler parfaitement tout le code source sans avoir à déranger les dépendances. Une très bonne solution pour lutter contre le mauvais Javascript. Un exemple du monde réel est à proximité qui utilise cette configuration.

Mise à jour (noms de fichiers):

En ce qui concerne les noms de fichiers , les noms de fichiers courts et minuscules sont les plus courants . Si votre fichier ne peut être décrit qu'avec deux mots, la plupart des projets JavaScript utilisent un trait de soulignement comme délimiteur.

Mise à jour (variables):

Concernant les variables, les mêmes «règles» s'appliquent que pour les noms de fichiers. Cependant, les prototypes ou les classes doivent utiliser camelCase .

Mise à jour (guides de style):

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

À utiliser kebab-casepour tous les noms de package, de dossier et de fichier.

Pourquoi?

Vous devriez imaginer que n'importe quel dossier ou fichier pourrait être extrait un jour dans son propre package. Les packages ne peuvent pas contenir de lettres majuscules.

Les nouveaux packages ne doivent pas comporter de lettres majuscules dans le nom. https://docs.npmjs.com/files/package.json#name

Par conséquent, camelCasene doit jamais être utilisé. Cela laisse snake_caseet kebab-case.

kebab-caseest de loin la convention la plus courante aujourd'hui. La seule utilisation des traits de soulignement concerne les packages de nœuds internes, et il s'agit simplement d'une convention des premiers jours.

Il n'y a pas de conventions. Il existe une structure logique.

La seule chose que je puisse dire: n'utilisez jamais de noms de fichiers et de répertoires camelCase. Pourquoi? Cela fonctionne mais sur Mac et Windows, il n'y a pas de différence entre someAction et certaines actions. J'ai rencontré ce problème, et pas une seule fois. J'ai besoin d'un fichier comme celui-ci:

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

Mais malheureusement , je créé un fichier avec plein de minuscules: lib/ishidden.js. Cela a fonctionné pour moi sur mac. Cela a bien fonctionné sur le mac de mon collègue. Les tests s'exécutent sans erreur. Après le déploiement, nous avons eu une énorme erreur:

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

Oh oui. C'est une boîte Linux. La structure des répertoires de camelCase peut donc être dangereuse. C'est suffisant pour un collègue qui développe sous Windows ou Mac.

Utilisez donc le séparateur de soulignement (_) ou de tiret (-) si vous en avez besoin.

Basé sur " Google JavaScript Style Guide "

Les noms de fichiers doivent être tous en minuscules et peuvent inclure des traits de soulignement (_) ou des tirets (-), mais pas de ponctuation supplémentaire. Suivez la convention utilisée par votre projet. L'extension des noms de fichiers doit être .js.

La plupart des gens utilisent camelCasedans JS. Si vous souhaitez ouvrir quelque chose en open-source, je vous suggère d'utiliser celui-ci :-)

Node.js n'applique aucune convention de dénomination de fichier (sauf index.js). Et le langage Javascript en général non plus. Vous pouvez trouver des dizaines de fils ici qui suggèrent camelCase, traits d'union et traits de soulignement, qui fonctionnent parfaitement bien. C'est à vous de répondre. Choisissez-en un et respectez-le.

Selon moi: pour les fichiers, utilisez la casse inférieure du chameau si module.exports est un objet, je veux dire un module singleton. Cela s'applique également aux fichiers JSON car ils sont également d'une seule tonne. Utilisez la casse supérieure du camel si module.exports renvoie une fonction constructeur où elle agit comme une classe.

Pour les dossiers, utilisez des noms courts. S'il est nécessaire d'avoir plusieurs mots, laissez-les complètement en minuscules séparés par "-" afin que cela fonctionne de manière cohérente sur toutes les plates-formes.