File: rank_files_by_commit_counts

package info (click to toggle)
node-stdlib 0.0.96%2Bds1%2B~cs0.0.429-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 421,476 kB
  • sloc: javascript: 1,562,831; ansic: 109,702; lisp: 49,823; cpp: 27,224; python: 7,871; sh: 6,807; makefile: 6,089; fortran: 3,102; awk: 387
file content (150 lines) | stat: -rwxr-xr-x 3,422 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
#!/usr/bin/env bash
#
# @license Apache-2.0
#
# Copyright (c) 2017 The Stdlib Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Counts the number of times each file has been modified (i.e., included in a commit) and prints a ranked list.


# VARIABLES #

# Define a file path filter:
file_path_filter=''

# Define the number of files to show:
num_files=20


# FUNCTIONS #

# Defines an error handler.
#
# $1 - error status
on_error() {
	exit "$1"
}

# Prints usage information.
usage() {
	echo '' >&2
	echo 'Usage: rank_files_by_commit_counts [options]' >&2
	echo '' >&2
	echo 'Options:' >&2
	echo '' >&2
	echo '  -h,    --help                Print this message.' >&2
	echo '         --filter filter       File path filter.' >&2
	echo '  -n,    --numfiles count      Number of files to show.' >&2
	echo '' >&2
}

# Ranks files.
#
# $1 - filter
# $2 - number of files to print
rank() {
	# * `git log`
	#   - Get commit logs, reporting renames (`-M`) and copies (`-C`), and only show the names of modified files.
	# * `grep -v '^$'`
	#   -  Remove empty lines.
	# * `grep "$1"`
	#   - Filter file paths using a provided filter.
	# * `sort`
	#   - Sort in lexicographic order.
	# * `uniq -c`
	#   - Remove and count repeats.
	# * `sort -r`
	#   - Sort in reverse lexicographic order such that higher counts come first.
	# * `head`
	#   - Only show a specified number of files.
	git log --all -M -C --name-only --format='format:' | grep -v '^$' | grep "$1" | sort | uniq -c | sort -r | head -n "$2"
}

# Main execution sequence.
main() {
	rank "${file_path_filter}" "${num_files}"
	exit 0
}

# Parse command-line options...
while :; do
	case "$1" in
		'-h' | '--help')
			usage
			exit 0
			;;

		'-n' | '--numfiles')
			if [[ -n "$2" ]]; then
				num_files="$2"
				shift
			else
				printf 'ERROR: "-n, --numfiles" option requires a non-empty option argument.\n' >&2
				on_error 1
			fi
			;;
		'-n='?* | '--numfiles='?*)
			# Delete everything up to "=" and assign the remainder:
			num_files="${1#*=}"
			;;

		'-n=' | '--numfiles=')
			# Handle empty `-n=` and `--numfiles=` options:
			printf 'ERROR: "-n, --numfiles" option requires a non-empty option argument.\n' >&2
				on_error 1
			;;

		'--filter')
			if [[ -n "$2" ]]; then
				file_path_filter="$2"
				shift
			else
				printf 'ERROR: "--filter" option requires a non-empty option argument.\n' >&2
				on_error 1
			fi
			;;

		'--filter='?*)
			# Delete everything up to "=" and assign the remainder:
			file_path_filter="${1#*=}"
			;;

		'--filter=')
			# Handle empty `--filter=` option:
			printf 'ERROR: "--filter" option requires a non-empty option argument.\n' >&2
				on_error 1
			;;

		'--')
			# End of all options:
			shift
			break
			;;

		-?*)
			printf 'WARNING: unknown option (ignored): %s\n' "$1" >&2
			break
			;;

		*)
			# Default case (e.g., if no more options) break out of loop:
			break
	esac

	shift
done

# Run main:
main