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

212 lines
4.4 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
deterministic described classes, refs SD-1969 This cop encourages explit require_dependency calls for ambiguous nested constants in specs. What does that mean? Consider: module Analytics describe Assignments do Depending on what has been required and/or autoloaded, `Assignments` could either resolve to `Analytics::Assignments`, or just the top-level `Assignments`. This is a cause of flickering failures and test-queue woes. This example should either have an explicit `require_dependency` call, or get rid of the module and just do `describe Analytics::Assignments`` Correct all existing ones in the codebase, except for a few ActiveRecord-related ones (the auto-correct isn't quite perfect, i.e. it assumes the file path will be `const_name.underscore`, which is no bueno for things like ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) Test plan: n/a, specs Change-Id: Ic24bf3e0f547ca11c46887d4af92804da091912a Reviewed-on: https://gerrit.instructure.com/98752 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Jon Jensen <jon@instructure.com> QA-Review: Jon Jensen <jon@instructure.com>
2017-01-04 08:52:49 +08:00
AllCops:
TargetRubyVersion: 2.3
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
# 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
upgrade rubocop to 0.46.0 and rubocop-rspec to 1.8.0 note: Astrolabe::Node is now just Rubocop::Node closes CNVS-34077 test plan: rubocop should still lint correctly Change-Id: Id5feb1700ad78cc0b34c6cb90d2a75320b210138 Reviewed-on: https://gerrit.instructure.com/98512 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2016-12-28 14:17:05 +08:00
Style/SpaceBeforeFirstArg:
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
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
upgrade rubocop to 0.46.0 and rubocop-rspec to 1.8.0 note: Astrolabe::Node is now just Rubocop::Node closes CNVS-34077 test plan: rubocop should still lint correctly Change-Id: Id5feb1700ad78cc0b34c6cb90d2a75320b210138 Reviewed-on: https://gerrit.instructure.com/98512 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2016-12-28 14:17:05 +08:00
Style/TrailingCommaInArguments:
Enabled: false
Style/TrailingCommaInLiteral:
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
Enabled: false
upgrade rubocop and rubocop-rspec to latest closes CNVS-34657 test plan: rubocop should still work Change-Id: Ibdd340dd7ba516639ee5b7225449422b324bd33a Reviewed-on: https://gerrit.instructure.com/100831 Tested-by: Jenkins Reviewed-by: Tyler Pickett <tpickett@instructure.com> Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2017-02-01 02:26:34 +08:00
Style/MethodCallWithoutArgsParentheses:
Enabled: false
Style/MethodCallWithArgsParentheses:
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
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
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
Disable lambda style checking cop The cop wants to see stabbies used for single-line lambdas, and the lambda method for mutli-line lambdas. This is dumb cause stabby lambdas should be used everywhere! Change-Id: I6e9c948688b7192a34a0cff37fe1d1cadcbd047f Reviewed-on: https://gerrit.instructure.com/52877 Tested-by: Jenkins Reviewed-by: Jeremy Stanley <jeremy@instructure.com> Reviewed-by: Cody Cutrer <cody@instructure.com> Product-Review: Benjamin Porter <bporter@instructure.com> QA-Review: Benjamin Porter <bporter@instructure.com>
2015-04-28 00:23:45 +08:00
Style/Lambda:
Enabled: false
turn off Rubocop::Cop::Style::WhileUntilModifier The modifier while/until construction should not be preferred. The style guide has been updated to reflect this: https://gollum.instructure.com/Ruby-style-guidelines#While/Until Change-Id: Ib1b8b3cf29d52729ba9d3f9066554fc421d47111 Reviewed-on: https://gerrit.instructure.com/52997 Reviewed-by: Jeremy Stanley <jeremy@instructure.com> Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Strand McCutchen <smccutchen@instructure.com> QA-Review: Strand McCutchen <smccutchen@instructure.com>
2015-04-29 00:27:56 +08:00
Style/WhileUntilModifier:
Enabled: false
Moving ParallelAssignment back to style Change-Id: If7a864309fd97f673c81b1ef2a8a59dcb838fb49 Reviewed-on: https://gerrit.instructure.com/70363 Tested-by: Jenkins Reviewed-by: Jon Jensen <jon@instructure.com> Product-Review: Jon Jensen <jon@instructure.com> QA-Review: Jon Jensen <jon@instructure.com>
2016-01-15 23:44:38 +08:00
Style/ParallelAssignment:
Enabled: false
upgrade rubocop to 0.46.0 and rubocop-rspec to 1.8.0 note: Astrolabe::Node is now just Rubocop::Node closes CNVS-34077 test plan: rubocop should still lint correctly Change-Id: Id5feb1700ad78cc0b34c6cb90d2a75320b210138 Reviewed-on: https://gerrit.instructure.com/98512 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2016-12-28 14:17:05 +08:00
Style/ZeroLengthPredicate:
Enabled: false
Style/SpaceInLambdaLiteral:
Enabled: false
Style/NumericPredicate:
Enabled: false
Style/VariableNumber:
Enabled: false
Style/SpaceInLambdaLiteral:
Enabled: false
lint: tweak some cops Change-Id: I185cc5dbfaafe64f74a511aac1ab9b94bae38d63 Reviewed-on: https://gerrit.instructure.com/98776 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2017-01-05 01:51:58 +08:00
# We may want to enable this when we start working toward Ruby 3
Style/FrozenStringLiteralComment:
Enabled: false
upgrade rubocop to 0.46.0 and rubocop-rspec to 1.8.0 note: Astrolabe::Node is now just Rubocop::Node closes CNVS-34077 test plan: rubocop should still lint correctly Change-Id: Id5feb1700ad78cc0b34c6cb90d2a75320b210138 Reviewed-on: https://gerrit.instructure.com/98512 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2016-12-28 14:17:05 +08:00
spec: get rid of some rubocop-rspec nits * before(:each) is nice since it's often right next to before(:once) * RMessageSpies isn't a thing * don't complain about big blocks (e.g `describe`) Change-Id: I296433cf2478ac3a304a2e20a1a3cd5de6515678 Reviewed-on: https://gerrit.instructure.com/101502 Tested-by: Jenkins Reviewed-by: Cody Cutrer <cody@instructure.com> Product-Review: Jon Jensen <jon@instructure.com> QA-Review: Jon Jensen <jon@instructure.com>
2017-02-09 08:12:05 +08:00
# RSpec cops we don't care about
spec: don't nitpick spies vs. message expectations Change-Id: I380b57bc6ee4e7b8e606e5148fb0468031ccee57 Reviewed-on: https://gerrit.instructure.com/101538 Reviewed-by: Simon Williams <simon@instructure.com> Tested-by: Jenkins Product-Review: Jon Jensen <jon@instructure.com> QA-Review: Jon Jensen <jon@instructure.com>
2017-02-10 01:16:29 +08:00
RSpec/MessageSpies:
Enabled: false
spec: get rid of some rubocop-rspec nits * before(:each) is nice since it's often right next to before(:once) * RMessageSpies isn't a thing * don't complain about big blocks (e.g `describe`) Change-Id: I296433cf2478ac3a304a2e20a1a3cd5de6515678 Reviewed-on: https://gerrit.instructure.com/101502 Tested-by: Jenkins Reviewed-by: Cody Cutrer <cody@instructure.com> Product-Review: Jon Jensen <jon@instructure.com> QA-Review: Jon Jensen <jon@instructure.com>
2017-02-09 08:12:05 +08:00
RSpec/HookArgument:
upgrade rubocop and rubocop-rspec to latest closes CNVS-34657 test plan: rubocop should still work Change-Id: Ibdd340dd7ba516639ee5b7225449422b324bd33a Reviewed-on: https://gerrit.instructure.com/100831 Tested-by: Jenkins Reviewed-by: Tyler Pickett <tpickett@instructure.com> Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2017-02-01 02:26:34 +08:00
Enabled: false
spec: no more empty example groups remove existing ones and prevent new ones Change-Id: I995bf6c328d229846002a79739beb8eb955a8b1b Reviewed-on: https://gerrit.instructure.com/103950 Tested-by: Jenkins Reviewed-by: Landon Wilkins <lwilkins@instructure.com> Product-Review: Landon Wilkins <lwilkins@instructure.com> QA-Review: Landon Wilkins <lwilkins@instructure.com>
2017-03-04 04:08:13 +08:00
# RSpec cops we care extra about
RSpec/EmptyExampleGroup:
Severity: error
spec: de-dup spec descriptions, fixes SD-2181 also prevent them in the future. our test-queue fork currently has a bug where only the last duplicate spec will run, but this is a good idea anyway most of these are just rewordings, but in some cases delete redundant/ identical specs test plan: specs Change-Id: I8f51be55e750cf87ffa8150822f4b80dc99e1eb4 Reviewed-on: https://gerrit.instructure.com/103993 Tested-by: Jenkins Reviewed-by: Landon Wilkins <lwilkins@instructure.com> Product-Review: Landon Wilkins <lwilkins@instructure.com> QA-Review: Landon Wilkins <lwilkins@instructure.com>
2017-03-04 06:26:51 +08:00
RSpec/RepeatedDescription:
Severity: error
spec: no more empty example groups remove existing ones and prevent new ones Change-Id: I995bf6c328d229846002a79739beb8eb955a8b1b Reviewed-on: https://gerrit.instructure.com/103950 Tested-by: Jenkins Reviewed-by: Landon Wilkins <lwilkins@instructure.com> Product-Review: Landon Wilkins <lwilkins@instructure.com> QA-Review: Landon Wilkins <lwilkins@instructure.com>
2017-03-04 04:08:13 +08:00
upgrade rubocop to 0.46.0 and rubocop-rspec to 1.8.0 note: Astrolabe::Node is now just Rubocop::Node closes CNVS-34077 test plan: rubocop should still lint correctly Change-Id: Id5feb1700ad78cc0b34c6cb90d2a75320b210138 Reviewed-on: https://gerrit.instructure.com/98512 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2016-12-28 14:17:05 +08:00
# this isn't good for us because of how we pin dependencies
Bundler/OrderedGems:
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
upgrade rubocop to 0.46.0 and rubocop-rspec to 1.8.0 note: Astrolabe::Node is now just Rubocop::Node closes CNVS-34077 test plan: rubocop should still lint correctly Change-Id: Id5feb1700ad78cc0b34c6cb90d2a75320b210138 Reviewed-on: https://gerrit.instructure.com/98512 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2016-12-28 14:17:05 +08:00
Rails:
Enabled: true
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
upgrade rubocop to 0.46.0 and rubocop-rspec to 1.8.0 note: Astrolabe::Node is now just Rubocop::Node closes CNVS-34077 test plan: rubocop should still lint correctly Change-Id: Id5feb1700ad78cc0b34c6cb90d2a75320b210138 Reviewed-on: https://gerrit.instructure.com/98512 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2016-12-28 14:17:05 +08:00
Style/RescueModifier:
Severity: warning
Style/MultilineMethodCallIndentation:
EnforcedStyle: indented
Style/IndentArray:
EnforcedStyle: consistent
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
add rubocop rules for rspec nesting and http arguments This disables the HttpPositionalArguments rubocop rule, which is invalid for versions of Ruby prior to Ruby 5. This also sets the limit for nested example groups in RSpec to 3, which is a more reasonable limit than the default of 2. test plan: * verify Jenkins passes Change-Id: I8f2badb369d6932923aa4c096c9b9014be19805a Reviewed-on: https://gerrit.instructure.com/100198 Tested-by: Jenkins Reviewed-by: Rob Orton <rob@instructure.com> QA-Review: Jeremy Neander <jneander@instructure.com> Product-Review: Jeremy Neander <jneander@instructure.com>
2017-01-21 22:18:29 +08:00
# these are invalid pre-Rails 5
Rails/HttpPositionalArguments:
Enabled: false
upgrade rubocop and rubocop-rspec to latest closes CNVS-34657 test plan: rubocop should still work Change-Id: Ibdd340dd7ba516639ee5b7225449422b324bd33a Reviewed-on: https://gerrit.instructure.com/100831 Tested-by: Jenkins Reviewed-by: Tyler Pickett <tpickett@instructure.com> Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2017-02-01 02:26:34 +08:00
# these are invalid pre-Ruby 2.4
Performance/RegexpMatch:
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
spec: get rid of some rubocop-rspec nits * before(:each) is nice since it's often right next to before(:once) * RMessageSpies isn't a thing * don't complain about big blocks (e.g `describe`) Change-Id: I296433cf2478ac3a304a2e20a1a3cd5de6515678 Reviewed-on: https://gerrit.instructure.com/101502 Tested-by: Jenkins Reviewed-by: Cody Cutrer <cody@instructure.com> Product-Review: Jon Jensen <jon@instructure.com> QA-Review: Jon Jensen <jon@instructure.com>
2017-02-09 08:12:05 +08:00
Metrics/BlockLength:
Exclude:
- 'gems/*/spec/**/*.rb'
- 'gems/plugins/*/spec_canvas/**/*.rb'
- 'spec/**/*.rb'
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
lint: tweak some cops Change-Id: I185cc5dbfaafe64f74a511aac1ab9b94bae38d63 Reviewed-on: https://gerrit.instructure.com/98776 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2017-01-05 01:51:58 +08:00
RSpec/ExampleLength:
Max: 16
spec: increase rubocop allowed rspec nested groups Change-Id: Ice28cad151efa8f58e45b88eb3b11ac248d07c7b Reviewed-on: https://gerrit.instructure.com/100104 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2017-01-21 00:35:25 +08:00
RSpec/NestedGroups:
upgrade rubocop and rubocop-rspec to latest closes CNVS-34657 test plan: rubocop should still work Change-Id: Ibdd340dd7ba516639ee5b7225449422b324bd33a Reviewed-on: https://gerrit.instructure.com/100831 Tested-by: Jenkins Reviewed-by: Tyler Pickett <tpickett@instructure.com> Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2017-02-01 02:26:34 +08:00
Max: 5
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/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
lint: tweak some cops Change-Id: I185cc5dbfaafe64f74a511aac1ab9b94bae38d63 Reviewed-on: https://gerrit.instructure.com/98776 Reviewed-by: Cody Cutrer <cody@instructure.com> Tested-by: Jenkins Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2017-01-05 01:51:58 +08:00
RSpec/MultipleExpectations:
Enabled: false
upgrade rubocop and rubocop-rspec to latest closes CNVS-34657 test plan: rubocop should still work Change-Id: Ibdd340dd7ba516639ee5b7225449422b324bd33a Reviewed-on: https://gerrit.instructure.com/100831 Tested-by: Jenkins Reviewed-by: Tyler Pickett <tpickett@instructure.com> Product-Review: Simon Williams <simon@instructure.com> QA-Review: Simon Williams <simon@instructure.com>
2017-02-01 02:26:34 +08:00
RSpec/ScatteredSetup:
Enabled: false