Вы когда-нибудь задумывались о публикации своих проектов или приложений на NPM, чтобы их могли использовать другие?

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

Итак, если вам интересна эта идея, читайте дальше.

Создать учетную запись NPM

Прежде всего, вам понадобится учетная запись NPM. Если у вас еще нет учетной записи, вы можете посетить страницу регистрации NPM, чтобы создать ее.

Установить узел

Вы можете скачать его с официального сайта Node. NPM предварительно установлен вместе с Node.

Выберите имя для вашего пакета NPM

Имя вашего пакета — это то, что люди будут передавать в require().

Это означает, что вам нужно выбрать короткое, но описательное имя. Имя пакета должно быть уникальным и содержать только символы , безопасные для URL-адресов, без начальных точек и подчеркиваний.

Первое, что вы можете сделать, это посетить страницу NPM и найти желаемое имя пакета. Если пакет с таким же или похожим именем существует (например, published-npm-package и publishednpmpackage), вы не сможете его использовать. Если вы по-прежнему хотите использовать то же имя, вы можете создать Пакет NPM с ограниченной областью. Пакет с ограниченной областью действия – это пакет с префиксом @your-username. Это означает, что в конечном итоге вы получите @your-username/package-name.

Таким образом, вы можете выбрать уникальное имя или создать пакет с ограниченной областью действия. Пакет с ограниченной областью действия даст вам больше гибкости и может помочь вам сгруппировать пакеты. Более подробное объяснение именования пакетов NPM можно прочитать здесь.

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

Создайте свой пакет

Сначала создайте новую папку, зайдите в нее и запустите команду npm init, чтобы настроить новый проект NPM. Если вы хотите создать пакет с заданной областью действия, запустите npm init —scope=@your-username. Затем вам необходимо будет предоставить следующую информацию:

  • Имя пакета. Вы можете использовать имя, выбранное на предыдущем шаге.
  • Версия.Версия вашего пакета. Для получения более подробной информации вы можете обратиться к документации NPM о семантическом управлении версиями.
  • Описание. Краткое объяснение того, что представляет собой ваш пакет. NPM покажет эту ссылку на странице результатов поиска.
  • Точка входа. Основная точка входа в ваш проект. Для получения более подробной информации вы можете обратиться к документации NPM относительно точки входа.
  • Тестовая команда. Команда, выполняемая при запуске теста запуска npm.
  • Репозиторий Git. URL-адрес репозитория проекта на GitHub. NPM отобразит эту ссылку на странице NPM вашего пакета.
  • Ключевые слова. Ключевые слова, которые помогут другим обнаружить ваш пакет в реестре NPM.
  • Авторы. Ваше имя. Вы можете обратиться к документации NPM относительно автора и участников для получения дополнительной информации.
  • Лицензия. Лицензия вашего пакета, чтобы информировать людей о том, как они могут его использовать. Вы можете узнать больше о лицензиях NPM здесь или пока использовать лицензию ISC (Internet Systems Consortium) по умолчанию.

После завершения этого шага в вашем файле package.json должно появиться что-то подобное.

Следующий шаг — развитие вашего проекта. Для простоты я создам файл с именем index.js в корневом каталоге и напишу внутри простую функцию. Возможно, вам придется изменить имя каталога и файла в зависимости от вашей точки входа.

function sayHello() {
  console.log("Hello, this is published-npm-package");
}

module.exports = sayHello;

Проверьте свой код

Есть очень много способов протестировать свой код.

Один из самых простых способов — использовать команду npm link в корневом каталоге вашего проекта. Это позволит вам протестировать ваш пакет так, как если бы вы установили его на свой компьютер.

Команда npm link создаст символическую ссылку в вашей глобальной папке node_modules, которая ссылается на ваш пакет. После этого вы можете создать новый проект NPM и запустить команду npm link ‹имя-пакета>< (замените ‹имя-пакета› на имя вашего пакета) в корневой папке нового проекта. Эта команда создаст символическую ссылкув папке нового проекта node_modules на глобальную папку node_modules ‹имя_пакета>< . Если вы проверите node_modules, вы увидите, что он содержит коды из вашего первого проекта. Затем вы можете написать сценарий для тестирования вашего пакета.

const sayHello = require("published-npm-package");

sayHello();

Подводя итог, вы можете использовать команду npm link для тестирования своего проекта. Это позволяет вам использовать пакет так, как если бы вы установили его на свой компьютер. Если вы хотите узнать больше об этой команде, обратитесь к этой документации NPM, в которой обсуждается команда npm link.

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

Опубликуйте свой проект

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

Сначала войдите в свою учетную запись NPM, выполнив команду npm login в корневом каталоге вашего проекта. Затем вам нужно будет указать имя пользователя и пароль вашего NPM. Следующим шагом является запуск команды npmPublish. Если вы решите создать ограниченный пакет, вы столкнетесь с ошибкой, когда NPM запросит оплату. Чтобы избежать этого, вы можете либо заплатить комиссию, либо сделать свой проект общедоступным, запустив npmPublish — Access Public.

Итак, теперь ваш пакет опубликован в NPM. Вы можете зайти на страницу NPM и поискать ее. Вы также можете попробовать установить и использовать его в других своих проектах.