Convenciones de nomenclatura de proyectos de Node.js para archivos y carpetas

¿Cuáles son las convenciones de nomenclatura para archivos y carpetas en un proyecto grande de Node.js?

¿Debo usar mayúsculas, camelCase o subvalorar?

Es decir. ¿Esto se considera válido?

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

Después de algunos años con el nodo, puedo decir que no hay convenciones para la estructura de directorios / archivos. Sin embargo, la mayoría de las aplicaciones express (profesionales) utilizan una configuración como:

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

Un ejemplo que usa esta configuración es nodejs-starter .

Personalmente cambié esta configuración a:

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

En mi opinión, el último encaja mejor con la estructura de directorios estilo Unix (mientras que el primero mezcla esto un poco).

También me gusta este patrón para separar archivos:

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

};

Esto permite desacoplar perfectamente todo el código fuente sin tener que molestar a las dependencias. Una muy buena solución para luchar contra el desagradable Javascript. Un ejemplo del mundo real está cerca que usa esta configuración.

Actualizar (nombres de archivo):

En cuanto a los nombres de archivo, los más comunes son los nombres de archivo cortos y en minúsculas . Si su archivo solo se puede describir con dos palabras, la mayoría de los proyectos de JavaScript utilizan un guión bajo como delimitador.

Actualización (variables):

En cuanto a las variables, se aplican las mismas "reglas" que para los nombres de archivo. Los prototipos o clases, sin embargo, deben usar camelCase .

Actualización (guías de estilo):

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

Úselo kebab-casepara todos los nombres de paquetes, carpetas y archivos.

¿Por qué?

Debe imaginarse que algún día cualquier carpeta o archivo podría extraerse a su propio paquete. Los paquetes no pueden contener letras mayúsculas.

Los paquetes nuevos no deben tener letras mayúsculas en el nombre. https://docs.npmjs.com/files/package.json#name

Por lo tanto, camelCasenunca debe usarse. Esto deja snake_casey kebab-case.

kebab-casees, con mucho, la convención más común en la actualidad. El único uso de guiones bajos es para paquetes de nodos internos, y esto es simplemente una convención de los primeros días.

No hay convenciones. Hay alguna estructura lógica.

Lo único que puedo decir: nunca use nombres de directorio y archivo camelCase. ¿Por qué? Funciona, pero en Mac y Windows no hay diferencias entre alguna acción y alguna acción. Me encontré con este problema, y ​​ni una sola vez. Necesito un archivo como este:

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

Pero, lamentablemente, he creado un archivo con lleno de minúsculas: lib/ishidden.js. Funcionó para mí en mac. Funcionó bien en mac de mi compañero de trabajo. Las pruebas se ejecutan sin errores. Después de la implementación, obtuvimos un gran error:

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

Oh si. Es una caja de Linux. Así que la estructura de directorios de camelCase podría ser peligrosa. Es suficiente para un colega que está desarrollando en Windows o Mac.

Por lo tanto, use un guión bajo (_) o un guión (-) como separador si lo necesita.

Basado en la " Guía de estilo de JavaScript de Google "

Los nombres de los archivos deben estar todos en minúsculas y pueden incluir guiones bajos (_) o guiones (-), pero sin puntuación adicional. Siga la convención que usa su proyecto. La extensión de los nombres de archivo debe ser .js.

La mayoría de la gente usa camelCaseen JS. Si desea abrir cualquier código, le sugiero que use este :-)

Node.js no aplica ningún convenio de nomenclatura de archivos (excepto index.js). Y el lenguaje Javascript en general tampoco. Puede encontrar docenas de hilos aquí que sugieren camelCase, guiones y guiones bajos, cualquiera de los cuales funciona perfectamente bien. Eso depende de ti. Elija uno y apéguese a él.

Según yo: para archivos, use minúsculas camel si module.exports es un objeto, me refiero a un módulo singleton. Esto también se aplica a los archivos JSON, ya que también son de una sola tonelada. Use mayúsculas y minúsculas si module.exports devuelve una función de constructor donde actúa como una clase.

Para carpetas, use nombres cortos. Si es necesario tener varias palabras, déjelas en minúsculas separadas por "-" para que funcione en todas las plataformas de manera consistente.