@sumor/git

git

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

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

Версия NPM Загрузки NPM CI GitHub Тест 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 конфигурация = {
  // url и данные для входа в git
  url: '<git url>', // обязательно
  token: '<git token>', // обязательно, если имя пользователя и пароль не указаны
  username: '<git username>', // обязательно, если токен не указан
  password: '<git password>' // обязательно, если токен не указан
}
const репозиторий = await git(конфигурация, путь)

const commit1 = await репозиторий.currentCommit() // получить текущий коммит
const commitTime1 = await репозиторий.currentCommitTime() // получить время текущего коммита, в миллисекундах

await репозиторий.checkout('<target commit>') // может быть веткой, тегом или коммитом
const commit2 = await репозиторий.currentCommit() // получить текущий коммит

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

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

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

await git(null, путь1)

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