@sumor/git

git

Sumor Cloudツール。
詳細ドキュメント

gitバージョンライブラリー、簡単にバージョンをパッケージ化し、環境で特定のパッケージを生成します。

NPMバージョン NPMダウンロード数 GitHub CI GitHub Test GitHub Coverage GitHub Audit

インストール

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 and credentials
  url: '<git url>', // 必須
  token: '<git token>', // usernameとpasswordを提供していない場合は必須
  username: '<git username>', // tokenを提供していない場合は必須
  password: '<git password>' // tokenを提供していない場合は必須
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // 現在のコミットを取得
const commitTime1 = await repository.currentCommitTime() // 現在のコミット時刻を取得(ミリ秒単位)

await repository.checkout('<対象のコミット>') // ブランチまたはタグまたはコミットが可能
const commit2 = await repository.currentCommit() // 現在のコミットを取得

// Github Desktopをインストールしている場合、以下のコマンドを使用してGithub Desktopで開くことができます
await repository.github()

新しいローカルリポジトリの作成

configとしてnullを渡すと、ローカルパスに新しいリポジトリが作成されます。

await git(null, path1)

// ローカルリポジトリの使用法
const repository = await git({ url: path1 }, path2)