Каждый веб-разработчик имел дело с npm на протяжении всей своей карьеры. Это увлекательный инструмент для упаковки, который предоставляет вам множество важных пакетов и помогает вам добавлять и управлять своими зависимостями для вашего веб-приложения.
Что такое НПМ?
Это менеджер пакетов (сокращение от Node Package Manager) для языка программирования javascript. Он может управлять вашими локальными пакетами и их зависимостями для вашего проекта. Обычно он поставляется вместе с установщиком Node.js.
Но задумывались ли вы, как эти пакеты доступны в npm? Их загружают такие разработчики, как мы с вами!
В этой статье я расскажу вам, как опубликовать свой пакет на npm. Это статья для начинающих, и любой, у кого есть базовые знания в области веб-разработки, может сделать это самостоятельно.
Предпосылки
Я предполагаю, что вы уже установили последнюю версию Node.js. Вы можете проверить это с помощью:
узел -v
npm -v
Как вы можете это сделать?
Ну, процедура очень проста и проста.
- Для начала вам необходимо создать учетную запись на официальном сайте npm npmjs.com.
- Затем вам нужно создать репо, которое вы хотите опубликовать. Как правило, этот репозиторий содержит следующие файлы: index.js, package.json и файл README.md.
mkdir hello-world && cd hello-world
Вы можете создать свой package.json с помощью:
инициализация npm
или просто:
инициализация npm -y
Примечание. Мы будем публиковать наш репозиторий публично, поэтому есть вероятность, что название репозитория, которое вы публикуете, уже опубликовано. В этом случае npm не позволит опубликовать ваш пакет. Итак, чтобы решить эту проблему, вам предлагается сохранить уникальное имя вашего пакета или использовать свое имя пользователя (учетной записи npm) с именем пакета.
то есть @your-username/hello-world.
Теперь создайте файл README.md (вы можете создать его вручную или, если вы создаете репозиторий на github/gitlab, он сделает это за вас) и добавьте описание вашего пакета. Если вы не знаете о файле уценки или не знаете, как в нем писать, вы можете получить помощь здесь: Освоение уценки · GitHub Guides
3. Теперь вы можете поместить свой код в index.js (помните, что код, который вы поместили в этот файл, должен быть экспортирован с использованием module.exports или exports.your_function-name чтобы его можно было использовать после импорта в любом репо).
Если у вас еще нет написанного кода или репозитория, вы можете начать с классического hello-world, как показано ниже (в index.js):
exports.helloWorld = функция () {
console.log("Здравствуйте, мне звонили из вашего модуля!")
}
Теперь, когда у нас есть все необходимые файлы, пришло время их опубликовать!
4. Откройте свой терминал или git bash (если на Windows) и выполните следующие шаги:
логин npm
он запросит ваше имя пользователя и пароль.
Теперь вы вошли в свою учетную запись, чтобы мы могли ее опубликовать.
публикация npm — общедоступный доступ
Помните, что вы должны использовать указанную выше команду там, где находится ваш package.json.
Вот и все. Поздравляем, вы только что опубликовали свой первый пакет!
Вы можете проверить свой пакет на npmjs.com.
Здесь я также предоставил ссылку на мой 1-й репозиторий https://www.npmjs.com/package/@utsavgadhiya/crypto-module.
Ресурсы для получения дополнительной помощи:
Спасибо, что прочитали это. Хорошего дня!