Пошаговое руководство
Начнем с того, что я делю эту историю на две части:
- Создайте свой собственный пакет Node.js.
- Опубликуйте свой пакет на npm.
Предварительные требования
Чтобы создать свой собственный пакет Node.js, создайте новый каталог simple-hello-world-example
в своей системе. Вместо simple-hello-world-example
вы можете использовать название своего пакета.
Если вы работаете в macOS, введите в терминале следующие команды.
- Создайте
simple-hello-world-example
каталог. - Войдите в каталог
simple-hello-world-example
. - Создайте
package.json
файл в своемsimple-hello-world-example
каталоге . Скопируйте и вставьте указанный нижеpackage.json
код в свойpackage.json
файл. Вместоsimple-hello-world-example
вы можете использовать имя своего пакета. - Команда
npm install
создаст новый каталогnode_modules
внутри вашегоsimple-hello-world-example
каталога. Если вы видите файлpackage.json
, у нас есть“devDependencies”: { “chai”: “4.1.2”, “mocha”: “5.0.5” }
. Когда мы запускаем командуnpm install
, они загружают Chai, Mocha и другие зависимые пакеты в вашnode_modules
каталог. npm test
команда. Перед запуском этой команды сначала создайте файлtest.js
. Скопируйте и вставьте приведенный нижеtest.js
код в свойtest.js
файл.
Структура проекта
package.json
index.js
Здесь, в index.js
, мы создали функцию printMsg()
, которая вернет строку «Hello World!» когда звонили.
test.js
В test.js
мы тестируем printMsg()
, используя среду тестирования node.js, Mocha и Chai.
README.md
Ниже вы можете увидеть предварительный просмотр README, так он будет выглядеть на сайте npm.
.gitignore
файл:
Вы можете самостоятельно загрузить полный код проекта с GitHub.
Теперь, когда мы создали наш пакет, пришло время опубликовать его на npm. Для этого вам необходимо зарегистрироваться на сайте npm.
Создайте новую учетную запись на npm.
Авторизуйтесь на сайте npm под своим логином и паролем.
Не забудьте подтвердить свою электронную почту с помощью npm и проверить свою электронную почту на наличие проверочного письма npm.
После проверки электронной почты откройте терминал и введите команду npm login
.
- Он попросит ваше имя пользователя: напишите ваше имя пользователя npm.
- Пароль: напишите свой пароль npm.
- Электронная почта: напишите свой адрес электронной почты npm, который вы указали при регистрации на веб-сайте npm.
После успешного входа в систему пора опубликовать ваш пакет на npm.
Для публикации перейдите в каталог вашего пакета в терминале и введите команду:
npm publish
Ура! Вы успешно опубликовали свой собственный пакет npm на npm.
Поздравляю!
Перейдите в панель управления npm, щелкните справа Пакеты . Вы можете увидеть свой пакет на веб-сайте npm.