@sumor/git

git

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

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

NPM Version NPM Downloads 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と認証情報
  url: '<git url>', // 必須
  token: '<git token>', // ユーザー名とパスワードが提供されていない場合は必須
  username: '<git username>', // トークンが提供されていない場合は必須
  password: '<git password>' // トークンが提供されていない場合は必須
}
const repository = await git(config, path)

const commit1 = await repository.currentCommit() // 現在のコミットを取得
const commitTime1 = await repository.currentCommitTime() // 現在のコミットのタイムスタンプを取得(ミリ秒単位)

await repository.checkout('<target commit>') // ブランチまたはタグまたはコミットを指定できます
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)