Как опубликовать пакеты в НПМ (так, как отрасль делает вещи)

Автор оригинала: Zell Liew.

Это просто опубликовать пакет на NPM. Есть два шага:

Создайте свой пакет.
Опубликовать пакет.

Но публикация пакетов так, как отрасль это делает? Не так просто. Есть больше шагов. Мы пройдем, какие шаги требуются, и я покажу вам простой способ публикации и обновления вашего пакета.

Создание вашего первого пакета

Этот раздел для вас, если вы не опубликовали пакет до NPM раньше. Не стесняйтесь пропустить следующий раздел, если вы опубликовали один ранее.

Чтобы опубликовать свой первый пакет на NPM, вам нужно пройти через эти шаги:

Во-первых, вам нужно иметь учетную запись NPM Отказ Создать один здесь Если у вас еще нет одного.

Во-вторых, вам необходимо войти в свою учетную запись NPM через командную строку Отказ (Вам нужно иметь узел и NPM в вашей системе, прежде чем выполнить этот шаг. Установите их здесь ).

Войти, вы используете NPM Вход Отказ

npm login

Вам будет предложено ввести ваше имя пользователя, пароль и адрес электронной почты.

В-третьих, вам нужно создать пакет Отказ Для этого создайте папку где-то на вашем компьютере и перейдите к ней. Версия командной строки:

# Creating a folder named how-to-publish-to-npm mkdir how-to-publish-to-npm # Navigating into the folder cd how-to-publish-to-npm

Далее вы хотите начать проект с NPM init команда.

npm init

Эта команда запускает вас через несколько вопросов и создает Package.json файл для вас в конце. Это Package.json Файл содержит недопущенные потребности, необходимые для публикации вашего проекта. (Не стесняйтесь пропустить вопросы, которые не имеют смысла).

Последний шаг – опубликовать ваш пакет с NPM публиковать команда.

npm publish

Если пакет уже существует на NPM (потому что ваш пакет имеет то же имя, что и другой пакет на NPM), вы не сможете его опубликовать. Вы получите ошибку.

Вам нужно будет изменить имя вашего пакета.

Чтобы изменить имя вашего пакета, вы меняете Имя Недвижимость в Package.json файл. Здесь я изменил это на Публикация-NPM Отказ

(Вы можете проверить наличие столкновений, выполнив поиск по NPM, или через команду Поиск NPM ).

Также хорошая идея обновить имя папки, а также для согласованности. Вот эквивалент командной строки.

# Command to change folder names by moving everything mv how-to-publish-to-npm publishing-to-npm

Попробуйте Опубликовать команда снова. Вы должны получить сообщение успеха сейчас.

Что делать, если бы каждое имя вы придумали, это принято уже

Это общая проблема, так как многие люди создают пакеты на НПМ. Трудно получить имя пакета, которое вы хотите иногда. (Это как то, как я могу никогда Найти хороший .com домен).

Чтобы бороться с этой проблемой, NPM позволяет вам опубликовать объем. Это означает, что вы можете опубликовать пакет под своим собственным именем пользователя (или организации NPM), поэтому вы свободны от проблем с именами.

Чтобы опубликовать на область, вы можете либо:

Изменить Имя к @ Имя пользователя/Пакет-имя вручную в Package.json.
Беги NPM init вместо npm init.

Если ваш репозиторий имеет масштаб, вам нужно немного отрегулировать команду опубликованного:

npm publish --access public

Это все, что вам нужно сделать, чтобы публиковать пакет в НПМ.

Теперь давайте перейдем к тому, как отрасль публикует пакеты.

Рассмотрим популярные рамки, такие как реагирование. Если вы копаете, отреагируете, вы заметите несколько вещей:

Во-первых, реакция имеет Github Repository Отказ

Во-вторых, реагировать Опубликовано на NPM.

В-третьих, реагирует за Семантическая версия (Semver для короткого).

В-четвертых, каждое обновление для реагирования имеет метку GIT, связанной с ним. Этот меток Git также следует с семеей.

Пятый, есть Выпуск ноты Для каждого обновления реагирования.

Это означает, что публикация пакета включает в себя много шагов. По крайней мере, вам нужно:

Запустить тесты (если есть)
Обновить Версия в Package.json По данным Semver
Создайте бирку Git в соответствии с Semver
Нажмите на пакет до Github
Нажмите на пакет до NPM
Создание заметок выпуска для каждого обновления

Обычно стоит забывать одну из этих вещей, когда мы готовы нажать. Иногда мы NPM публиковать И мы наслаждаемся перерывом. Когда мы вернемся, мы винтифицируемся забыть.

Там проще. Это с инструментом под названием NP Отказ

NP.

NP (Создан Sindre Sorhus ) облегчает нам опубликовать пакеты, не пропустив ни один из шагов, которые я подробно описал выше.

Установка NP.

Чтобы установить NP , вы можете запустить следующую команду:

npm install np

Это работает. Но я предпочитаю устанавливать NP глобально на моем компьютере, чтобы я мог бежать NP командовать где угодно.

sudo npm install --global np

Перед использованием NP.

Прежде чем использовать NP. Вы должны убедиться:

Ваш проект – репозиторий Git
Это должно иметь удаленный
Вы, должно быть, вынуждены отталкиваться на пульт, по крайней мере, один раз.
Вам также необходимо убедиться, что ваш рабочий каталог чистый.

# Initialize Git git init # Adds a remote repository git remote add origin some-url # Commit changes git add . git commit -m "Initial Commit"

Если ваш проект не является репозиторий Git, вы получите эту ошибку:

Если ваш проект не имеет удаленного, вы получите эту ошибку (по более поздней части чеков).

Если ваш рабочий каталог загрязнен, вы получите эту ошибку:

Если вы не оттолкнулись к дистанционному джоку, по крайней мере, один раз, NP просто повешу и ничего не сделаю.

Используя НПМ

Использовать NP. Вы запускаете NP команда.

np

NP Подскажет вам ввести номер семера.

Выберите номер и NP попросит вас подтвердить свой выбор.

NP. тогда Остальная часть издательства для вас.

Ошибка с запущенными тестами

NP управляет NPM Test Команда как часть его проверок.

Если вы следили за руководством до этого момента, вы получите ошибку, которая выглядит так:

Это происходит потому, что наш NPM Test Команда приводит к ошибке. Вы можете попробовать это сами:

npm test

Чтобы исправить эту ошибку, нам нужно изменить Тест Сценарий в Package.json файл.

Прямо сейчас это выглядит так:

"scripts": {     "test": "echo \"Error: no test specified\" && exit 1"},

Измените это к этому:

"scripts": {     "test": "echo \"No test specified\""},

Это изменение работает, потому что Выход 1 создает ошибку.

С этим изменением NP должен завершить процесс публикации. (Не забудьте совершить изменения перед запуском NP ).

В конце процесса NP Запускает окно браузера для вас, чтобы заметки о выпуске.

Короче говоря, NP Делает издательства пакетов гораздо проще!

Спасибо за прочтение. Эта статья поможет вам? Если это сделало, я надеюсь, что вы считаете делиться этим . Вы можете помочь кому-то еще. Огромное спасибо!

Эта статья была первоначально опубликована в мой блог . Подпишитесь на мой рассылка Если вы хотите больше статей, чтобы помочь вам стать лучшим разработчиком Frontend.

Оригинал: “https://www.freecodecamp.org/news/how-to-publish-packages-to-npm-the-way-the-industry-does-things-2077ec34d7e8/”