Публикуйте пакет в NPM

Публикация пакета в NPM-это быстрый и эффективный способ повторного использования кода в нескольких проектах.

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

Прежде чем мы начнем, убедитесь, что у вас есть NPM Account и установить и обновлять NPM с помощью запуска npm i -g npm@последний Анкет Вам также понадобится Узел установлены.

Создайте проект

Давайте запустим проект. Мы создадим небольшую утилиту, чтобы поймать и помочь нам исправить все наши ошибки.

1. Создайте пустой каталог: Mkdir super-error-handler && cd super-error-handler
2. Генерировать Package.json : npm init -y Это произведет некоторые тонкие значения по умолчанию.
3. Создайте свою утилиту: Touch Index.js

// super-error-handler/index.js

module.exports = function handleError(error) {
  const query = encodeURI(error.message)
  console.error(`https://stackoverflow.com/search?q=${query}`)
}

Создать тестовую среду

Теперь, когда у нас есть какой -то код, давайте посмотрим, работает ли он!

1. Создайте еще один пустой каталог за пределами оригинала: Mkdir test-env && cd test-env
2. Создайте еще один Package.json : npm init -y
3. Создайте символическую ссылку на вашу утилиту, чтобы вы могли потребовать, как другие установленные модули: npm link/path/to/super-error-handler
4. Создайте файл для тестирования с: Touch Index.js

// test-env/index.js

const handleError = require('super-error-handler')

function testErrorHandler() {
  try {
    throw new Error('something bad happened')
  } catch (error) {
    handleError(error)
  }
}

testErrorHandler()

Теперь, когда у нас есть некоторый тестовый код, написанный с помощью нашего обработчика ошибок, давайте попробуем: запустить Узел index.js Анкет

Публикуйте в NPM

Почти готово! Поскольку каждый пакет NPM нуждается в уникальном имени, вам нужно просмотреть свои имена, установив имя поле в вашем Package.json к @your_npm_username/super-error-handler Анкет

Наконец, из Супер-ошибка-Хэндлер каталог, запустить NPM Adduser для аутентификации в NPM, а затем NPM Publish Анкет

Вот и все! Вы опубликовали свой первый пакет NPM! Отправляйтесь в npmjs.org Чтобы найти это и проверить это.

Дополнительные советы

Теперь, когда ваш код доступен на NPM, вот несколько вещей, которые вы можете и должны сделать:

• Проверьте NPM DOCS на Package.json Поля и заполните их надлежащим образом.
• Создайте github Repo для вашего проекта.
• Добавить .npmignore Файл, чтобы некоторые из ваших репо были загружены пользователями вашего модуля. Вот отличный Вопрос о переполнении стека детализируя, как вы можете использовать один.
• Используйте np Чтобы выровнять свою игру NPM. Это помогает позаботиться о куче дополнительных этапов публикации, включая создание выпуска на GitHub. Прочитайте документы на NPM.

Нужна помощь или хотите поделиться своим недавно загруженным пакетом NPM? Не стесняйтесь обратитесь к Анкет

Оригинал: “https://dev.to/briansw/how-to-publish-a-package-to-npm-in-5-minutes-50nh”