Файл package.json

name реальное название пакета, а не название приложения. Если лень искать адекватное название в общем пространстве имен, можно использовать пространство имен своего аккаунта@hmarketing/test но оно платное.

version версия проекта

description описание проекта

main точка входа для пользователей CommonJS, подключение идет за счет команды require("validate-npm-pc"), папку в проекте лучше сделать логически правильную ./cjs/mask.js

package.json"main": "./cjs/mask.js"

module точка входа для пользователей ES, подключение идет за счет команды import from "validate-npm-pc", папку в проекте лучше сделать логически правильную ./esm/mask.js

package.json"module": "./esm/mask.js"

type определяет тип пакета и то, как Node.js должен интерпретировать файлы с расширением .js. Если файл package.json не содержит этого поля, файлы .js рассматриваются как CommonJS. Значение module указывает Node.js интерпретировать файлы с расширением .js внутри пакета как использующие синтаксис ES

files массив, указывающий какие файлы должны быть включены, когда наш пакет опубликован

keywords список ключевых слов для улучшения поиска нашего пакета на веб сайте NPM

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

bugs цель этого поля, указать на электронную почту поддержки

funding в этом поле вы можете указать любые ссылки для финансирования вашего пакета с открытым исходным кодом

author автор проекта

contributors как и поле author, contributors предоставляет информацию о разработчиках пакета

license тип лицензии

scripts определите команды для создания, выпуска и тестирования проекта

• build этот скрипт компилирует файлы TypeScript в JavaScript, используя tsc запускает две отдельные сборки, используя файлы конфигурации TypeScript, которые мы будем создавать tsconfig.json и tsconfig.cjs.json
• release сценарий сначала запускает build, в случае успеха, публикует изменения, используя changeset publish
• test: запускает наши тесты, используя Jest

devDependencies зависимости, которые нужны для работы нашего модуля в режиме разработки

dependencies зависимости, которые нужны для работы нашего модуля в режиме продакшина, эти зависимости будут установлены при скачивание пакета из NPM хранилищя

peerDependencies зависимости, которые должны быть установлены руками разработчика совместно с вашим пакетом

peerDependenciesMeta можно пометить зависимости как необязательные. В таком случае NPM не будет выдавать предупреждение, если указанный пакет не установлен

bundleDependencies зависимости, которые при публикации пакета объединяются с ним

optionalDependencies позволяет указать некритические зависимости, без которых ваше приложение сможет работать

publishConfig теги приложения

workspaces упрощают работу с монорепозиториями. Монорепозиторий - это способ организации проекта в котором множество подпроектов хранится в одном и том же репозитории

files поле состоит из множества файлов, которые необходимо загрузить в реестр, когда ваш пакет публикуется

main точка входа в программу определена в свойстве. Когда вам требуется пакет, вы фактически импортируете файл, описанный в main свойстве. Есть альтернатива Node.js 12+, известную как exports, который описан ниже

exports вы можете определить точки входа в свой пакет, используя exports поле в качестве альтернативы main. Например, вы можете экспортировать submodule.js файл вашего проекта:

{
"exports": {
".": "./index.js",
"./submodule.js": "./src/submodule.js"
}
}

Также можно экспортировать в зависимости от того, использует ли пользователь пакета require или import:

{
"exports": {
"import": "./index-module.js",
"require": "./index-require.cjs"
},
"type": "module"
}

Условный экспорт часто используется для ESM модулей в качестве обратной совместимости, ключевое слово import можно использовать только в ESM

type поле описывает как в текущем проекте должны рассматриваться .js файлы, если файл package.json не содержит поля type, то файлы .js рассматриваются как CommonJS модули. Если поле type содержит ключ module, значит рассматриваются как ESM модули

browser поле используется вместо main, чтобы указать, должен ли пакет использоваться в браузере вместо проекта Node.js

bin в некоторых случаях необходимо установить пакеты NPM, чтобы их можно было запускать непосредственно из операционной системы, любого каталога. bin указывает исполняемые файлы. Вы можете иметь следующую конфигурацию:

{
"bin": {
"dyte": "./dyte.js",
"myapp": "./cli.js"
}
}

После установки пакета на глобальном уровне, вы сможете запускать команды, dyte и myapp прямо из вашего терминала

directories папка с исполняемыми файлами

repository ссылка на репозиторий в Гите

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