Home
About
Blog
Products
Forum
Support
Contact
Sunbelt Computer Software
PL/B Language Development and Support
Home
About
Blog
Products
Forum
Support
Contact
overcommit/lib/overcommit/cli.rb at master · ByteDecoder/overcommit · GitHub
Skip to content
Navigation Menu
Sign in
Appearance settings
Platform
AI CODE CREATION
GitHub Copilot
Write better code with AI
GitHub Copilot app
Direct agents from issue to merge
MCP Registry
Integrate external tools
DEVELOPER WORKFLOWS
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Code Quality
Enforce quality at merge
APPLICATION SECURITY
GitHub Advanced Security
Find and fix vulnerabilities
Code security
Secure your code as you build
Secret protection
Stop leaks before they start
EXPLORE
Why GitHub
Documentation
Blog
Changelog
Marketplace
View all features
Solutions
BY COMPANY SIZE
Enterprises
Small and medium teams
Startups
Nonprofits
BY USE CASE
App Modernization
DevSecOps
DevOps
CI/CD
View all use cases
BY INDUSTRY
Healthcare
Financial services
Manufacturing
Government
View all industries
View all solutions
Resources
EXPLORE BY TOPIC
AI
Software Development
DevOps
Security
View all topics
EXPLORE BY TYPE
Customer stories
Events & webinars
Ebooks & reports
Business insights
GitHub Skills
SUPPORT & SERVICES
Documentation
Customer support
Community forum
Trust center
Partners
View all resources
Open Source
COMMUNITY
GitHub Sponsors
Fund open source developers
PROGRAMS
Security Lab
Maintainer Community
GitHub Stars
Archive Program
REPOSITORIES
Topics
Trending
Collections
Enterprise
ENTERPRISE SOLUTIONS
Enterprise platform
AI-powered developer platform
AVAILABLE ADD-ONS
GitHub Advanced Security
Enterprise-grade security features
Copilot for Business
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
Pricing
Search
/
Sign in
Sign up
Appearance settings
You signed in with another tab or window.
Reload
to refresh your session.
You signed out in another tab or window.
Reload
to refresh your session.
You switched accounts on another tab or window.
Reload
to refresh your session.
Dismiss alert
{{ message }}
ByteDecoder
/
overcommit
Public
forked from
sds/overcommit
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Security and quality
Insights
Files
Expand file tree
master
Breadcrumbs
overcommit
/
lib
/
overcommit
/
cli.rb
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
223 lines (182 loc) · 6.15 KB
master
Breadcrumbs
overcommit
/
lib
/
overcommit
/
cli.rb
Copy path
Top
File metadata and controls
Code
Blame
223 lines (182 loc) · 6.15 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
# frozen_string_literal: true
require
'overcommit'
require
'optparse'
module
Overcommit
# Responsible for parsing command-line options and executing appropriate
# application logic based on those options.
class
CLI
# rubocop:disable ClassLength
def
initialize
(
arguments
,
input
,
logger
)
@arguments
=
arguments
@input
=
input
@log
=
logger
@options
=
{
}
Overcommit
::
Utils
.
log
=
logger
end
def
run
parse_arguments
case
@options
[
:action
]
when
:install
,
:uninstall
install_or_uninstall
when
:template_dir
print_template_directory_path
when
:sign
sign
when
:run_all
run_all
end
rescue
Overcommit
::
Exceptions
::
ConfigurationSignatureChanged
=>
ex
puts
ex
exit
78
# EX_CONFIG
rescue
Overcommit
::
Exceptions
::
HookContextLoadError
=>
ex
puts
ex
exit
64
# EX_USAGE
end
private
attr_reader
:log
def
parse_arguments
@parser
=
create_option_parser
begin
@parser
.
parse!
(
@arguments
)
# Default action is to install
@options
[
:action
]
||=
:install
# Unconsumed arguments are our targets
@options
[
:targets
]
=
@arguments
rescue
OptionParser
::
InvalidOption
=>
ex
print_help
@parser
.
help
,
ex
end
end
def
create_option_parser
OptionParser
.
new
do
|
opts
|
opts
.
banner
=
"Usage:
#{
opts
.
program_name
}
[options] [target-repo]"
add_information_options
(
opts
)
add_installation_options
(
opts
)
add_other_options
(
opts
)
end
end
def
add_information_options
(
opts
)
opts
.
on_tail
(
'-h'
,
'--help'
,
'Show this message'
)
do
print_help
opts
.
help
end
opts
.
on_tail
(
'-v'
,
'--version'
,
'Show version'
)
do
print_version
(
opts
.
program_name
)
end
opts
.
on_tail
(
'-l'
,
'--list-hooks'
,
'List installed hooks'
)
do
print_installed_hooks
end
end
def
add_installation_options
(
opts
)
opts
.
on
(
'-u'
,
'--uninstall'
,
'Remove Overcommit hooks from a repository'
)
do
@options
[
:action
]
=
:uninstall
end
opts
.
on
(
'-i'
,
'--install'
,
'Install Overcommit hooks in a repository'
)
do
@options
[
:action
]
=
:install
end
opts
.
on
(
'-f'
,
'--force'
,
'Overwrite any previously installed hooks'
)
do
@options
[
:force
]
=
true
end
opts
.
on
(
'-r'
,
'--run'
,
'Run pre-commit hook against all git tracked files'
)
do
@options
[
:action
]
=
:run_all
end
end
def
add_other_options
(
opts
)
opts
.
on
(
'-s'
,
'--sign [hook]'
,
'Update hook signatures'
,
String
)
do
|
hook_to_sign
|
@options
[
:hook_to_sign
]
=
hook_to_sign
if
hook_to_sign
.
is_a?
(
String
)
@options
[
:action
]
=
:sign
end
opts
.
on
(
'-t'
,
'--template-dir'
,
'Print location of template directory'
)
do
@options
[
:action
]
=
:template_dir
end
end
def
install_or_uninstall
if
Array
(
@options
[
:targets
]
)
.
empty?
@options
[
:targets
]
=
[
Overcommit
::
Utils
.
repo_root
]
.
compact
end
if
@options
[
:targets
]
.
empty?
log
.
warning
'You are not in a git repository.'
log
.
log
'You must either specify the path to a repository or '
\
'change your current directory to a repository.'
halt
64
# EX_USAGE
end
@options
[
:targets
]
.
each
do
|
target
|
begin
Installer
.
new
(
log
)
.
run
(
target
,
@options
)
rescue
Overcommit
::
Exceptions
::
InvalidGitRepo
=>
error
log
.
warning
"Invalid repo
#{
target
}
:
#{
error
}
"
halt
69
# EX_UNAVAILABLE
rescue
Overcommit
::
Exceptions
::
PreExistingHooks
=>
error
log
.
warning
"Unable to install into
#{
target
}
:
#{
error
}
"
halt
73
# EX_CANTCREAT
end
end
end
def
print_template_directory_path
puts
File
.
join
(
Overcommit
::
HOME
,
'template-dir'
)
halt
end
def
print_help
(
message
,
error
=
nil
)
log
.
error
"
#{
error
}
\n
"
if
error
log
.
log
message
halt
(
error
?
64
:
0
)
# 64 = EX_USAGE
end
def
print_version
(
program_name
)
log
.
log
"
#{
program_name
}
#{
Overcommit
::
VERSION
}
"
halt
end
# Prints the hooks available in the current repo and whether they're
# enabled/disabled.
def
print_installed_hooks
config
.
all_hook_configs
.
each
do
|
hook_type
,
hook_configs
|
print_hooks_for_hook_type
(
config
,
hook_configs
,
hook_type
)
end
halt
end
def
print_hooks_for_hook_type
(
repo_config
,
hook_configs
,
hook_type
)
log
.
log
"
#{
hook_type
}
:"
hook_configs
.
each
do
|
hook_name
,
config
|
log
.
partial
"
#{
hook_name
}
: "
if
config
[
'enabled'
]
log
.
success
(
'enabled'
,
true
)
else
log
.
error
(
'disabled'
,
true
)
end
if
repo_config
.
plugin_hook?
(
hook_type
,
hook_name
)
log
.
warning
(
' (plugin)'
)
else
log
.
newline
end
end
end
def
sign
if
@options
[
:hook_to_sign
]
context
=
Overcommit
::
HookContext
.
create
(
@options
[
:hook_to_sign
]
,
config
,
@arguments
,
@input
)
Overcommit
::
HookLoader
::
PluginHookLoader
.
new
(
config
,
context
,
log
)
.
update_signatures
else
log
.
log
'Updating signature for configuration file...'
config
(
verify
:
false
)
.
update_signature!
end
halt
end
def
run_all
empty_stdin
=
File
.
open
(
File
::
NULL
)
# pre-commit hooks don't take input
context
=
Overcommit
::
HookContext
.
create
(
'run-all'
,
config
,
@arguments
,
empty_stdin
)
config
.
apply_environment!
(
context
,
ENV
)
printer
=
Overcommit
::
Printer
.
new
(
config
,
log
,
context
)
runner
=
Overcommit
::
HookRunner
.
new
(
config
,
log
,
context
,
printer
)
status
=
runner
.
run
halt
(
status
?
0
:
65
)
end
# Used for ease of stubbing in tests
def
halt
(
status
=
0
)
exit
status
end
# Returns the configuration for this repository.
def
config
(
options
=
{
}
)
@config
||=
Overcommit
::
ConfigurationLoader
.
new
(
log
,
options
)
.
load_repo_config
end
end
end
You can’t perform that action at this time.