Последнее обновление 03.01.2023 — Василий Иванов
Менеджер пакетов Node, широко известный как npm, представляет собой онлайн-репозиторий для публикации пакетов и библиотек NodeJS.
Это также инструмент командной строки, который позволяет вам взаимодействовать с зарегистрированными пакетами. Это может помочь с установкой пакетов, управлением версиями и управлением зависимостями.
Разработчики ежедневно публикуют свои библиотеки JavaScript на npm. Процесс довольно прост, так что вы тоже можете опубликовать пакет на npm.
Шаг 1: Установка NodeJS
Чтобы взаимодействовать с npm, он должен быть глобально установлен в вашей системе.
Начните с установки NodeJS и npm в Ubuntu, Windows или следуйте инструкциям на веб-сайте NodeJS.
Шаг 2: Создание учетной записи npm
Чтобы опубликовать свои пакеты в npm, вы должны создать учетную запись npm на официальном сайте npm.
Выполните следующие действия, чтобы создать учетную запись npm:
- Перейдите на страницу регистрации npm.
- Заполните свои данные, согласитесь с лицензией и политикой конфиденциальности и нажмите «Создать учетную запись».
- Подтвердите свою электронную почту со ссылкой, которую вы получите от npm в своем почтовом ящике.
Если вы не подтвердите свой адрес электронной почты, npm выдаст ошибку при попытке опубликовать свои пакеты.
Шаг 3: Инициализация репозитория Git
Затем вам нужно инициализировать репозиторий Git, чтобы отслеживать все изменения, которые вы будете вносить в свой проект.
В терминале перейдите в корневой каталог вашего проекта и выполните следующую команду, чтобы инициализировать пустой репозиторий Git.
git init
Создайте файл .gitignore и добавьте любые файлы, которые вы не хотите отслеживать с помощью Git. Затем выполните следующую команду, чтобы отследить оставшиеся файлы:
git add -A
Затем выполните следующую команду, чтобы сделать свой первый снимок, зафиксировав код в Git.
git commit -m initial-commit
Вы можете разместить свой репозиторий Git на GitHub или аналогичном сервисе, таком как Gitlab, для бесперебойной совместной работы.
Шаг 4: Инициализация npm в вашем проекте
Затем инициализируйте npm в своем проекте, чтобы добавить сведения о вашем проекте в файл package.json. Эти детали будут общедоступны на npm.
В терминале перейдите в корневой каталог вашего проекта и выполните следующую команду, чтобы инициализировать npm в вашем проекте.
npm init
Приведенная выше команда вызовет набор подсказок в вашей командной строке:
- имя пакета: это имя вашего пакета npm; он должен быть уникальным, если вы хотите опубликовать пакет в npm; иначе npm выдаст ошибку.
- version: это свойство обозначает текущую версию вашего пакета. Вы должны увеличивать его каждый раз, когда обновляете свой пакет, иначе npm выдаст ошибку. Значение по умолчанию — 1.0.0.
- description: Это свойство является описанием вашего пакета. Он будет общедоступным, когда вы опубликуете свой пакет.
- точка входа: это свойство обозначает имя файла, в котором начинается выполнение вашего кода.
- тестовая команда: это свойство указывает команду, которая будет выполняться при выполнении npm run test.
- git-репозиторий: это свойство является URL-адресом вашего удаленного репозитория Git.
- ключевые слова: это свойство обозначает релевантные ключевые слова для вашего проекта, которые помогут поисковой системе найти его.
- автор: Это свойство должно быть вашим именем или псевдонимом.
- лицензия: это лицензия, под которой вы хотите опубликовать пакет. Лицензией по умолчанию является лицензия Консорциума интернет-систем (ISC).
После настройки вы можете создать свой package.
Шаг 5: Тестирование вашего пакета
После того, как вы закончите создание пакета, вы должны протестировать его локально, чтобы увидеть, как он будет вести себя после того, как вы развернете его в npm.
Чтобы протестировать пакет локально, сначала выполните следующую команду в каталоге вашего проекта:
npm link
Приведенная выше команда позволяет вам ссылаться на ваш пакет локально, как на пакет, размещенный на npm.
Затем создайте еще одну папку в корневом каталоге вашего проекта и перейдите в нее.
mkdir test
cd test
В тестовой папке выполните следующую команду, чтобы связать ваш пакет с папкой:
npm link name-of-your-package
Наконец, создайте фиктивный файл, чтобы проверить функциональность вашего пакета.
После завершения тестов вы можете безопасно удалить тестовую папку.
Шаг 6. Вход в npm в вашей системе
Затем вам нужно войти в свою учетную запись npm в вашей системе.
Выполните следующую команду, чтобы войти в свою учетную запись npm:
npm login
Вам будет предложено ввести имя пользователя, пароль и код двухфакторной аутентификации (если вы включили его в своей учетной записи).
Шаг 7: Публикация вашего пакета
После того, как вы выполнили все шаги, описанные выше, выполните следующую команду, чтобы опубликовать свой пакет в npm.
npm publish
Эта команда требует одноразовый пароль, который будет к вашей электронной почте. Затем он опубликует ваш пакет на npm.
Вы можете просмотреть пакеты, которые вы опубликовали на npm. Войдите в свою учетную запись npm на npmjs.com и перейдите в раздел пакетов на панели управления вашего профиля.
Чтобы установить пакет и использовать его как зависимость от любого из ваших проектов, запустите:
npm install name-of-your-package
Удаление вашего пакета из npm
Вы по-прежнему имеете полный контроль над своими пакетами в npm, а это означает, что вы можете изменять и даже навсегда удалять свой пакет из npm. Вы можете удалить свои пакеты, перейдя в раздел настроек вашего пакета и выбрав опцию удаления пакета.
