test-cli-package
v1.0.0
Published
Простий тестовий npm пакет з CLI командою
Readme
test-cli-package
Простий тестовий npm пакет з CLI командою.
Встановлення
npm install -g test-cli-packageВикористання
test-cli
test-cli hello
test-cli hello Іван
test-cli versionЯк задеплоїти пакет на npm
1. Підготовка
Переконайтеся, що у вас є акаунт на npmjs.com. Якщо немає - зареєструйтеся.
2. Увімкнення двофакторної аутентифікації (2FA)
ОБОВ'ЯЗКОВО! npm вимагає 2FA для публікації пакетів.
- Зайдіть на npmjs.com і увійдіть в акаунт
- Перейдіть в налаштування профілю: https://www.npmjs.com/settings/[ваш-username]/profile
- Увімкніть Two-Factor Authentication (2FA)
- Виберіть метод (автентифікатор або SMS)
- Скануйте QR-код або введіть код з SMS в додаток-автентифікатор
3. Вхід в npm через CLI
npm loginВведіть ваші credentials (username, password, email). Якщо 2FA увімкнено, вам потрібно буде ввести код з автентифікатора.
4. Перевірка назви пакету
Переконайтеся, що назва пакету в package.json унікальна. Можна перевірити на npmjs.com чи вільна назва.
5. Публікація
Перейдіть в папку пакету:
cd test-cli-packageОпублікуйте пакет:
npm publishЯкщо хочете опублікувати як публічний пакет (за замовчуванням):
npm publish --access public6. Оновлення версії
Після змін в коді, оновіть версію в package.json і знову опублікуйте:
npm version patch # для патчів (1.0.0 -> 1.0.1)
npm version minor # для мінорних оновлень (1.0.0 -> 1.1.0)
npm version major # для мажорних оновлень (1.0.0 -> 2.0.0)
npm publishАбо вручну змініть версію в package.json і виконайте npm publish.
7. Тестування локально
Перед публікацією можна протестувати локально:
npm linkЦе створить символічне посилання, і ви зможете використовувати команду test-cli глобально для тестування.
8. Встановлення іншими користувачами
Після публікації інші користувачі зможуть встановити пакет:
npm install -g test-cli-packageСтруктура пакету
test-cli-package/
├── bin/
│ └── cli.js # CLI скрипт
├── index.js # Основний модуль
├── package.json # Конфігурація пакету
└── README.md # ДокументаціяВажливо
- Файл
cli.jsповинен починатися з#!/usr/bin/env nodeдля коректної роботи - Поле
binвpackage.jsonвказує на CLI команду - Поле
filesвpackage.jsonвизначає які файли будуть включені в пакет
