@sumor/git

git

Инструмент Sumor Cloud.
Больше документации

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

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

Установка

npm i @sumor/git --save

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

Версия Node.JS

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

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

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

{
  "type": "module"
}

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

import git from '@sumor/git'
const config = {
  // git url and credentials
  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)