Пошаговое руководство

Начнем с того, что я делю эту историю на две части:

  1. Создайте свой собственный пакет Node.js.
  2. Опубликуйте свой пакет на npm.

Предварительные требования

  1. Node.js
  2. Нпм

Чтобы создать свой собственный пакет Node.js, создайте новый каталог simple-hello-world-example в своей системе. Вместо simple-hello-world-example вы можете использовать название своего пакета.

Если вы работаете в macOS, введите в терминале следующие команды.

  1. Создайте simple-hello-world-example каталог.
  2. Войдите в каталог simple-hello-world-example .
  3. Создайте package.json файл в своем simple-hello-world-example каталоге . Скопируйте и вставьте указанный ниже package.json код в свой package.json файл. Вместо simple-hello-world-example вы можете использовать имя своего пакета.
  4. Команда 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 каталог.
  5. 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.