Skip to content

Commit ee968db

Browse files
author
Tod Beardsley
committed
Include .rubocop.yml from PR rapid7#3649
1 parent bbcd63c commit ee968db

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

.rubocop.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# This list was intially created by analyzing the last three months (51
2+
# modules) committed to Metasploit Framework. Many, many older modules
3+
# will have offenses, but this should at least provide a baseline for
4+
# new modules.
5+
#
6+
# Updates to this file should include a 'Description' parameter for any
7+
# explaination needed.
8+
9+
# inherit_from: .rubocop_todo.yml
10+
11+
Style/ClassLength:
12+
Description: 'Most Metasploit modules are quite large. This is ok.'
13+
Enabled: true
14+
Exclude:
15+
- 'modules/**/*'
16+
17+
Style/Documentation:
18+
Enabled: true
19+
Description: 'Most Metasploit modules do not have class documentation.'
20+
Exclude:
21+
- 'modules/**/*'
22+
23+
Style/Encoding:
24+
Enabled: true
25+
Description: 'We prefer binary to UTF-8.'
26+
EnforcedStyle: 'when_needed'
27+
28+
Style/LineLength:
29+
Description: >-
30+
Metasploit modules often pattern match against very
31+
long strings when identifying targets.
32+
Enabled: true
33+
Max: 180
34+
35+
Style/MethodLength:
36+
Enabled: true
37+
Description: >-
38+
While the style guide suggests 10 lines, exploit definitions
39+
often exceed 200 lines.
40+
Max: 300
41+
42+
Style/NumericLiterals:
43+
Enabled: false
44+
Description: 'This often hurts readability for exploit-ish code.'
45+
46+
Style/SpaceInsideBrackets:
47+
Enabled: false
48+
Description: 'Until module template are final, most modules will fail this.'
49+
50+
Style/StringLiterals:
51+
Enabled: false
52+
Description: 'Single vs double quote fights are largely unproductive.'
53+
54+
Style/WordArray:
55+
Enabled: false
56+
Description: 'Metasploit prefers consistent use of []'

0 commit comments

Comments
 (0)