Чтобы создать NPM-пакет у вас должен быть установлен Node.js. После установки Node.js, нужно убедиться что установка прошла корректно и заодно проверить его версию, сделать это можно следующей командой:
npm -vИнициализация NPM-пакета
Перед тем как инициализировать NPM-пакет важно отметить, что для его грамотной и удобной разработки, лучше всего использовать какой-нибудь Git-репозиторий, например Github или Gitlab. Теперь в терминале, находясь в директории вашего NPM-пакета, нужно провести его инициализацию выполнив следующую команду:
npm initВам будут заданы вопросы про ваш NPM-пакет, вы можете ответить на них сразу или пропустить, нажав Enter. После ответов на вопросы, в директории пакета создаться файл package.json, в нем будет прописана основная информация о вашем пакете.
package.json
Вы можете редактировать файл package.json вручную. Вот основные и самые важные его настройки:
- name — Имя, по которому пакет будет доступен в NPM.
- description — Описание пакета.
- author — Автор пакета.
- license — Лицензия распространения пакета.
- version — Версия пакет (будет сгенерирована автоматически).
Перед тем как создавать пакет, убедитесь что такого названия в базе NPM еще нету. Для этого воспользуйтесь поиском на сайте, вбейте название которое придумали и проверье уникальность.
README.md
После инициализация проекта, правилом хорошего тона будет создание документации по установке и использованию вашего проекта. В корне создайте файл README.md и пропишите все что может быть полезно другим разработчикам (да и вам) по управлению вашим проектом.
Пример README.md можете взять отсюда.
Публикация NPM-пакета
Для начала нужно пройти регистрацию на npmjs.com, сделать это можно из терминала командой:
npm adduserЕсли же учетная запись у вас уже есть, то нужно авторизироваться в терминале:
npm loginПроверить под какой учетной записью вы находитесь можно с помощью команды:
npm whoamiТеперь можно публиковать NPM-пакет:
npm publishПосле введения команды выше, ваш пакет отправиться на сервера NPM и будет доступен для подключения к проектам.
Обновление NPM-пакета
Без обновлений никуда. Для того чтобы правильно обновить пакет, вам нужно:
- Внести изменения в код.
- Обновить версию пакета командой
npm version [ major | minor | patch ]. - Опубликовать новую версию пакета командой
npm publish.
Правильное версионирование пакета поможет разработчикам, которые используют ваш пакет понять, насколько критические изменения были внесены.
npm version patch
Команда npm version patch, увеличит версию пакета например, с 1.0.0 до 1.0.1. Незначительные исправления мелких ошибок.
npm version minor
Команда npm version minor, увеличит версию пакета например, с 1.0.0 до 1.1.0. Добавления нового функционала, который не влияет на уже существующий функционал.
npm version major
Команда npm version major, увеличит версию пакета например, с 1.0.0 до 2.0.0. Модификация пакета без обратной совместимости с предыдущей версией. Разработчик поймет что простое обновление пакета может что-то сломать и изучит вопрос правильного обновления на новую мажорную версию.
Удаление NPM-пакета
Удаление NPM-пакетов является очень плохим тоном, т. к. от этих пакетов могут зависеть проекты других пользователей. Однако, если после публикации пакета командой npm publish прошло менее 24 часов, то публикацию можно отменить командой npm unpublish. Пакеты, которые были добавлены более 24 часов назад, удалить нельзя.
Если все-таки вам необходимо удалить пакета, то напишите в поддержку, указав причину удаления пакета. Пакет будет помечен как @deprecated и исчезнет из вашего профиля.
Установка NPM-пакета
После того, как ваш NPM-пакет появился в вашем профиле, он будет доступен по ссылку:
https://www.npmjs.com/package/название-вашего-пакетаИ его можно будет подключить к любому вашему проекту, с помощью команды:
npm i название-вашего-пакетаТеперь, вы можете гибко обновлять код вашего компонента, без необходимости вручную вносить изменения на уже существующих проектах. Просто обновите пакет до актуальной версии и все изменения подтянуться автоматически.