Node.js — одна из самых популярных платформ. Хотя начать работу над проектами Node.js легко, как только вы выйдете за рамки базовых приложений, знание того, как лучше всего структурировать свой код и как справляться с ошибками, может стать сложным.
Вот несколько рекомендаций, которые помогут поддерживать ваш проект Node.js в нужном русле.
Запуск проектов с помощью npm init
Создание нового проекта с использованием npm init
приведет к созданию нового package.json
, который позволит вам добавить метаданные, чтобы помочь другим, работающим над проектом, с такими же настройками, как у вас.
$ mkdir my-project
$ cd my-project
$ npm init
Настройка .npmrc
Флаг - -save
обновляет package.json
зависимостью. Когда другие разработчики клонируют проект, благодаря этому флагу они знают, что у них правильные зависимости.
NPM также добавляет начальный знак вставки ^
во все версии. Следовательно, когда кто-то запускает npm install
, он может получить разные версии модулей, чем у вас. Хотя обновление модулей всегда является хорошей практикой, наличие группы разработчиков, работающих с немного отличающимися версиями зависимостей, может привести к различиям в поведении или доступности API.
Поэтому вы должны убедиться, что все используют одну и ту же версию. Чтобы упростить эту задачу, в файле .npmrc
есть несколько полезных свойств, которые могут гарантировать, что npm install
всегда обновляет файл package.json
, и обеспечивает точное совпадение версии установленной зависимости.
Запустите следующие строки в вашем терминале:
$ npm config set save=true
$ npm config set save-exact=true
Теперь, когда вы запускаете npm install
, вы можете быть уверены, что зависимость будет сохранена и будет заблокирована до версии, которую вы установили.
Добавьте скрипты в ваш package.json
Всем приложениям нужен скрипт запуска. NPM имеет стандартный способ запуска всех узловых приложений.
Добавьте свойство scripts
и объект к вашему package.json
с ключом start
. Это значение должно быть командой для запуска вашего приложения. Например:
"scripts": {
"start": "node myapp.js"
}
Как только кто-то запустит npm start
, NPM запустит node myapp.js
со всеми зависимостями от node_modules/.bin
на вашем $PATH
. Это означает, что вы можете избежать глобальной установки модулей NPM.
Еще несколько хуков скриптов, о которых стоит знать, это postinstall и test:
"scripts": {
"postinstall": "bower install && grunt build",
"start": "node myapp.js",
"test": "node ./node_modules/jasmine/bin/jasmine.js"
}
Сценарий postinstall
запускается после запуска npm install
. Также есть preinstall
, если вам нужно что-то запустить до того, как будут установлены все зависимости NPM.
Сценарий test
запускается, когда кто-то запускает npm test
. Тесты можно запускать, не выясняя, какая тестовая среда используется и т. д.
Вы также можете добавить свои собственные скрипты. Затем их можно запустить с помощью npm run-script {name}
— и вы можете предоставить команде центральный набор сценариев запуска.
Больше советов в моем следующем блоге на следующей неделе.
Сюзанна Лундквист