Соглашения об именах проектов Node.js для файлов и папок

Каковы соглашения об именах файлов и папок в большом проекте Node.js?

Должен ли я использовать заглавные буквы, верблюжий случай или занижение?

Т.е. это считается действительным?

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

После нескольких лет работы с node я могу сказать, что нет никаких соглашений о структуре каталогов / файлов. Однако большинство (профессиональных) экспресс-приложений используют такие настройки, как:

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

Библиотека / статический / 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 нет разницы между someAction и some action. Встречался с этой проблемой, и не раз. Мне нужен такой файл:

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

Но , к сожалению , я создал файл с полным строчными буквами: lib/ishidden.js. У меня это сработало на Mac. Он отлично работал на Mac моего коллеги. Тесты проходят без ошибок. После развертывания мы получили огромную ошибку:

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

О да. Это Linux-бокс. Таким образом, структура каталогов camelCase может быть опасной. Этого достаточно для коллеги, который занимается разработкой на Windows или Mac.

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

На основе " Руководства по стилю Google JavaScript "

Имена файлов должны быть в нижнем регистре и могут включать подчеркивание (_) или дефис (-), но без дополнительных знаков препинания. Следуйте соглашению, которое использует ваш проект. Расширение имен файлов должно быть .js.

Большинство людей используют camelCaseJS. Если вы хотите что-нибудь с открытым исходным кодом, я предлагаю вам использовать это :-)

Node.js не применяет никаких соглашений об именах файлов (кроме index.js). И язык Javascript в целом тоже. Здесь вы можете найти десятки тем, которые предлагают верблюжий регистр, дефисы и подчеркивания, любой из которых отлично работает. Так что решать вам. Выберите один и придерживайтесь его.

По моему мнению: для файлов используйте нижний регистр верблюда, если module.exports является объектом, я имею в виду одноэлементный модуль. Это также применимо к файлам JSON, поскольку они тоже в некотором смысле тонны. Используйте верхний регистр верблюда, если module.exports возвращает функцию-конструктор, где он действует как класс.

Для папок используйте короткие названия. Если необходимо использовать несколько слов, пусть они будут полностью строчными, разделенными знаком «-», чтобы это работало на всех платформах единообразно.