File: git-ime.in

package info (click to toggle)
imediff 3.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 820 kB
  • sloc: python: 6,397; sh: 904; xml: 336; makefile: 28
file content (422 lines) | stat: -rwxr-xr-x 13,003 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
#!/bin/sh -e
#############################################################################
#
# git-ime: Split changes on a file into multiple git commits
#
#   Copyright (c) 2015-2025 Osamu Aoki
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of
# the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public
# License along with this program; if not, write to the Free
# Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
# Boston, MA 02110-1301, USA.
#
#############################################################################
# Formatted with shfmt

IMEDIFF="/usr/bin/imediff"
AUTO="No"
DEBUG="--loglevel=WARNING --logfile=.git/imediff.log"
KEEP="No"
NOTAG="No"
OPTQ=""
VERBOSE=""

vecho() {
	if [ -n "$VERBOSE" ]; then
		echo "$*" >&2
	fi
}

help() {

	echo "\
${0##*/}, $(imediff --version | sed -n -e '1s/^[^(]*//p')

Usage: ${0##*/} [-a] [-D] [-k] [-n] [-q] [-v]

DESCRIPTION: Split changes into multiple git commits

    --auto|-a
        force to auto-split for line-block-split by imediff
    --delete|-d
        remove all git-ime tags
    --debug|-D
        run imediff with --loglevel=DEBUG --logfile=.git/imediff.log
    --keep|-k
        keep original commit message text as much
    --notag|-n
        don't make git tags
    --quiet|-q
        run git command with -q
    --verbose|-v
        verbose print to STDERR for internal details

Copyright (c) 2015-2024 Osamu Aoki
Version: @@version@@
"
}

git_commit_with_prefix() {
	PREFIX="$1"
	if [ -z "$PREFIX" ]; then
		PREFIX="$(date -u +%Y%m%d-%H%M%S)"
	fi
	##if [ "$(head -n 1 ".git/COMMIT_EDITMSG_ORIG")" = "-" ]; then
	if [ "$KEEP" = "Yes" ]; then
		# commit message = prefix with old message
		echo -n "$PREFIX: " >".git/COMMIT_EDITMSG"
		cat ".git/COMMIT_EDITMSG_ORIG" >>".git/COMMIT_EDITMSG"
	else
		# commit message = prefix
		echo "$PREFIX" >".git/COMMIT_EDITMSG"
	fi
	# Drop old comments
	git commit $OPTQ --no-edit -F ".git/COMMIT_EDITMSG"
}

# Possible status letters for git diff
#   A: addition of a file **supported**
#   C: copy of a file into a new one
#   D: deletion of a file **supported**
#   M: modification of the contents or mode of a file **supported**
#   R: renaming of a file **supported** R??? similarity
#   T: change in the type of the file (regular file, symbolic link or submodule)
#   U: file is unmerged (you must complete the merge before it can be committed)
#   X: "unknown" change type (most probably a bug, please report it)
split_by_file_loop() {
	vecho "I: split_by_file_loop"
	vecho '------------------------------------------------------'
	vecho 'I: git reset --hard --quiet "$HASH_LAST" # HEAD^'
	git reset --hard --quiet "$HASH_LAST"
	vecho '------------------------------------------------------'
	git diff --name-status $HASH_LAST $HASH_HEAD | while read status src dst; do
		vecho "I: status='$status' src='$src' dst='$dst'"
		case $status in
		A) # add
			git checkout $OPTQ $HASH_HEAD "$src"
			git add $OPTQ "$src"
			git_commit_with_prefix "$src (add)"
			vecho "I: git add/commit $src (add)"
			;;
		M) # mod
			git checkout $OPTQ $HASH_HEAD "$src"
			git add $OPTQ "$src"
			git_commit_with_prefix "$src (mod)"
			vecho "I: git add/commit $src (mod)"
			;;
		D) # delete
			git rm $OPTQ -f "$src"
			git_commit_with_prefix "$src (del)"
			vecho "I: git add/commit $src (del)"
			;;
		T) # type
			git checkout $OPTQ $HASH_HEAD "$src"
			git add $OPTQ "$src"
			git_commit_with_prefix "$src (type)"
			vecho "I: git add/commit $src (type)"
			;;
		C*) # copy (?? HOW to get this case??)
			mkdir -p "${dst%/*}"
			cp -f "$src" "$dst"
			git add $OPTQ "$dst"
			git_commit_with_prefix "$dst (copy from $src)"
			vecho "I: git add/commit $dst (copy from $src)"
			git checkout $OPTQ $HASH_HEAD "$dst"
			if ! git diff --quiet HEAD -- "$dst"; then
				git add $OPTQ "$dst"
				git_commit_with_prefix "$dst (mod)"
				vecho "I: git add/commit $dst (mod)"
			fi
			;;
		R*) # rename
			git mv "$src" "$dst"
      git add $OPTQ "$dst"
			git_commit_with_prefix "$dst (rename from $src)"
			git checkout $OPTQ $HASH_HEAD "$dst"
			vecho "I: git add/commit $dst (rename from $src)"
			if ! git diff --quiet HEAD -- "$dst"; then
				git add $OPTQ "$dst"
				git_commit_with_prefix "$dst (mod)"
				vecho "I: git add/commit $dst (mod)"
			fi
			;;
		*) # unknown
			echo "E: unknown status='$status' src='$src' dst='$dst'" >&2
			;;
		esac
	done
	vecho "I: split by file into $N_FLNMS commits ... done"
}

split_by_imediff_loop() {
	vecho "I: split_by_imediff_loop"
	vecho '------------------------------------------------------'
	vecho 'I: git reset --hard --quiet "$HASH_LAST" # HEAD^'
	git reset --hard --quiet "$HASH_LAST"
	vecho '------------------------------------------------------'
	read status src dst <<EOF
$(git diff --name-status $HASH_LAST $HASH_HEAD)
EOF
	vecho "I: status='$status' src='$src' dst='$dst'"
	case $status in
	A)
		FLNM="$src"
		git checkout $OPTQ $HASH_HEAD "$FLNM"
		git add $OPTQ "$FLNM"
		git_commit_with_prefix "$src (add)"
		;;
	M)
		FLNM="$src"
		git checkout $OPTQ $HASH_LAST "$FLNM"
		mv -f "$FLNM" "$FLNM.tmp_a"
		git checkout $OPTQ $HASH_HEAD "$FLNM"
		mv -f "$FLNM" "$FLNM.tmp_b"
		FLNM_a="$FLNM.tmp_a"
		FLNM_b="$FLNM.tmp_b"
		status="M"
		;;
	D) # delete
		FLNM="$src"
		git rm $OPTQ -f "$FLNM"
		git_commit_with_prefix "$FLNM (delete)"
		vecho "I: commit for $FLNM (delete)"
		;;
	T)
		FLNM="$src"
		git checkout $OPTQ $HASH_LAST "$FLNM"
		mv -f "$FLNM" "$FLNM.tmp_a"
		git checkout $OPTQ $HASH_HEAD "$FLNM"
		mv -f "$FLNM" "$FLNM.tmp_b"
		;;
	C*) # copy
		FLNM="$dst"
		mkdir -p "${dst%/*}"
		cp -f "$src" "$dst"
		git add $OPTQ "$FLNM"
		git_commit_with_prefix "$dst (copy from $src)"
		git checkout $OPTQ $HASH_HEAD "$FLNM"
		if ! git diff --quiet HEAD -- "$dst"; then
			mv -f "$FLNM" "$FLNM.tmp_b"
			git checkout $OPTQ $HASH_LAST "$FLNM"
			mv -f "$FLNM" "$FLNM.tmp_a"
			status="M"
		fi
		;;
	R*) # rename
		FLNM="$dst"
		git mv "$src" "$dst"
		git add $OPTQ "$FLNM"
		git_commit_with_prefix "$dst (rename from $src)"
		git checkout $OPTQ $HASH_HEAD "$FLNM"
		if ! git diff --quiet HEAD -- "$dst"; then
			mv -f "$FLNM" "$FLNM.tmp_b"
			git checkout $OPTQ $HASH_LAST "$FLNM"
			mv -f "$FLNM" "$FLNM.tmp_a"
			status="M"
		fi
		;;
	*) # unknown
		echo "E: unknown status='$status' src='$src' dst='$dst'" >&2
		;;
	esac
	if [ "$status" != "M" ]; then
		vecho "I: no looping"
	else
		REPEAT=0
		vecho "I: ready to loop running imediff AUTO=$AUTO"
		while true; do
			REPEAT=$((REPEAT + 1))
			if [ "$AUTO" != "Yes" ]; then
				vecho "I: manual IMEDIFF process"
				vecho "$IMEDIFF $DEBUG -o $FLNM $FLNM.tmp_a $FLNM.tmp_b"
				"$IMEDIFF" $DEBUG -o "$FLNM" "$FLNM.tmp_a" "$FLNM.tmp_b"
			else
				vecho "I: auto IMEDIFF process"
				vecho "$IMEDIFF $DEBUG --macro \"Abw\" --non-interactive -o $FLNM $FLNM.tmp_a $FLNM.tmp_b"
				"$IMEDIFF" $DEBUG --macro "Abw" --non-interactive -o "$FLNM" "$FLNM.tmp_a" "$FLNM.tmp_b"
			fi
			chmod --reference "$FLNM.tmp_b" "$FLNM"
			if diff -q "$FLNM.tmp_a" "$FLNM"; then
				vecho "I: no commit for $FLNM (try imediff again)"
			elif diff -q "$FLNM" "$FLNM.tmp_b"; then
				vecho "I: no more changes for $FLNM"
				git add $OPTQ "$FLNM"
				git_commit_with_prefix "$FLNM #$REPEAT"
				vecho "I: commit for $FLNM by imediff #$REPEAT"
				rm -f "$FLNM.tmp_a" "$FLNM.tmp_b"
				break
			else
				vecho "I: found changes for $FLNM"
				git add $OPTQ "$FLNM"
				git_commit_with_prefix "$FLNM #$REPEAT"
				vecho "I: commit for $FLNM by imediff #$REPEAT"
				mv "$FLNM" "$FLNM.tmp_a"
			fi
		done
		vecho "I: finish to loop running imediff AUTO=$AUTO"
		rm -f "$FLNM.tmp_b" "$FLNM.tmp_a"
	fi
}

#############################################################################
# Parse args
#############################################################################
if [ ! -x $IMEDIFF ]; then
	echo "E: install the $(basename $IMEDIFF) program." >&2
	exit 1
fi

while true; do
	case "$1" in
	--auto | -a)
		AUTO="Yes"
		;;
	--delete | -d)
		git tag -d $(git tag|grep "^git-ime-")
		exit
		;;
	--debug | -D)
		DEBUG="--loglevel=DEBUG --logfile=.git/imediff.log"
		;;
	--keep | -k)
		KEEP="Yes"
		;;
	--notag | -n)
		NOTAG="Yes"
		;;
	--quiet | -q)
		OPTQ="--quiet"
		;;
	--verbose | -v)
		VERBOSE="Yes"
		;;
	'')
		break
		;;
	*)
		help
		exit
		;;
	esac
	shift
done

#############################################################################
# Move to the base of the git repo having .git/
#############################################################################
d="$(pwd)"
while [ ! -d "$d/.git" ] && [ "$d" != / ]; do d="$(readlink -f "$d/..")"; done
if [ "$d" = "/" ]; then
	echo "Not in the git repository, aborting..." >&2
	exit 1
fi
GIT_BASEDIR="$d"
cd "$GIT_BASEDIR" >/dev/null
unset d

#############################################################################
# Let's operate only on the really clean repo
#############################################################################
## check for staged for the next commit vs. HEAD
if ! git diff --cached --quiet; then
	echo "E: staged changes exist.  Commit them or un-stage them first" >&2
	echo "   --- option 1: git commit"
	git commit $OPTQ --dry-run
	echo "   --- option 2: git rm --cached"
	git rm $OPTQ --dry-run --cached
	exit 1
fi

## check for working tree vs. HEAD
if ! git diff --quiet; then
	echo "E: local changes found.  Commit them or reset them first" >&2
	echo "   --- option 1: git commit --all"
	if [ "$OPTQ" != "-q" ] && [ "$OPTQ" != "--quiet" ]; then
		# somehow --quiet doesn't work with --all
		git commit --dry-run --all
	fi
	echo "   --- option 2: git reset --hard HEAD"
	exit 1
fi

## check for untracked files
if [ "$(git ls-files . --exclude-standard --others --directory | wc -l)" != "0" ]; then
	echo "E: untracked files exist.  Forcefully clean them all first" >&2
	echo "   --- option 1: git clean -d -f -x"
	git clean $OPTQ --dry-run -d -f -x | sed -e "s/^Would/       This would/"
	echo "   --- option 2: git add <file> ; git commit (if you need them)"
	exit 1
fi

#############################################################################
# Ensure to be tagged for recovery
#############################################################################
# Check if we are in rebase.
# https://stackoverflow.com/questions/3921409/how-to-know-if-there-is-a-git-rebase-in-progress
if [ -d "$(git rev-parse --git-path rebase-merge 2>/dev/null)" ] ||
	[ -d "$(git rev-parse --git-path rebase-apply 2>/dev/null)" ]; then
	NOTAG="Yes"
fi

# Tag if not tagged
if [ "$NOTAG" = "No" ] && ! git describe --tags --exact-match HEAD 2>/dev/null; then
	git tag -f "git-ime-a$(date -u +%Y%m%d-%H%M%S)"
fi

#############################################################################
# Check how many files changed
#############################################################################
# In this process, moved files should be counted as one dZZZZZZelete and one add
# This is not safe for file name with whitespace(SPC, TAB, NL) in it.
# But without using --name-status, we overlook moved origin file.
HASH_LAST="$(git rev-parse --short=8 --quiet HEAD^)"
HASH_HEAD="$(git rev-parse --short=8 --quiet HEAD)"
FLNMS=$(git diff --name-status "$HASH_LAST" "$HASH_HEAD" | cut -f 2-)
N_FLNMS="$(echo "$FLNMS" | wc -w)"
vecho "I: split into $N_FLNMS commits:"
# Set COMMIT_EDITMSG (repo may have unrelated COMMIT_EDITMSG)
vecho '------------------------------------------------------'
vecho 'I: git commit --amend --no-edit -q'
git commit $OPTQ --amend --no-edit -q
if [ ! -r ".git/COMMIT_EDITMSG" ]; then
	: >".git/COMMIT_EDITMSG"
	KEEP="No"
fi
# Drop old comments
grep -v -e '^#' ".git/COMMIT_EDITMSG" >".git/COMMIT_EDITMSG_ORIG"
if [ "$(head -n 1 ".git/COMMIT_EDITMSG")" = "-" ]; then
	KEEP="No"
fi
vecho '------------------------------------------------------'
vecho "I: original commit message:"
vecho "$(sed -e 's/^/I: > /' .git/COMMIT_EDITMSG_ORIG)"
vecho '------------------------------------------------------'
if [ "$N_FLNMS" = "0" ]; then
	echo "E: no changes found from HEAD^ to HEAD" >&2
	exit 1
elif [ "$N_FLNMS" = "1" ]; then
	split_by_imediff_loop
else                # multiple files
	split_by_file_loop # set $FLNM
fi

#############################################################################
# Ensure to be tagged for recovery (we expect git rebase to follow)
#############################################################################

if [ "$NOTAG" = "No" ] && ! git describe --tags --exact-match HEAD 2>/dev/null; then
	git tag -f "git-ime-z$(date -u +%Y%m%d-%H%M%S)"
fi
rm -f ".git/COMMIT_EDITMSG_ORIG"

# vim:se tw=78 ai sts=2 sw=2 noet: