@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 トークン>', // ユーザー名とパスワードが指定されていない場合、必須
  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()

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

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

await git(null, path1)

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