@sumor/git

git

Sumor Cloud - инструмент.
Дополнительная документация

Библиотека версий git, легко создающая версию и генерирующая конкретный пакет с окружением.

Версия NPM Загрузки NPM GitHub CI GitHub Тест GitHub Покрытие GitHub Аудит

Установка

npm i @sumor/git --save

Предварительные требования

Версия Node.JS

Требуется версия Node.JS 18.x или выше.

Требуется модуль Node.JS ES

Поскольку этот пакет написан с использованием модуля ES, измените следующий код в вашем файле package.json:

{
  "type": "module"
}

Использование

import git from '@sumor/git'
const config = {
  // git url и учетные данные
  url: '<git url>', // обязательно
  token: '<git token>', // обязательно, если имя пользователя и пароль не предоставлены
  username: '<git username>', // обязательно, если токен не предоставлен
  password: '<git password>' // обязательно, если токен не предоставлен
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // получить текущий коммит

const commit2 = await repository.checkout('<целевой коммит>') // может быть веткой, тегом или коммитом

// Если установлено Github Desktop, вы можете использовать следующую команду для открытия в нем в Github Desktop
await repository.github()

Создание нового локального репозитория

Когда вы передаете null в качестве конфигурации, будет создан новый репозиторий по указанному пути.

await git(null, path1)

// использование для локального репозитория
const repository = await git({ url: path1 }, path2)