@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のトークン>', // 必須、ユーザ名とパスワードが指定されていない場合
  username: '<gitのユーザ名>', // 必須、トークンが指定されていない場合
  password: '<gitのパスワード>' // 必須、トークンが指定されていない場合
}
const repository = await git(config, パス)

const commit1 = await repository.currentCommit() // 現在のコミットを取得

const commit2 = await repository.checkout('<対象のコミット>') // ブランチ、タグ、またはコミットを指定できます

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

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

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

await git(null, パス1)

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