locommit コマンドは、
Git の ワーキング ディレクトリ（.git フォルダーがあるフォルダー）の外でも
Git の ワーキング ディレクトリ のサブフォルダーでも使える
git status や git diff に相当するコマンドです。
graph LR;
s[ リポジトリの中のコミット ] -- git status or git diff --> d[ Git の ワーキング ディレクトリ の外にあるフォルダー];
または
graph LR;
s[ リポジトリの中のフォルダー ] -- git status or git diff --> d[ 同じリポジトリの中の別のフォルダー ];
最初は、カレント フォルダー およびそのサブフォルダーにあるファイルを
カレント フォルダー の直下の .commit フォルダー にコピーします。
このとき、.gitignore に指定したファイルはコピーされません。
この .commit フォルダーが、git status や git diff の比較対象に相当します。
graph LR;
s[ カレント フォルダー ];
d[ .commit フォルダー ];
s -. .gitignore を踏まえたコピー .-> d;
次に、カレント フォルダー の直下に .commit フォルダー が存在している場合、
カレント フォルダー およびそのサブフォルダーにあるファイルを
カレント フォルダー の直下の .commit_new フォルダー にコピーします。
そしてすぐに、.commit フォルダーと違いがあるファイル名を一覧します。
この動作が、git status や git diff に相当します。
flowchart TD;
s[ カレント フォルダー ];
subgraph
c[ .commit フォルダー ];
d[ .commit_new フォルダー ];
end
s -. .gitignore を踏まえたコピー .-> d;
c <-- 比較 --> d;
- Windows (bash)
- mac
- Linux
- 動作には Git のインストールが必要です。 bash や zsh から git コマンドが使えるようにしてください。
binフォルダーにあるlocommitファイルを bash のパスの通ったフォルダーにコピーしてください。
.gitignore を踏まえたコピーをするときの
locommit コマンドは、パラメーターを指定しません。
状況に応じて動きが変わります。
なお、.gitignore ファイルには、.commit や
.commit_* を指定するべきです。
.gitignore のサンプル:
.commit
.commit_*
カレント フォルダー の直下に .commit フォルダーが無い場合、
カレント フォルダー およびそのサブフォルダーにあるファイルを
カレント フォルダー の直下の .commit フォルダー にコピーします。
このとき、.gitignore に指定したファイルはコピーされません。
この .commit フォルダーが、git status や git diff の比較対象に相当します。
- Git でステージングされていない変更も
.commitフォルダーに入ります .commitフォルダーの中のファイルは、読み取り専用になります- Git の ワーキング フォルダー の外で
locommitコマンドを実行すると.gitフォルダーも作られます。.gitフォルダーが無いとlocommit pushコマンドやlocommit pullコマンドが使えなくなります - Git の ワーキング フォルダー のサブフォルダーで
locommitコマンドを実行すると.gitフォルダーは作られませんが、locommit pushコマンドやlocommit pullコマンドは使えます .commitフォルダー は.gitignoreに指定されているので、 コミットの追加やブランチの変更などを行ってもgit statusやgit diffの比較対象に相当する内容は変化しません
コマンドの例:
$ cd __WorkingDirectory__
$ locommit
Added .git folder and first commit.
Created new ".commit" folder.
This will be treated as base commit.
$ ls .commit
.gitignore
package.json
カレント フォルダー の直下に .commit フォルダーがすでに有る場合、
カレント フォルダー およびそのサブフォルダーにあるファイルを
カレント フォルダー の直下の .commit_new フォルダー にコピーします。
このとき、.gitignore に指定したファイルはコピーされません。
そしてすぐに、.commit フォルダーと違いがあるファイル名を一覧します。
この動作が、git status や git diff に相当します。
- 異なるファイルに関する表示内容は、
diff -qrコマンドと同じです - 親の方向にある
.gitフォルダーに対する git コマンドでステージングされていない変更も.commit_newフォルダーに入ります .commit_newフォルダーの中のファイルは、読み取り専用になります
コマンドの例:
$ cd __WorkingDirectory__
$ locommit
Created new ".commit_new" folder.
Changes for .commit:
Files .commit/package.json and .commit_new/package.json differ
Only in .commit_new: tsconfig.json
$ ls .commit
.gitignore
package.json
$ ls .commit_new
.gitignore
package.json
tsconfig.json
もし、.commit フォルダーの内容と .commit_new フォルダーの内容が
同じ場合、すぐに .commit_new フォルダーが削除されます。
$ cd __WorkingDirectory__
$ locommit
Deleted ".commit_new" folder.
SAME as ".commit" folder.
.git フォルダーがあるフォルダーで locommit コマンドを実行すると
エラーになりますが、--no-git オプションを付けるとエラーになりません。
- git でステージングされていない変更も
.commitフォルダーに入ります .commitフォルダーの中のファイルは、読み取り専用になりません- できた
.commitフォルダー は任意のフォルダーに移動することができます locommit --no-gitコマンドを実行しても.gitフォルダーの内容は変わりませんlocommit --no-gitコマンドを実行したフォルダーでは、locommit pushコマンドやlocommit pullコマンドは使えません
コマンドの例:
$ cd __WorkingDirectory__
$ locommit --no-git
Created new ".commit" folder.
$ ls .commit
.gitignore
package.json
graph RL;
r[ 既存のフォルダー ] -- git clone --> c[ 新しいフォルダー ];
clone コマンドは、既存のフォルダーの直下にある .gitignore ファイルによる
対象外のファイル以外のファイルをコピーして、
.commit フォルダーと .git フォルダーを作ります。
既存のフォルダーや新しいフォルダーは Git の ワーキング ディレクトリ の中でも外でも構いません。
locommit clone __OriginalFolder__ __NewWorkingFolder__
コマンドの例:
$ locommit clone "OriginalFolder" "NewWorkingFolder"
Created new ".commit" folder.
graph RL;
r[ リポジトリの中のフォルダー ] -- git pull or git merge --> c[ カレント フォルダー ];
pull コマンドは、リポジトリ フォルダー の内容を カレント フォルダー に入力するマージをします。
cd __WorkingDirectory__
locommit pull __RepositoryFolderPath__
pull コマンドを実行すると __RepositoryFolderPath__ フォルダーの内容を
カレント フォルダー にマージします。
$ cd __WorkingDirectory__
$ locommit pull _repository
Created ".commit_theirs" folder
Renamed ".commit_new" folder to ".commit_ours" folder
Pull from ".commit_theirs" folder
Auto-merging example.txt
Merge made by the 'ort' strategy.
example.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Files .commit/example.txt and .commit_theirs/example.txt differ
最新の リポジトリ フォルダー の内容が .commit フォルダーの内容から変わっていたときは、
.commit_ours フォルダーと .commit_theirs フォルダーが作られます。
- .commit_ours フォルダー: pull コマンドを実行する前の カレント フォルダー の内容
- .commit_theirs フォルダー: 最新の リポジトリ フォルダー のコピー
pull コマンドは、コンフリクトが起きることがあります。
$ cd __WorkingDirectory__
$ locommit pull _repository
Created ".commit_theirs" folder
Renamed ".commit_new" folder to ".commit_ours" folder
Pull from ".commit_theirs" folder
Auto-merging example.txt
CONFLICT (content): Merge conflict in example.txt
Automatic merge failed; fix conflicts and then commit the result.
Files .commit/example.txt and .commit_theirs/example.txt differ
コンフリクトが解決するまで、locommit コマンドは CONFLICT があることを表示します。
$ cd __WorkingDirectory__
$ locommit
Created new ".commit_new" folder.
Changes for .commit:
Files .commit/example.txt and .commit_new/example.txt differ
CONFLICT:
./example.txt:3: <<<<<<< HEAD
解決したら push コマンドを使います。
push コマンドを使うと、通常の push コマンドの動作の他に、
.commit_ours フォルダーと
.commit_theirs フォルダーの削除も行われます。
pull コマンド に指定した リポジトリ フォルダー の中のファイルのうち、
.gitignore の対象になっているファイルはマージされません。
graph LR;
c[ カレント フォルダー ] -- git push --> r[ リポジトリの中のフォルダー ];
push コマンドは、カレント フォルダー の内容を リポジトリ フォルダー に上書きコピーします。 もし、push コマンドを実行するタイミングが pull コマンドの実行直後ではない場合、 カレント フォルダー 以外の編集によって リポジトリ フォルダー が更新された内容が、 push コマンドによって上書きされて無くなってしまうことに注意してください。
cd __WorkingDirectory__
locommit push __RepositoryFolderPath__
push コマンドを実行すると .commit_new フォルダーの内容を __RepositoryFolderPath__
にコピーして、ファイルの読み取り専用属性をオフにします。
また、.commit_new フォルダーの内容を .commit フォルダーに移動して、
.commit_new フォルダーを削除します。
.commit フォルダーの中にあるファイルのうち、
.commit_new フォルダーの中から無くなったファイルについては、
__RepositoryFolderPath__ フォルダーの中から削除します。
__RepositoryFolderPath__は実際のフォルダーのパスに置き換えてください__RepositoryFolderPath__にあったファイルのうち、.commit_newフォルダーに無いファイルは 削除されます__RepositoryFolderPath__の直下の.gitフォルダーは、変化しません
__RepositoryFolderPath__ に /dev/null を指定すると、コピーを行わず、
.commit_new フォルダーの内容を .commit フォルダーに移動して、
.commit_new フォルダーを削除します。