mirror of
https://github.com/rapid7/metasploit-framework
synced 2024-10-29 18:07:27 +01:00
05f0d09828
On August 15, shuckins-r7 merged the Metasploit 4.10.0 branch (staging/electro-release) into master. Rather than merging with history, he squashed all history into two commits (see149c3ecc63
and82760bf5b3
). We want to preserve history (for things like git blame, git log, etc.). So on August 22, we reverted the commits above (see19ba7772f3
). This merge commit merges the staging/electro-release branch (62b81d6814
) into master (48f0743d1b
). It ensures that any changes committed to master since the original squashed merge are retained. As a side effect, you may see this merge commit in history/blame for the time period between August 15 and August 22.
56 lines
1.5 KiB
YAML
56 lines
1.5 KiB
YAML
# This list was intially created by analyzing the last three months (51
|
|
# modules) committed to Metasploit Framework. Many, many older modules
|
|
# will have offenses, but this should at least provide a baseline for
|
|
# new modules.
|
|
#
|
|
# Updates to this file should include a 'Description' parameter for any
|
|
# explaination needed.
|
|
|
|
# inherit_from: .rubocop_todo.yml
|
|
|
|
Style/ClassLength:
|
|
Description: 'Most Metasploit modules are quite large. This is ok.'
|
|
Enabled: true
|
|
Exclude:
|
|
- 'modules/**/*'
|
|
|
|
Style/Documentation:
|
|
Enabled: true
|
|
Description: 'Most Metasploit modules do not have class documentation.'
|
|
Exclude:
|
|
- 'modules/**/*'
|
|
|
|
Style/Encoding:
|
|
Enabled: true
|
|
Description: 'We prefer binary to UTF-8.'
|
|
EnforcedStyle: 'when_needed'
|
|
|
|
Style/LineLength:
|
|
Description: >-
|
|
Metasploit modules often pattern match against very
|
|
long strings when identifying targets.
|
|
Enabled: true
|
|
Max: 180
|
|
|
|
Style/MethodLength:
|
|
Enabled: true
|
|
Description: >-
|
|
While the style guide suggests 10 lines, exploit definitions
|
|
often exceed 200 lines.
|
|
Max: 300
|
|
|
|
Style/NumericLiterals:
|
|
Enabled: false
|
|
Description: 'This often hurts readability for exploit-ish code.'
|
|
|
|
Style/SpaceInsideBrackets:
|
|
Enabled: false
|
|
Description: 'Until module template are final, most modules will fail this.'
|
|
|
|
Style/StringLiterals:
|
|
Enabled: false
|
|
Description: 'Single vs double quote fights are largely unproductive.'
|
|
|
|
Style/WordArray:
|
|
Enabled: false
|
|
Description: 'Metasploit prefers consistent use of []' |