эта статья также доступна на моем сайте: https://www.hoseinh.com/how-to-create-a-npm-module/

NPM — самый популярный менеджер пакетов для javascript, который позволяет вам устанавливать и импортировать множество полезных модулей в ваши проекты.

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

Создайте папку проекта и запустите npm

прежде всего создайте папку для вашего пакета и запустите в ней эту команду:

npm init

теперь терминал попросит вас ввести некоторую информацию о вашем пакете, такую ​​как имя, версия, описание, файл точки входа и репозиторий git. введите их и нажмите Enter, чтобы инициализировать пакет и создать файл package.json, содержащий информацию о пакете.

Создать файл точки входа

создайте файл в корне папки и назовите его именем, которое вы ввели в качестве имени файла точки входа при инициализации пакета, в нашем случае мы создаем файл index.js.

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

но чтобы эту функцию можно было импортировать в другие файлы, мы должны экспортировать ее с помощью «module.exports»

index.js:

module.exports = function (x) {
  return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ",");
};

если вы хотите добавить несколько методов, вам нужно создать функции следующим образом:

module.exports.имя_функции:

module.exports.formatNumber = function (x) {
  // function code hare
};
module.exports.formatString = function (x) {
  // function code hare
};

чтобы этот учебник был простым и быстрым (как вы, вероятно, хотите!), я не добавляю больше методов или файлов в этот пакет, поэтому мы переходим к публикации нашего пакета для форматирования чисел.

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

Итак, теперь, когда наш пакет готов, давайте опубликуем его в npm, прежде всего войдите в npm в терминале:

npm login

и введите свое имя пользователя и пароль для входа в систему. Если у вас нет учетной записи, создайте новую учетную запись npm с помощью npm adduser.

теперь, когда мы вошли в npm, мы можем опубликовать наш пакет, выполнив эту команду:

npm publish

обратите внимание, что имя пакета должно быть уникальным, если оно не меняет имя пакета в файле package.json.

после публикации вашего пакета вы можете найти его в npm, выполнив поиск по его имени на npmjs.com. если вы хотите, чтобы на странице вашего пакета было полное описание, инструкции или что-то еще, поместите файл readme.md в папку пакета.

Использование вашего нового пакета

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

npm install num-formatter --save

создайте файл index.js, импортируйте и протестируйте пакет:

test/index.js:

const formatNumber = require('num-formatter')
console.log(formatNumber(455000000))

и после запуска кода с «node index.js» мы увидим, что наш пакет работает так, как ожидалось:

node index.js
// 455,000,000

Я надеюсь, что это руководство было полезным, теперь вы можете создавать полезные библиотеки для использования в своих проектах javascript.