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
|
#! /usr/bin/env bash
set -e -u
# !! EDITS TO THIS FILE ARE LOST DURING UPDATES BY xrst.git/bin/dev_tools.sh !!
# ---------------------------------------------------------------------------
# SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
# SPDX-FileCopyrightText: Bradley M. Bell <bradbell@seanet.com>
# SPDX-FileContributor: 2003-25 Bradley M. Bell
# ---------------------------------------------------------------------------
# bin/git_commit.sh
# Opens your editor with comments about this git commit.
# 1. The git commit log message will not include comment lines.
# 2. The file git_commit.log contains the message for the previous commit
# so that you can read it in and modify it for this commit.
# 3. If typos is installed on your system, it will be used to check for
# errors in git_commit.log. If so, you can read it and modity it
# when you re-run git_commit.sh.
# 4. The branch of the commit is automatically placed a the beginning
# of the first line for the message.
# 5. All the modified files are automatically included in the commit.
# 6. The variable check_git_commit in bin/dev_settings.sh can be used
# to selectively revert certain files before the commit.
# ---------------------------------------------------------------------------
# bash function that echos and executes a command
echo_eval() {
echo $*
eval $*
}
# -----------------------------------------------------------------------------
if [ $# != 0 ]
then
echo 'usage: bin/git_commit.sh: does not expect arguments'
exit 1
fi
if [ "$0" != 'bin/git_commit.sh' ]
then
echo 'bin/git_commit.sh: must execute this script from its parent directory'
exit 1
fi
if [ ! -e './.git' ]
then
echo 'bin/git_commit.sh: cannot find ./.git'
exit 1
fi
#
# grep, sed
source bin/grep_and_sed.sh
#
# check_git_commit
source bin/dev_settings.sh
# -----------------------------------------------------------------------------
# EDITOR
set +u
if [ "$EDITOR" == '' ]
then
echo 'bin/git_commit.sh: EDITOR is not defined.'
exit 1
fi
set -u
# -----------------------------------------------------------------------------
# check_git_commit
echo 's|^...||' > temp.sed
for name in $check_git_commit
do
if [ -f $name ]
then
echo "^$name\$" | $sed -e 's|/|[/]|g' -e 's|.*|/&/p|' >> temp.sed
elif [ -d $name ]
then
echo "^$name/" | $sed -e 's|/|[/]|g' -e 's|.*|/&/p|' >> temp.sed
else
echo "$name in check_git_commit is not a file or directory"
exit 1
fi
done
list=$(
git status --porcelain | $sed -n -f temp.sed
)
for file in $list
do
res=''
while [ "$res" != 'revert' ] && [ "$res" != 'commit' ]
do
read -p "$file: Revert or commit changes [revert/commit] ?" res
done
if [ "$res" == 'revert' ]
then
git reset $file
git checkout $file
fi
done
# -----------------------------------------------------------------------------
# new files
# convert spaces in file names to @@
list=$(
git status --porcelain | $sed -n -e '/^?? /p' | \
$sed -e 's|^?? ||' -e 's|"||g' -e 's| |@@|g'
)
for file in $list
do
# convert @@ in file names back to spaces
file=$(echo $file | $sed -e 's|@@| |g')
res=''
while [ "$res" != 'delete' ] && [ "$res" != 'add' ] && [ "$res" != 'abort' ]
do
read -p "'$file' is unknown to git, [delete/add/abort] ?" res
done
if [ "$res" == 'delete' ]
then
# may be spaces in file name so do not use echo_eval
echo "rm '$file'"
rm "$file"
elif [ "$res" == 'abort' ]
then
echo 'bin/git_commit.sh: aborting'
exit 1
else
git add "$file"
fi
done
# -----------------------------------------------------------------------------
# temp.log
branch=$(git branch --show-current)
cat << EOF > temp.log
$branch:
# 1. Enter message for this commit above this line.
# 2. The message for the previous commit is in git_commit.log (if it exists).
# 3. This commit will abort if the first line does not begin with "$branch:"
# because $branch is the branch for this commit.
# 4. Lines starting with '#' are not included in the message.
# 5. Below is a list of the files for this commit:
EOF
git status --porcelain | $sed -e 's|^|# |' >> temp.log
$EDITOR temp.log
$sed -i -e '/^#/d' temp.log
if ! head -1 temp.log | $grep "^$branch:" > /dev/null
then
echo "Aborting because first line does not begin with $branch:"
echo 'See ./temp.log'
exit 1
fi
if ! head -1 temp.log | $grep "^$branch:.*[^ \t]" > /dev/null
then
echo "Aborting because only white space follow $branch: in first line"
echo 'See ./temp.log'
exit 1
fi
#
# git_commit.log
mv temp.log git_commit.log
if which typos >& /dev/null
then
typos git_commit.log
fi
# -----------------------------------------------------------------------------
# git add
echo_eval git add --all
#
#
# git commit
git commit --file=git_commit.log
#
echo 'bin/git_commit.sh: OK'
exit 0
|
