@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('<target commit>') // ブランチ、タグ、またはコミットを指定

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

新しいローカルリポジトリを作成する

config として null を渡すと、指定したパスに新しいリポジトリが作成されます。

await git(null, path1)

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