NPM е страхотна библиотека от JavaScript пакети. Има няколко налични пакета, които можете да използвате, за да създавате страхотни неща. Можем да използваме пакети, създадени от други разработчици, но също така можем да публикуваме нашите пакети.
Също така създадох два пакета (Headx & CarrierJS) и един интерфейс на командния ред (ZEN). И някои хора са ги изтеглили.
В тази статия ще ви покажа как можете да публикувате своя пакет в NPM директорията.
Стъпка — 1 — Трябва да инсталирате Node JS
За да използвате npm, първо трябва да имате инсталиран възел във вашата система. Ако node не е инсталиран във вашата система, тогава можете да използвате връзките по-долу, за да го изтеглите -
1. Възел Js (инсталатор на прозорец)
2. Node Js (инсталатор за Mac)
Можете да посетите официалния уебсайт на node js.
Стъпка — 2 — Трябва да създадете NPM акаунт
Необходим е npm акаунт, за да публикувате пакет в npm, можете да създадете npm акаунт, щракнете тук.
- Кликнете върху бутона Регистрация.
- Въведете своето потребителско име, имейл адреси парола.
- След това щракнете върху бутона Създаване на акаунт.
- Потвърдете своя имейл с връзката за потвърждение, която ще получите на посочения от вас имейл адрес.
- Ако вече имате акаунт, щракнете директно върху бутона влезте от началната страница или можете да кликнете върху Вече имате акаунт? на страницата за регистрация.
Забележка —Уверете се, че следите вашите идентификационни данни, защото ще ви трябват тези идентификационни данни по време на влизане от cli.
Стъпка — 3— Инициализирайте git хранилище и го добавете към профила в github
След това създайте папка и инициализирайте git хранилището, за да проследите всичките си промени.
За да създадете папка, можете да използвате командата по-долу -
mkdir <folder_name>
Влезте във вашата папка, която сте създали с горната команда -
cd <folder_name>
Сега настройте git repo, като използвате командите по-долу -
git init git add . git commit -m "first commit" git remote add origin https://github.com/<yourusername>/<repo>.git git push origin master
Стъпка — 4— Инициализирайте проекта с помощта на npm
Npm initialize се използва за добавяне на подробности за проекта във файла package.json, който ще бъде публичен в регистъра на npm.
Сега отидете на вашия терминал, навигирайте до вашия проект и въведете командата по-долу -
npm init
Тази команда ще ви попита за информация, свързана с вашия проект
- име на пакета —името на пакета трябва да е уникално
- версия —запазете я както е засега
- входна точка —въведете входна точка на вашия пакет. запазете го index.js за сега
Стъпка — 5— Написване на кода на нашия пакет
- Създайте файл index.js в основната директория на пакета
- Отворете вашия редактор на код, аз използвам VS Code
- Въведете следния код във файла index.js
let sortedArray = [];
/**
* @desc removes all the duplicates from the array
* @param {*} value // Accepts array
*/
function sortArray(arr) {
// arr : array of values
if (!Array.isArray(arr)){
throw new TypeError('arr should be an array');
}
sortedArray = arr.sort();
return sortedArray;
}
let fruits = ["Banana", "Orange", "Apple", "Mango"];
let num = [5, 9, 4, 2, 8, 7];
let fruitsArr = sortArray(fruits);
let numArr = sortArray(num);
console.log(fruitsArr);
console.log(numArr);
4. Сега е време да тестваме нашия код.
5. Отворете терминала и въведете командата по-долу.
node index.js
6. Вашият резултат трябва да изглежда така -
Стъпка — 6— Локално тестване на пакета
След като разработим пакета, трябва да го тестваме локално, за да видим как ще работи след публикуването му в npm.
- Първо заменете удебеления код от горния код на файла index.js с кода по-долу -
module.exports = sortArray
2. Нашият файл index.js ще изглежда така -
let sortedArray = [];
/**
* @desc removes all the duplicates from the array
* @param {*} value // Accepts array
*/
function sortArray(arr) {
// arr : array of values
if (!Array.isArray(arr)){
throw new TypeError('arr should be an array');
}
sortedArray = arr.sort();
return sortedArray;
}
module.exports = sortArray
3. Отворете терминала и в главната директория на пакета изпълнете командата по-долу
npm link
тази команда ще ви позволи да използвате вашия пакет локално, както сте го инсталирали от npm.
4. Създайте фиктивен проект и инсталирайте вашия пакет в него, като използвате тази команда -
npm link name_of_your_package
ако всичко върви добре, тогава можете да продължите напред.
Стъпка — 7— Влезте в npm чрез командния ред
Изпълнете следната команда, за да влезете във вашия npm акаунт
npm login
ще ви помоли да въведете вашето потребителско име, парола и двуфакторен код за удостоверяване, ако сте го активирали.
След като влезете успешно, можете да преминете към следващата стъпка.
Стъпка — 8— Публикуване на пакет в npm
Не забравяйте, че името на вашия пакет трябва да е уникално във вашия файл package.json. в противен случай вашият пакет няма да бъде публикуван в npm.
За да проверите дали името на вашия пакет е уникално в npm или не, можете да използвате следната команда.
npm search your_package_name
ако някой пакет е посочен долу. тогава не можете да използвате това име за вашия пакет.
можете да опитате с друго име.
Не забравяйте да промените името на пакета си във файла package.json, ако не е наличен в npm по този начин -
{
"name": "dosorting",
"version": "1.0.0",
"description": "",
"main": "index.js",
"keywords": [],
}
Сега можем да публикуваме нашия пакет, използвайки следната команда -
npm publish
след успешно публикуване ще получите имейл и ще получите съобщение по-долу на вашия терминал.
npm notice name: dosorting npm notice version: 1.0.0 npm notice package size: 484 B npm notice unpacked size: 597 B npm notice shasum: a84844e7899b12621b3bfd1ebb9cf9e1f673249d npm notice integrity: sha512-WOzSOxRxTp+eG[...]aJ6iDgzOdZdXg== npm notice total files: 2 npm notice + [email protected]
Поздравления, публикувахте първия си пакет в npm.
Ако искате да направите промени във вашия пакет,
- след това направете промени.
- отворете файла package.json и променете номера на версията
- влезте във вашия npm акаунт и изпълнете отново следната команда
npm publish
Тук, в тази статия, създадохме основен и прост пакет. Не забравяйте да добавите файла README.md в основната директория на вашия пакет, това ще ви помогне да опишете за вашия пакет и как другите могат да го използват.
Благодаря ви, че прочетохте...
