ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
canvas-lms/.rubocop.yml

147 lines
3.0 KiB
YAML
Raw Normal View History

add some ruby linting for jenkins to take advantage of add migration lint as rubocop cops create frozen constant linter find_ids datafixup lint send_later lint lint send_later in predeploys add freeze_constant cop to default config don't forget to include rubocop when running get the rubocop runner into the script lint for wrong algorithm name lint primary key lint remove_column in predeploys get rubocop output as parsed json diff munging for gergich disable a few style cops tweak rubocop setup to allow IDE plugins to work get gergich comment format right shell out to gergich if we're in jenkins-land Change-Id: I6eecc8d8ede17a755c9d9a86121c3658776de9cd Reviewed-on: https://gerrit.instructure.com/51755 Tested-by: Jenkins Reviewed-by: Jason Madsen <jmadsen@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-05 08:49:25 +08:00
require:
- rubocop-rspec
# this odd relative path is so that rubocop works when run without "bundle
# exec", such as from most editors/IDEs.
- ./gems/rubocop-canvas/lib/rubocop_canvas
AllCops:
RunRailsCops: true
# our style changes: disabling style rules we aren't interested in
Style/StringLiterals:
Enabled: false
Style/SignalException:
Enabled: false
Style/SpaceBeforeBlockBraces:
Enabled: false
Style/SpaceInsideBlockBraces:
Enabled: false
Style/NumericLiterals:
Enabled: false
Style/BracesAroundHashParameters:
Enabled: false
Style/SpaceInsideBrackets:
Enabled: false
Style/SpaceInsideHashLiteralBraces:
Enabled: false
Style/PercentLiteralDelimiters:
Enabled: false
Style/SpaceAroundOperators:
Enabled: false
Style/SpaceAfterColon:
Enabled: false
Style/SpaceAfterComma:
Enabled: false
Style/Documentation:
Enabled: false
Style/ClassAndModuleChildren:
Enabled: false
Style/RegexpLiteral:
Enabled: false
Style/EmptyLines:
Enabled: false
Style/EmptyLinesAroundMethodBody:
Enabled: false
Style/EmptyLinesAroundClassBody:
Enabled: false
Style/EmptyLinesAroundModuleBody:
Enabled: false
make gergich a better coworker Change-Id: I9a04d12fc49f6e0095359e5dabbb5f5f18629692 Reviewed-on: https://gerrit.instructure.com/51939 Reviewed-by: Cody Cutrer <cody@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 03:55:31 +08:00
Style/EmptyLinesAroundBlockBody:
Enabled: false
add some ruby linting for jenkins to take advantage of add migration lint as rubocop cops create frozen constant linter find_ids datafixup lint send_later lint lint send_later in predeploys add freeze_constant cop to default config don't forget to include rubocop when running get the rubocop runner into the script lint for wrong algorithm name lint primary key lint remove_column in predeploys get rubocop output as parsed json diff munging for gergich disable a few style cops tweak rubocop setup to allow IDE plugins to work get gergich comment format right shell out to gergich if we're in jenkins-land Change-Id: I6eecc8d8ede17a755c9d9a86121c3658776de9cd Reviewed-on: https://gerrit.instructure.com/51755 Tested-by: Jenkins Reviewed-by: Jason Madsen <jmadsen@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-05 08:49:25 +08:00
Style/GuardClause:
Enabled: false
Style/RedundantSelf:
Enabled: false
Style/SpaceAroundEqualsInParameterDefault:
Enabled: false
Style/SingleSpaceBeforeFirstArg:
Enabled: false
Style/EmptyLinesAroundAccessModifier:
Enabled: false
Style/IfUnlessModifier:
Enabled: false
Style/WordArray:
Enabled: false
Style/PercentQLiterals:
Enabled: false
Style/IndentHash:
Enabled: false
make gergich a better coworker Change-Id: I9a04d12fc49f6e0095359e5dabbb5f5f18629692 Reviewed-on: https://gerrit.instructure.com/51939 Reviewed-by: Cody Cutrer <cody@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 03:55:31 +08:00
Style/DoubleNegation:
Enabled: false
Style/TrailingComma:
Enabled: false
Style/MethodCallParentheses:
Enabled: false
better conditional configuration for rubocop and also remove a useless newline linter Change-Id: I875ed410bc5b54484af503312f75b7021323060a Reviewed-on: https://gerrit.instructure.com/51988 Reviewed-by: Simon Williams <simon@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 22:43:59 +08:00
Style/TrailingBlankLines:
Enabled: false
disable indentation linting Change-Id: I0c78d81afa3d41063d071ad6d8d88ef5a1c596df Reviewed-on: https://gerrit.instructure.com/52000 Reviewed-by: Simon Williams <simon@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-11 00:52:01 +08:00
Style/IndentationConsistency:
Enabled: false
Style/IndentationWidth:
Enabled: false
Ignore parameters unaligned in rlint Change-Id: I52def3db787cfc60bc35a6340c8a87818d8ec1fa Reviewed-on: https://gerrit.instructure.com/52044 Reviewed-by: Mike Nomitch <mnomitch@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-14 02:20:55 +08:00
Style/AlignParameters:
Enabled: false
rubocop: remove abc size and changes to severities This commit removes the ostentatious AbcSize metric from rubocop, and changes the following severities: - Style/RescueModifier from convention to warning - Lint/AmbiguousRegexpLiteral from warning to convention - Performance/Detect from convention to warning Change-Id: I6737b4feafaab2d4f94a44cf5f750e8c1779ca38 Reviewed-on: https://gerrit.instructure.com/52220 Reviewed-by: Cameron Matheson <cameron@instructure.com> Reviewed-by: Jeremy Stanley <jeremy@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-15 06:47:24 +08:00
Style/RescueModifier:
Severity: warning
tone down some noisy style complaints Change-Id: I13490195e05df00d58c190761711fe6002b7d6cd Reviewed-on: https://gerrit.instructure.com/52310 Reviewed-by: James Williams <jamesw@instructure.com> Tested-by: Jenkins Product-Review: Jeremy Stanley <jeremy@instructure.com> QA-Review: Jeremy Stanley <jeremy@instructure.com>
2015-04-16 04:49:06 +08:00
Style/DotPosition:
Enabled: false
Style/TrailingWhitespace:
Enabled: false
Style/MultilineOperationIndentation:
Enabled: false
Style/AlignHash:
Enabled: false
Style/AlignParameters:
Enabled: false
rubocop: remove abc size and changes to severities This commit removes the ostentatious AbcSize metric from rubocop, and changes the following severities: - Style/RescueModifier from convention to warning - Lint/AmbiguousRegexpLiteral from warning to convention - Performance/Detect from convention to warning Change-Id: I6737b4feafaab2d4f94a44cf5f750e8c1779ca38 Reviewed-on: https://gerrit.instructure.com/52220 Reviewed-by: Cameron Matheson <cameron@instructure.com> Reviewed-by: Jeremy Stanley <jeremy@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-15 06:47:24 +08:00
# Rails style changes
make rlint handle Time.now.utc correctly Change-Id: If2facabedd06c8f16466eebd045988a401834ea1 Reviewed-on: https://gerrit.instructure.com/52036 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-14 00:16:46 +08:00
Rails/TimeZone:
Enabled: false
gergich tweaks * pass additional arguments to script/rlint --heavy -- --additional-args * disable a rails cop * lower style cop to info severity Change-Id: I5cbc94bfc503ae48c635ccb77f66b60f564e1b08 Reviewed-on: https://gerrit.instructure.com/52867 Tested-by: Jenkins Reviewed-by: Ethan Vizitei <evizitei@instructure.com> Product-Review: Cody Cutrer <cody@instructure.com> QA-Review: Cody Cutrer <cody@instructure.com>
2015-04-27 23:39:18 +08:00
# accessors are often defined in terms of read_attribute
Rails/ReadWriteAttribute:
Enabled: false
better conditional configuration for rubocop and also remove a useless newline linter Change-Id: I875ed410bc5b54484af503312f75b7021323060a Reviewed-on: https://gerrit.instructure.com/51988 Reviewed-by: Simon Williams <simon@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 22:43:59 +08:00
rubocop: remove abc size and changes to severities This commit removes the ostentatious AbcSize metric from rubocop, and changes the following severities: - Style/RescueModifier from convention to warning - Lint/AmbiguousRegexpLiteral from warning to convention - Performance/Detect from convention to warning Change-Id: I6737b4feafaab2d4f94a44cf5f750e8c1779ca38 Reviewed-on: https://gerrit.instructure.com/52220 Reviewed-by: Cameron Matheson <cameron@instructure.com> Reviewed-by: Jeremy Stanley <jeremy@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-15 06:47:24 +08:00
# Lint changes
Lint/AmbiguousRegexpLiteral:
Severity: convention
tone down some noisy style complaints Change-Id: I13490195e05df00d58c190761711fe6002b7d6cd Reviewed-on: https://gerrit.instructure.com/52310 Reviewed-by: James Williams <jamesw@instructure.com> Tested-by: Jenkins Product-Review: Jeremy Stanley <jeremy@instructure.com> QA-Review: Jeremy Stanley <jeremy@instructure.com>
2015-04-16 04:49:06 +08:00
Lint/UselessAssignment:
Severity: convention
Rubocop: Flag debuggers and prys as errors Change-Id: I9463bf8e5e725ef51f4924b97451bc378b85216e Reviewed-on: https://gerrit.instructure.com/52825 Reviewed-by: Ethan Vizitei <evizitei@instructure.com> Tested-by: Jenkins Product-Review: Benjamin Porter <bporter@instructure.com> QA-Review: Benjamin Porter <bporter@instructure.com>
2015-04-25 03:27:58 +08:00
Lint/Debugger:
Severity: error
gergich tweaks * pass additional arguments to script/rlint --heavy -- --additional-args * disable a rails cop * lower style cop to info severity Change-Id: I5cbc94bfc503ae48c635ccb77f66b60f564e1b08 Reviewed-on: https://gerrit.instructure.com/52867 Tested-by: Jenkins Reviewed-by: Ethan Vizitei <evizitei@instructure.com> Product-Review: Cody Cutrer <cody@instructure.com> QA-Review: Cody Cutrer <cody@instructure.com>
2015-04-27 23:39:18 +08:00
Lint/EndAlignment:
Severity: convention
rubocop: remove abc size and changes to severities This commit removes the ostentatious AbcSize metric from rubocop, and changes the following severities: - Style/RescueModifier from convention to warning - Lint/AmbiguousRegexpLiteral from warning to convention - Performance/Detect from convention to warning Change-Id: I6737b4feafaab2d4f94a44cf5f750e8c1779ca38 Reviewed-on: https://gerrit.instructure.com/52220 Reviewed-by: Cameron Matheson <cameron@instructure.com> Reviewed-by: Jeremy Stanley <jeremy@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-15 06:47:24 +08:00
# Performance changes
Performance/Detect:
Severity: warning
better conditional configuration for rubocop and also remove a useless newline linter Change-Id: I875ed410bc5b54484af503312f75b7021323060a Reviewed-on: https://gerrit.instructure.com/51988 Reviewed-by: Simon Williams <simon@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 22:43:59 +08:00
# these need better configuration than the default:
Style/AndOr:
EnforcedStyle: conditionals
make gergich a better coworker Change-Id: I9a04d12fc49f6e0095359e5dabbb5f5f18629692 Reviewed-on: https://gerrit.instructure.com/51939 Reviewed-by: Cody Cutrer <cody@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 03:55:31 +08:00
# these don't make sense pre-Rails 4
Rails/FindBy:
Enabled: false
back off rails 4 rubocop Change-Id: I6b833430f224051c93c2b36803bc4cfc1ce2376c Reviewed-on: https://gerrit.instructure.com/51986 Reviewed-by: Matthew Wheeler <mwheeler@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 21:37:58 +08:00
Rails/ActionFilter:
Enabled: false
make gergich a better coworker Change-Id: I9a04d12fc49f6e0095359e5dabbb5f5f18629692 Reviewed-on: https://gerrit.instructure.com/51939 Reviewed-by: Cody Cutrer <cody@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 03:55:31 +08:00
# Things we may want to tighten down later
colorize rlint output Change-Id: I357a15e38c454991efd556491cd8f047a07f701a Reviewed-on: https://gerrit.instructure.com/52008 Reviewed-by: Braden Anderson <braden@instructure.com> Product-Review: Braden Anderson <braden@instructure.com> QA-Review: Braden Anderson <braden@instructure.com> Tested-by: Jenkins
2015-04-11 02:29:31 +08:00
Metrics/AbcSize:
rubocop: remove abc size and changes to severities This commit removes the ostentatious AbcSize metric from rubocop, and changes the following severities: - Style/RescueModifier from convention to warning - Lint/AmbiguousRegexpLiteral from warning to convention - Performance/Detect from convention to warning Change-Id: I6737b4feafaab2d4f94a44cf5f750e8c1779ca38 Reviewed-on: https://gerrit.instructure.com/52220 Reviewed-by: Cameron Matheson <cameron@instructure.com> Reviewed-by: Jeremy Stanley <jeremy@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-15 06:47:24 +08:00
Enabled: false
make gergich a better coworker Change-Id: I9a04d12fc49f6e0095359e5dabbb5f5f18629692 Reviewed-on: https://gerrit.instructure.com/51939 Reviewed-by: Cody Cutrer <cody@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 03:55:31 +08:00
Metrics/LineLength:
back off, gergich Change-Id: Id6b537dbfe139a9e63079d2cc3d04a08ad72c8cd Reviewed-on: https://gerrit.instructure.com/51966 Reviewed-by: Cody Cutrer <cody@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 06:29:09 +08:00
Max: 120
make gergich a better coworker Change-Id: I9a04d12fc49f6e0095359e5dabbb5f5f18629692 Reviewed-on: https://gerrit.instructure.com/51939 Reviewed-by: Cody Cutrer <cody@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 03:55:31 +08:00
Metrics/MethodLength:
back off, gergich Change-Id: Id6b537dbfe139a9e63079d2cc3d04a08ad72c8cd Reviewed-on: https://gerrit.instructure.com/51966 Reviewed-by: Cody Cutrer <cody@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 06:29:09 +08:00
Max: 16
colorize rlint output Change-Id: I357a15e38c454991efd556491cd8f047a07f701a Reviewed-on: https://gerrit.instructure.com/52008 Reviewed-by: Braden Anderson <braden@instructure.com> Product-Review: Braden Anderson <braden@instructure.com> QA-Review: Braden Anderson <braden@instructure.com> Tested-by: Jenkins
2015-04-11 02:29:31 +08:00
Metrics/CyclomaticComplexity:
Max: 10
back off, gergich Change-Id: Id6b537dbfe139a9e63079d2cc3d04a08ad72c8cd Reviewed-on: https://gerrit.instructure.com/51966 Reviewed-by: Cody Cutrer <cody@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-10 06:29:09 +08:00
RSpec/InstanceVariable:
Enabled: false
RSpec/ExampleWording:
Enabled: false
RSpec/DescribedClass:
Enabled: false
Plugins UI needs 'dynamic_form' closes CNVS-19816 make sure we have a spec to check rendering of the plugins setting view from now on, and explicitly require 'dynamic_form' in the plugins controller also removes a linter that shouldn't be on for describing classes (or views in this case) TEST PLAN: 1) go configure any plugin 2) it should not explode Change-Id: I32e58a524ddb18b922ba79e20e9e7b9c1f2a8f07 Reviewed-on: https://gerrit.instructure.com/52216 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins QA-Review: Ethan Vizitei <evizitei@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com>
2015-04-15 06:21:54 +08:00
RSpec/DescribeClass:
Enabled: false
add boyscout mode for rlint also back off the hash syntax rule Change-Id: Ib5daec82b013cb5ca3abeec7705f3838cc438d06 Reviewed-on: https://gerrit.instructure.com/52023 Reviewed-by: Jason Madsen <jmadsen@instructure.com> Product-Review: Ethan Vizitei <evizitei@instructure.com> QA-Review: Ethan Vizitei <evizitei@instructure.com> Tested-by: Ethan Vizitei <evizitei@instructure.com>
2015-04-11 04:49:20 +08:00
Style/HashSyntax:
Enabled: false