Node.js проект іменування файлів і папок

Які умови іменування файлів і папок у великому проекті Node.js?

Чи слід використовувати великі літери, camelCase чи недооцінку?

Тобто чи вважається це дійсним?

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

Через кілька років з вузлом, я можу сказати , що не існує жодної конвенції для структури каталогів / файлів. Однак більшість (професійних) експрес-програм використовують такі налаштування:

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

Приклад, який використовує цю настройку, - nodejs-starter .

Я особисто змінив цю налаштування на:

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

На мій погляд, останній краще відповідає структурі каталогу директорій у стилі Unix (тоді як перший трохи змішує це).

Мені також подобається, що цей візерунок розділяє файли:

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

};

Це дозволяє акуратно розв’язати весь вихідний код, не турбуючи залежності. Дійсно гарне рішення для боротьби з противними Javascript. Реальний приклад поруч , який використовує цю установку.

Оновлення (імена файлів):

Що стосується імен файлів, найпоширеніші - короткі , малі імена файлів. Якщо ваш файл можна описати лише двома словами, більшість проектів JavaScript використовують підкреслення як роздільник.

Оновлення (змінні):

Щодо змінних, то такі ж "правила" застосовуються, як і для імен файлів. Проте прототипи або класи повинні використовувати camelCase .

Оновлення (керівники стилів):

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

Використовувати kebab-caseдля всіх назв пакета, папки та файлів.

Чому?

Ви можете собі уявити, що будь-яку папку чи файл можна витягнути до власного пакета в якийсь день. Пакети не можуть містити великі літери.

Нові пакети не повинні мати великих літер у назві. https://docs.npmjs.com/files/package.json#name

Тому camelCaseніколи не слід використовувати. Це залишає snake_caseі kebab-case.

kebab-caseна сьогоднішній день є найбільш поширеною умовою сьогодні. Єдине використання підкреслення лише для внутрішніх пакетів вузлів, і це просто умова з перших днів.

Конвенцій немає. Є якась логічна структура.

Єдине, що я можу сказати: Ніколи не використовуйте назви файлів і каталогів camelCase. Чому? Він працює, але на Mac і Windows немає різниці між деякими діями та деякими діями. Я зустрів цю проблему, і не один раз. Мені потрібен такий файл:

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

Але , до жаль , я створив файл з повним малими літерами: lib/ishidden.js. Це працювало для мене на mac. Це добре спрацювало на mac мого колеги. Тести працюють без помилок. Після розгортання ми отримали величезну помилку:

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

О так. Це linux box. Тож структура каталогів camelCase може бути небезпечною. Досить колезі, який розробляє Windows або Mac.

Тому використовуйте роздільник підкреслення (_) або тире (-), якщо вам потрібно.

На основі " Посібника зі стилю Google JavaScript "

Імена файлів мають бути малими літерами і можуть містити підкреслення (_) або тире (-), але без додаткових розділових знаків. Дотримуйтесь конвенції, яку використовує ваш проект. Розширення імен файлів повинно бути .js.

Більшість людей використовують camelCaseу JS. Якщо ви хочете щось відкрити, пропоную вам скористатися цим :-)

Node.js не застосовує жодних умов іменування файлів (крім index.js). І мова Javascript взагалі теж не є. Тут ви можете знайти десятки ниток, які пропонують camelCase, дефіси та підкреслення, будь-яка з яких працює чудово. Тож саме від вас залежить. Виберіть один і дотримуйтесь його.

По-моєму: для файлів використовуйте нижній регістр верблюда, якщо module.exports є об'єктом, я маю на увазі однотонний модуль. Це також стосується файлів JSON, оскільки вони також є в тоні одним тоном. Використовуйте верхній регістр верблюда, якщо module.exports повертає функцію конструктора там, де він діє як клас.

Для папок використовуйте короткі імена. Якщо вам потрібно мати кілька слів, нехай це повністю нижній регістр розділяється на "-", щоб він працював на всіх платформах послідовно.