@sumor/git

git

A Sumor Cloud Tool.
Дополнительная документация

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

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