Git Diff

outline

• English
• Japanese(日本語)

install

$ npm install @itkyk/git-diff

Wakeup

package.json

{
  "script": {
    "diff": "gitDiff --from origin/master --to reversion --filter ACMR",
    "removeDiff": "gitDiff --remove"
  }
}

npx command

$ npx @itkyk/git-diff --from origin/master --to reversion

$ npx @itkyk/git-diff --remove

Options

| flags | defaultValue | description | |--------|------------------|---------------| | --remove, -r | - | Delete gitDiffTemp directory.Cannot use with other options | | --from, -f <value> | origin/master | Specify branch of before change. | | --to, -t <value> | HEAD | Specify branch of after change. | | --filter | ACMR | Set --diff-filer |

A description of each mode.

default mode

• Gets the diff file between the branches given by --from and --to.
• The retrieved files will be expanded to the gitDiffTemp / folder in the project root.

remove mode

• Delete the gitDiffTemp directory created.

APIs

import {createFiles, removeFiles} from "@itkyk/git-diff";

// create diff files to `gitDiffTemp` directory.
await createFiles("from", "to", "filter");

// remove `gitDiffTemp` directory.
await removeFiles();

インストール

$ npm install @itkyk/git-diff

起動

package.jsonの場合

{
  "script": {
    "diff": "gitDiff --from origin/master --to reversion --filter ACMR",
    "removeDiff": "gitDiff --remove"
  }
}

npxの場合

$ npx @itkyk/git-diff --from origin/master --to reversion

$ npx @itkyk/git-diff --remove

オプション

| flags | defaultValue | description | |--------|------------------|---------------| | --remove, -r | false | 作成されたDiffファイルを削除するモードで起動。ほかオプションとの併用不可。 | | --from, -f <value> | origin/master | 差分を取得する変更前ブランチ名 | | --to, -t <value> | HEAD | 差分を取得する変更後ブランチ名 | | --filter | ACMR | --diff-filterの指定 |

各モードの説明

通常

• --fromと--toで与えたブランチ間の差分ファイルを取得します。
• 取得したファイルは、プロジェクトルートのgitDiffTemp/フォルダに展開されます。

removeモード

• 作成されたgitDiffTempディレクトリを削除します。

APIs

import {createFiles, removeFiles} from "@itkyk/git-diff";

// gitDiffTempディレクトリに差分ファイルを生成します。
await createFiles("from", "to", "filter");

// gitDiffTempディレクトリを削除します。
await removeFiles();