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/printer.rb at master · userimack/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 }}
userimack
/
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
/
printer.rb
Copy path
Blame
More file actions
Blame
More file actions
Latest commit
History
History
History
143 lines (118 loc) · 4.01 KB
master
Breadcrumbs
overcommit
/
lib
/
overcommit
/
printer.rb
Copy path
Top
File metadata and controls
Code
Blame
143 lines (118 loc) · 4.01 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
# frozen_string_literal: true
require
'monitor'
module
Overcommit
# Provide a set of callbacks which can be executed as events occur during the
# course of {HookRunner#run}.
class
Printer
attr_reader
:log
def
initialize
(
config
,
logger
,
context
)
@config
=
config
@log
=
logger
@context
=
context
@lock
=
Monitor
.
new
# Need to use monitor so we can have re-entrant locks
synchronize_all_methods
end
# Executed at the very beginning of running the collection of hooks.
def
start_run
log
.
bold
"Running
#{
hook_script_name
}
hooks"
unless
@config
[
'quiet'
]
end
def
nothing_to_run
log
.
debug
"✓ No applicable
#{
hook_script_name
}
hooks to run"
end
def
hook_skipped
(
hook
)
log
.
warning
"Skipping
#{
hook
.
name
}
"
end
def
required_hook_not_skipped
(
hook
)
log
.
warning
"Cannot skip
#{
hook
.
name
}
since it is required"
end
# Executed at the end of an individual hook run.
def
end_hook
(
hook
,
status
,
output
)
# Want to print the header for quiet hooks only if the result wasn't good
# so that the user knows what failed
print_header
(
hook
)
if
(
!
hook
.
quiet?
&& !
@config
[
'quiet'
]
)
||
status
!=
:pass
print_result
(
hook
,
status
,
output
)
end
def
interrupt_triggered
log
.
newline
log
.
error
'Interrupt signal received. Stopping hooks...'
end
# Executed when a hook run was interrupted/cancelled by user.
def
run_interrupted
log
.
newline
log
.
warning
'⚠ Hook run interrupted by user'
log
.
newline
end
# Executed when one or more hooks by the end of the run.
def
run_failed
log
.
newline
log
.
error
"✗ One or more
#{
hook_script_name
}
hooks failed"
log
.
newline
end
# Executed when no hooks failed by the end of the run, but some warned.
def
run_warned
log
.
newline
log
.
warning
"⚠ All
#{
hook_script_name
}
hooks passed, but with warnings"
log
.
newline
end
# Executed when no hooks failed by the end of the run.
def
run_succeeded
unless
@config
[
'quiet'
]
log
.
newline
log
.
success
"✓ All
#{
hook_script_name
}
hooks passed"
log
.
newline
end
end
def
hook_run_failed
(
message
)
log
.
newline
log
.
log
message
log
.
newline
end
private
def
print_header
(
hook
)
hook_name
=
"[
#{
hook
.
name
}
] "
log
.
partial
hook
.
description
log
.
partial
'.'
*
[
70
-
hook
.
description
.
length
-
hook_name
.
length
,
0
]
.
max
log
.
partial
hook_name
end
def
print_result
(
hook
,
status
,
output
)
# rubocop:disable Metrics/CyclomaticComplexity
case
status
when
:pass
log
.
success
'OK'
unless
@config
[
'quiet'
]
||
hook
.
quiet?
when
:warn
log
.
warning
'WARNING'
print_report
(
output
,
:bold_warning
)
when
:fail
log
.
error
'FAILED'
print_report
(
output
,
:bold_error
)
when
:interrupt
log
.
error
'INTERRUPTED'
print_report
(
output
,
:bold_error
)
else
log
.
error
'???'
print_report
(
"Hook returned unknown status `
#{
status
.
inspect
}
` -- ignoring."
,
:bold_error
)
end
end
def
print_report
(
output
,
format
=
:log
)
log
.
send
(
format
,
output
)
unless
output
.
nil?
||
output
.
empty?
end
def
hook_script_name
@context
.
hook_script_name
end
# Get all public methods that were defined on this class and wrap them with
# synchronization locks so we ensure the output isn't interleaved amongst
# the various threads.
def
synchronize_all_methods
methods
=
self
.
class
.
instance_methods
-
self
.
class
.
superclass
.
instance_methods
methods
.
each
do
|
method_name
|
old_method
=
:"old_
#{
method_name
}
"
new_method
=
:"synchronized_
#{
method_name
}
"
self
.
class
.
__send__
(
:alias_method
,
old_method
,
method_name
)
self
.
class
.
send
(
:define_method
,
new_method
)
do
|*
args
|
@lock
.
synchronize
{
__send__
(
old_method
,
*
args
)
}
end
self
.
class
.
__send__
(
:alias_method
,
method_name
,
new_method
)
end
end
end
end
You can’t perform that action at this time.