Перейти к содержанию

Реестр пакетов NPM

Для работы с реестром NPM, необходимо получить транспортный токен Gitflic. С инструкцией по получению токена можно ознакомиться на странице.

В документации ниже встречается атрибут {домен_gitflic} На его место необходимо указать домен, в зависимости от версии:

  • для SaaS версии registry.gitflic.ru

  • для Self-Hosted localhost:8080

Домен и порт для self-hosted версии может отличаться.

Настройка реестра NPM

Для настройки доступа к реестру NPM необходимо использовать файл конфигурации .npmrc. Файл конфигурации настраивается глобально, в домашней директории пользователя ~/.npmrc, или в корне проекта.

Чтобы публиковать или устанавливать пакеты NPM из приватных проектов/компаний, необходимо пройти аутентификацию в реестре пакетов, добавив токен в файл конфигурации.

Путь (URL) до пакетов NPM зависит от уровня доступа:

Уровень URL
Проект http(s)://{домен_gitflic}/project/{ownerAlias}/{projectAlias}/package/-/npm
Компания http(s)://{домен_gitflic}/company/{companyAlias}/package/-/npm
Инстанс http(s)://{домен_gitflic}/registry/package/-/npm
Переменная в URL Описание
ownerAlias Псевдоним владельца проекта
projectAlias Псевдоним проекта
companyAlias Псевдоним компании

Настройка через файл .npmrc

Создайте или отредактируйте файл .npmrc. Необходимо добавить следующие строки:

  • Для реестра проекта
registry=https://{домен_gitflic}/project/{ownerAlias}/{projectAlias}/package/-/npm/
//{домен_gitflic}/project/{ownerAlias}/{projectAlias}/package/-/npm/:_authToken={token}
  • Для реестра компании
registry=https://{домен_gitflic}/company/{companyAlias}/package/-/npm/
//{домен_gitflic}/company/{companyAlias}/package/-/npm/:_authToken={token}
  • Для реестра инстанса
registry=https://{домен_gitflic}/registry/package/-/npm/
//{домен_gitflic}/registry/package/-/npm/:_authToken={token}

Настройка через команды npm

Для заполнения конфигурационного файла можно использовать внутренние команды npm config set:

  • Для реестра проекта
npm config set registry=https://{домен_gitflic}/project/{ownerAlias}/{projectAlias}/package/-/npm/
npm config set -- //{домен_gitflic}/project/{ownerAlias}/{projectAlias}/package/-/npm/:_authToken={token}
  • Для реестра компании
npm config set registry=https://{домен_gitflic}/registry/package/-/npm/
npm config set -- //{домен_gitflic}/company/{companyAlias}/package/-/npm/:_authToken={token}
  • Для реестра инстанса
npm config set registry=https://{домен_gitflic}/registry/package/-/npm/
npm config set -- //{домен_gitflic}/registry/package/-/npm/:_authToken={token}

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

Пример содержания файла после выполнения настройки доступа для реестра NPM на уровне проекта (на разных версиях утилиты, содержимое может отличаться):

registry=https://registry.gitflic.ru/project/gitflicuser/my-project/package/-/npm/
//registry.gitflic.ru/project/gitflicuser/my-project/package/-/npm/:_authToken==802b148c-aaaa-bbbb-cccc-036712b0d269

Установка пакета

Для установки пакета из реестра NPM выполните команду, где name - название вашего пакета:

npm i <name>

или

npm install <name>

Публикация пакета

После настройки доступа к реестру, опубликуйте пакет NPM с помощью команды:

npm publish