Создание вашего первого пакета npm может показаться трудным, но на удивление очень легко
Добро пожаловать в сегодняшний блог для создания и публикации вашего первого пакета NPM. В этой статье я расскажу о том, как создать пакет npm и протестировать его локально. Как опубликовать его в диспетчере пакетов npm и начать установку с npm install package_name. Давайте начнем!
Содержание
· Шаг 1: Создайте репозиторий git с файлом readme
· Шаг 2: Запустите npm для создания пакета JSON
· Шаг 3: Создайте файл сценария пакета
· Шаг 4: Тестирование
· Шаг 5: Публикация пакета
· Шаг 6: Проверка
· Резюме
Шаг 1. Создайте репозиторий git с файлом readme
На самом первом этапе вам нужно создать репозиторий git с файлом readme и клонировать его локально, чтобы начать кодирование в нем.
Узнайте, как создать репозиторий git
Шаг 2. Запустите npm для создания пакета JSON
Итак, чтобы создать package.json, нам нужно инициализировать NPM в нашем репозитории. Откройте терминал внутри папки и запустите npm init, это вызовет некоторые вопросы. Файл package.json содержит всю информацию, которую делает наш пакет, поэтому введите как можно больше информации.
Так выглядит наш package.json. В этом примере мы собираемся создать пакет с mane is-harendra, который будет возвращать true или false в зависимости от входной строки.
{
"name": "is-harendra",
"version": "1.0.0",
"description": "My first NPM package",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/harendra21/first-npm-package.git"
},
"keywords": [
"first",
"npm",
"package"
],
"author": "Harendra Verma",
"license": "ISC",
"bugs": {
"url": "https://github.com/harendra21/first-npm-package/issues"
},
"homepage": "https://github.com/harendra21/first-npm-package#readme"
}
Шаг 3. Создайте файл сценария пакета
Мы указали наш главный файл как index.js в нашем package.json, поэтому нам пришлось создать index.js файл наизнанку приложения, и внутри этого файла указать функцию для выполнения действия, как указано ниже.
function isHarendra(string){
return string == "harendra"
}
module.exports = isHarendra
Шаг 4: Тестирование
Итак, теперь мы готовы опубликовать наш пакет. Но перед публикацией пакета необходимо протестировать приложение локально. Итак, чтобы протестировать пакет npm, необходимо связать пакет, запустив npm link внутри пакета.
Теперь создайте папку test-scripe вне нашего приложения и создайте файл script.js внутри этой папки, скопируйте и вставьте следующий код.
const isHarendra = require('is-harendra')
console.log(isHarendra('Harendra'))
Теперь откройте терминал внутри test-script и установите пакет, запустив npm link package-name.
Теперь, если мы запустим это script.js в нашем терминале, мы получим истину или ложь в соответствии с определенной строкой на нашем терминале.
Шаг 5. Публикация пакета
Итак, теперь мы успешно протестировали наш код, мы написали наш код, и, наконец, пришло время его опубликовать. Чтобы опубликовать наш пакет на NPM, нам потребуется учетная запись NPM для входа в систему. Если у вас нет учетной записи, вы можете Зарегистрироваться. Теперь, чтобы войти в систему с учетной записью, нам нужно открыть терминал в папке пакета и запустить npm login.
Теперь запустите npm publish, чтобы опубликовать наш пакет.
Шаг 6. Проверьте
Теперь посетите веб-сайт npm и в поле поиска введите имя пакета, вы найдете там свой пакет.
Щелкните здесь, чтобы просмотреть is-harendra на npm
Кто угодно может установить ваш пакет прямо сейчас, запустив npm i is-harendra.
Заключение
В этой статье мы узнали о том, «Как создать и опубликовать пакет NPM?» очень легко. Я создал и опубликовал пакет npm за 6 простых шагов. Я надеюсь, что, выполнив эти шаги, любой сможет легко создать пакет npm.
Спасибо, что прочитали этот пост, он может вам понравиться. Пожалуйста, подписывайтесь на меня, чтобы узнать больше об этом.
Дальнейшее чтение:
Больше контента на plainenglish.io
