config/enabled.yml in rubocop-0.13.1 vs config/enabled.yml in rubocop-0.14.0

- old
+ new

@@ -1,522 +1,546 @@ # These are all the cops that are enabled in the default configuration. -Encoding: - Description: 'Use UTF-8 as the source file encoding.' +AccessControl: + Description: > + Indent private/protected as deep as defs and keep blank + lines around them. Enabled: true -LineLength: - Description: 'Limit lines to 79 characters.' +Alias: + Description: 'Use alias_method instead of alias.' Enabled: true -MethodLength: - Description: 'Avoid methods longer than 10 lines of code.' +AlignArray: + Description: > + Align the elements of an array literal if they span more than + one line. Enabled: true -Tab: - Description: 'No hard tabs.' +AlignHash: + Description: > + Align the elements of a hash literal if they span more than + one line. Enabled: true -TrailingWhitespace: - Description: 'Avoid trailing whitespace.' +AlignParameters: + Description: > + Align the parameters of a method call if they span more + than one line. Enabled: true -TrailingBlankLines: - Description: 'Checks for superflous trailing blank lines.' +AndOr: + Description: 'Use &&/|| instead of and/or.' Enabled: true -FinalNewline: - Description: 'Checks for a final newline in a source file.' +AsciiIdentifiers: + Description: 'Use only ascii symbols in identifiers.' Enabled: true -CaseIndentation: - Description: 'Indent when as deep as case.' +AsciiComments: + Description: 'Use only ascii symbols in comments.' Enabled: true -EmptyLineBetweenDefs: - Description: 'Use empty lines between defs.' +Attr: + Description: 'Checks for uses of Module#attr.' Enabled: true -EmptyLines: - Description: "Don't use several empty lines in a row." +BeginBlock: + Description: 'Avoid the use of BEGIN blocks.' Enabled: true -SpaceAroundOperators: - Description: 'Use spaces around operators.' +Blocks: + Description: > + Avoid using {...} for multi-line blocks (multiline chaining is + always ugly). + Prefer {...} over do...end for single-line blocks. Enabled: true -SpaceAroundBlockBraces: - Description: 'Use spaces around { and before } in blocks.' +BlockComments: + Description: 'Do not use block comments.' Enabled: true -SpaceInsideParens: - Description: 'No spaces after ( or before ).' +BlockNesting: + Description: 'Avoid excessive block nesting' Enabled: true -SpaceInsideBrackets: - Description: 'No spaces after [ or before ].' +CaseEquality: + Description: 'Avoid explicit use of the case equality operator(===).' Enabled: true -SpaceAfterComma: - Description: 'Use spaces after commas.' +CaseIndentation: + Description: 'Indent when as deep as case.' Enabled: true -SpaceAfterSemicolon: - Description: 'Use spaces after semicolons.' +CharacterLiteral: + Description: 'Checks for uses of character literals.' Enabled: true -SpaceAfterColon: - Description: 'Use spaces after colons.' +ClassLength: + Description: 'Avoid classes longer than 100 lines of code.' Enabled: true -SpaceAfterControlKeyword: - Description: 'Use spaces after if/elsif/unless/while/until/case/when.' +ClassAndModuleCamelCase: + Description: 'Use CamelCase for classes and modules.' Enabled: true -HashSyntax: - Description: > - Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax - { :a => 1, :b => 2 }. +ClassMethods: + Description: 'Use self when defining module/class methods.' Enabled: true -EndOfLine: - Description: 'Use Unix-style line endings.' +ClassVars: + Description: 'Avoid the use of class variables.' Enabled: true -NumericLiterals: - Description: > - Add underscores to large numeric literals to improve their - readability. +CollectionMethods: + Description: 'Preferred collection methods.' Enabled: true -AlignParameters: - Description: > - Align the parameters of a method call if they span more - than one line. +ColonMethodCall: + Description: 'Do not use :: for method call.' Enabled: true +ConstantName: + Description: 'Constants should use SCREAMING_SNAKE_CASE.' + Enabled: true + DefWithParentheses: Description: 'Use def with parentheses when there are arguments.' Enabled: true DefWithoutParentheses: Description: > Omit the parentheses when the method doesn't accept any arguments. Enabled: true -IfWithSemicolon: - Description: 'Never use if x; .... Use the ternary operator instead.' +Documentation: + Description: 'Document classes and non-namespace modules.' Enabled: true -MultilineIfThen: - Description: 'Never use then for multi-line if/unless.' +DotPosition: + Description: 'Checks the position of the dot in multi-line method calls.' Enabled: true -OneLineConditional: - Description: > - Favor the ternary operator(?:) over - if/then/else/end constructs. +EmptyLines: + Description: "Don't use several empty lines in a row." Enabled: true -Blocks: - Description: > - Avoid using {...} for multi-line blocks (multiline chaining is - always ugly). - Prefer {...} over do...end for single-line blocks. +EmptyLineBetweenDefs: + Description: 'Use empty lines between defs.' Enabled: true - -ParameterLists: - Description: 'Avoid parameter lists longer than three or four parameters.' +EmptyLiteral: + Description: 'Prefer literals to Array.new/Hash.new/String.new.' Enabled: true -StringLiterals: - Description: > - Prefer ' strings when you don't need string interpolation or - special symbols. +Encoding: + Description: 'Use UTF-8 as the source file encoding.' Enabled: true - -MultilineTernaryOperator: - Description: > - Avoid multi-line ?: (the ternary operator); - use if/unless instead. +EndBlock: + Description: 'Avoid the use of END blocks.' Enabled: true -NestedTernaryOperator: - Description: 'Use one expression per branch in a ternary operator.' +EndOfLine: + Description: 'Use Unix-style line endings.' Enabled: true -UnlessElse: - Description: > - Never use unless with else. Rewrite these with the positive - case first. +EnsureReturn: + Description: 'Never use return in an ensure block.' Enabled: true -AndOr: - Description: 'Use &&/|| instead of and/or.' +Eval: + Description: 'The use of eval represents a serious security risk.' Enabled: true -WhenThen: - Description: 'Use when x then ... for one-line cases.' +EvenOdd: + Description: 'Favor the use of Fixnum#even? && Fixnum#odd?' Enabled: true -IfUnlessModifier: - Description: > - Favor modifier if/unless usage when you have a - single-line body. +FavorJoin: + Description: 'Use Array#join instead of Array#*.' Enabled: true -WhileUntilModifier: - Description: > - Favor modifier while/until usage when you have a - single-line body. +FavorSprintf: + Description: 'Use sprintf instead of String#%.' Enabled: true - FavorUnlessOverNegatedIf: Description: > Favor unless over if for negative conditions (or control flow or). Enabled: true FavorUntilOverNegatedWhile: Description: 'Favor until over while for negative conditions.' Enabled: true -SpaceAroundEqualsInParameterDefault: - Description: > - Use spaces around the = operator when assigning default - values in def params. +FinalNewline: + Description: 'Checks for a final newline in a source file.' Enabled: true -Lambda: - Description: 'Use the new lambda literal syntax for single-line blocks.' +For: + Description: 'Prefer each over for.' Enabled: true -LambdaCall: - Description: 'Use lambda.call(...) instead of lambda.(...).' +GlobalVars: + Description: 'Do not introduce global variables.' Enabled: true -Proc: - Description: 'Use proc instead of Proc.new.' +HandleExceptions: + Description: "Don't suppress exception." Enabled: true -ParenthesesAroundCondition: +HashMethods: + Description: 'Checks for use of deprecated Hash methods.' + Enabled: true + +HashSyntax: Description: > - Don't use parentheses around the condition of an - if/unless/while. + Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax + { :a => 1, :b => 2 }. Enabled: true -MethodAndVariableSnakeCase: - Description: 'Use snake_case for symbols, methods and variables.' +IfWithSemicolon: + Description: 'Never use if x; .... Use the ternary operator instead.' Enabled: true -ClassAndModuleCamelCase: - Description: 'Use CamelCase for classes and modules.' +IfUnlessModifier: + Description: > + Favor modifier if/unless usage when you have a + single-line body. Enabled: true -CollectionMethods: - Description: 'Preferred collection methods.' +IndentationWidth: + Description: 'Use 2 spaces for indentation.' Enabled: true -For: - Description: 'Prefer each over for.' +Lambda: + Description: 'Use the new lambda literal syntax for single-line blocks.' Enabled: true -SpecialGlobalVars: - Description: 'Avoid Perl-style global variables.' +LambdaCall: + Description: 'Use lambda.call(...) instead of lambda.(...).' Enabled: true -PerlBackrefs: - Description: 'Avoid Perl-style regex back references.' +LineLength: + Description: 'Limit lines to 79 characters.' Enabled: true -ClassVars: - Description: 'Avoid the use of class variables.' +LeadingCommentSpace: + Description: 'Comments should start with a space.' Enabled: true -VariableInterpolation: +Loop: Description: > - Don't interpolate global, instance and class variables - directly in strings. + Use Kernel#loop with break rather than begin/end/until or + begin/end/while for post-loop tests. Enabled: true -Semicolon: - Description: "Don't use semicolons to terminate expressions." +MethodCallParentheses: + Description: 'Do not use parentheses for method calls with no arguments.' Enabled: true -FavorSprintf: - Description: 'Use sprintf instead of String#%.' +MethodLength: + Description: 'Avoid methods longer than 10 lines of code.' Enabled: true -FavorJoin: - Description: 'Use Array#join instead of Array#*.' +MethodName: + Description: 'Use the configured style when naming methods.' Enabled: true -Alias: - Description: 'Use alias_method instead of alias.' +ModuleFunction: + Description: 'Checks for usage of `extend self` in modules.' Enabled: true -Not: - Description: 'Use ! instead of not.' +MultilineBlockChain: + Description: 'Avoid multi-line chains of blocks.' Enabled: true -RescueModifier: - Description: 'Avoid using rescue in its modifier form.' +MultilineIfThen: + Description: 'Never use then for multi-line if/unless.' Enabled: true -EnsureReturn: - Description: 'Never use return in an ensure block.' +MultilineTernaryOperator: + Description: > + Avoid multi-line ?: (the ternary operator); + use if/unless instead. Enabled: true -HandleExceptions: - Description: "Don't suppress exception." +NestedTernaryOperator: + Description: 'Use one expression per branch in a ternary operator.' Enabled: true -AsciiIdentifiers: - Description: 'Use only ascii symbols in identifiers.' +NilComparison: + Description: 'Prefer x.nil? to x == nil.' Enabled: true -AsciiComments: - Description: 'Use only ascii symbols in comments.' +Not: + Description: 'Use ! instead of not.' Enabled: true -BlockComments: - Description: 'Do not use block comments.' +NumericLiterals: + Description: > + Add underscores to large numeric literals to improve their + readability. Enabled: true -RescueException: - Description: 'Avoid rescuing the Exception class.' +OneLineConditional: + Description: > + Favor the ternary operator(?:) over + if/then/else/end constructs. Enabled: true -EmptyLiteral: - Description: 'Prefer literals to Array.new/Hash.new/String.new.' - Enabled: true - OpMethod: Description: 'When defining binary operators, name the argument other.' Enabled: true -ReduceArguments: - Description: 'Name reduce arguments |a, e| (accumulator, element)' +ParameterLists: + Description: 'Avoid parameter lists longer than three or four parameters.' Enabled: true -RegexpLiteral: +ParenthesesAroundCondition: Description: > - Use %r for regular expressions matching more than - `MaxSlashes` '/' characters. - Use %r only for regular expressions matching more than - `MaxSlashes` '/' character. + Don't use parentheses around the condition of an + if/unless/while. Enabled: true -ClassMethods: - Description: 'Use self when defining module/class methods.' +PerlBackrefs: + Description: 'Avoid Perl-style regex back references.' Enabled: true -SingleLineMethods: - Description: 'Avoid single-line methods.' +Proc: + Description: 'Use proc instead of Proc.new.' Enabled: true -WordArray: - Description: 'Use %w or %W for arrays of words.' +RaiseArgs: + Description: 'Checks the arguments passed to raise/fail.' Enabled: true -SpaceInsideHashLiteralBraces: - Description: "Use spaces inside hash literal braces - or don't." +ReduceArguments: + Description: 'Name reduce arguments |a, e| (accumulator, element)' Enabled: true -TrivialAccessors: - Description: 'Prefer attr_* methods to trivial readers/writers.' +RedundantBegin: + Description: "Don't use begin blocks when they are not needed." Enabled: true -LeadingCommentSpace: - Description: 'Comments should start with a space.' +RedundantException: + Description: "Checks for an obsolete RuntimeException argument in raise/fail." Enabled: true -ColonMethodCall: - Description: 'Do not use :: for method call.' +RedundantSelf: + Description: "Don't use self where it's not needed." Enabled: true -GlobalVars: - Description: 'Do not introduce global variables.' +RedundantReturn: + Description: "Don't use return where it's not required." Enabled: true -Eval: - Description: 'The use of eval represents a serious security risk.' +RegexpLiteral: + Description: > + Use %r for regular expressions matching more than + `MaxSlashes` '/' characters. + Use %r only for regular expressions matching more than + `MaxSlashes` '/' character. Enabled: true -SymbolName: - Description: 'Symbol literals should use snake_case.' +RescueModifier: + Description: 'Avoid using rescue in its modifier form.' Enabled: true -ConstantName: - Description: 'Constants should use SCREAMING_SNAKE_CASE.' +RescueException: + Description: 'Avoid rescuing the Exception class.' Enabled: true -AccessControl: - Description: > - Indent private/protected as deep as defs and keep blank - lines around them. +Semicolon: + Description: "Don't use semicolons to terminate expressions." Enabled: true -Loop: +SignalException: + Description: 'Checks for proper usage of fail and raise.' + Enabled: true + +SingleLineMethods: + Description: 'Avoid single-line methods.' + Enabled: true + +SpaceAroundOperators: + Description: 'Use spaces around operators.' + Enabled: true + +SpaceAroundBlockBraces: Description: > - Use Kernel#loop with break rather than begin/end/until or - begin/end/while for post-loop tests. + Checks that block braces have or don't have surrounding space. + For blocks taking parameters, checks that the left brace has + or doesn't have trailing space. Enabled: true -BlockNesting: - Description: 'Avoid excessive block nesting' +SpaceInsideParens: + Description: 'No spaces after ( or before ).' Enabled: true -CaseEquality: - Description: 'Avoid explicit use of the case equality operator(===).' +SpaceInsideBrackets: + Description: 'No spaces after [ or before ].' Enabled: true -Documentation: - Description: 'Document classes and non-namespace modules.' +SpaceAfterComma: + Description: 'Use spaces after commas.' Enabled: true -MethodCallParentheses: - Description: 'Do not use parentheses for method calls with no arguments.' +SpaceAfterMethodName: + Description: > + Never put a space between a method name and the opening + parenthesis. Enabled: true -WhileUntilDo: - Description: 'Checks for redundant do after while or until.' +SpaceAfterSemicolon: + Description: 'Use spaces after semicolons.' Enabled: true -CharacterLiteral: - Description: 'Checks for uses of character literals.' +SpaceAfterColon: + Description: 'Use spaces after colons.' Enabled: true -BeginBlock: - Description: 'Avoid the use of BEGIN blocks.' +SpaceAfterControlKeyword: + Description: 'Use spaces after if/elsif/unless/while/until/case/when.' Enabled: true -EndBlock: - Description: 'Avoid the use of END blocks.' +SpaceAroundEqualsInParameterDefault: + Description: > + Use spaces around the = operator when assigning default + values in def params. Enabled: true -RedundantReturn: - Description: "Don't use return where it's not required." +SpaceBeforeModifierKeyword: + Description: 'Put a space before the modifier keyword.' Enabled: true -RedundantBegin: - Description: "Don't use begin blocks when they are not needed." +SpaceInsideHashLiteralBraces: + Description: "Use spaces inside hash literal braces - or don't." Enabled: true -RedundantSelf: - Description: "Don't use self where it's not needed." +SpecialGlobalVars: + Description: 'Avoid Perl-style global variables.' Enabled: true -DotPosition: - Description: 'Checks the position of the dot in multi-line method calls.' +StringLiterals: + Description: 'Checks if uses of quotes match the configured preference.' Enabled: true -Attr: - Description: 'Checks for uses of Module#attr.' +SymbolName: + Description: 'Symbol literals should use snake_case.' Enabled: true -SignalException: - Description: 'Checks for proper usage of fail and raise.' +Tab: + Description: 'No hard tabs.' Enabled: true -ModuleFunction: - Description: 'Checks for usage of `extend self` in modules.' +TrailingBlankLines: + Description: 'Checks for superflous trailing blank lines.' Enabled: true -NilComparison: - Description: 'Prefer x.nil? to x == nil.' +TrailingWhitespace: + Description: 'Avoid trailing whitespace.' Enabled: true -IndentationWidth: - Description: 'Use 2 spaces for indentation.' +TrivialAccessors: + Description: 'Prefer attr_* methods to trivial readers/writers.' Enabled: true -EvenOdd: - Description: 'Favor the use of Fixnum#even? && Fixnum#odd?' +UnlessElse: + Description: > + Never use unless with else. Rewrite these with the positive + case first. Enabled: true -SpaceAfterMethodName: +VariableInterpolation: Description: > - Never put a space between a method name and the opening - parenthesis. + Don't interpolate global, instance and class variables + directly in strings. Enabled: true -HashMethods: - Description: 'Checks for use of deprecated Hash methods.' +VariableName: + Description: 'Use the configured style when naming variables.' Enabled: true -MultilineBlockChain: - Description: 'Avoid multi-line chains of blocks.' +WhenThen: + Description: 'Use when x then ... for one-line cases.' Enabled: true -AlignHash: +WhileUntilModifier: Description: > - Align the elements of a hash literal if they span more than - one line. + Favor modifier while/until usage when you have a + single-line body. Enabled: true -AlignArray: - Description: > - Align the elements of an array literal if they span more than - one line. +WordArray: + Description: 'Use %w or %W for arrays of words.' Enabled: true -SpaceBeforeModifierKeyword: - Description: 'Put a space before the modifier keyword.' +WhileUntilDo: + Description: 'Checks for redundant do after while or until.' Enabled: true #################### Lint ################################ ### Warnings AssignmentInCondition: Description: "Don't use assignment in conditions." Enabled: true -EndAlignment: - Description: 'Align ends correctly.' - Enabled: true - BlockAlignment: Description: 'Align block ends correctly.' Enabled: true -Void: - Description: 'Possible use of operator/literal/variable in void context.' +CommentAnnotation: + Description: > + Checks formatting of special comments + (TODO, FIXME, OPTIMIZE, HACK, REVIEW). Enabled: true -UnreachableCode: - Description: 'Unreachable code.' +Debugger: + Description: 'Check for debugger calls.' Enabled: true -ShadowingOuterLocalVariable: - Description: > - Do not use the same name as outer local variable - for block arguments or block local variables. +EmptyEnsure: + Description: 'Checks for empty ensure block.' Enabled: true +EndAlignment: + Description: 'Align ends correctly.' + Enabled: true + EndInMethod: Description: 'END blocks should not be placed inside method definitions.' Enabled: true LiteralInCondition: Description: 'Checks of literals used in conditions.' Enabled: true -EmptyEnsure: - Description: 'Checks for empty ensure block.' +ParenthesesAsGroupedExpression: + Description: > + Checks for method calls with a space before the opening + parenthesis. Enabled: true -CommentAnnotation: +ShadowingOuterLocalVariable: Description: > - Checks formatting of special comments - (TODO, FIXME, OPTIMIZE, HACK, REVIEW). + Do not use the same name as outer local variable + for block arguments or block local variables. Enabled: true +Syntax: + Description: 'Reports several basic syntax warnings and invalid syntaxes.' + Enabled: true + +UnreachableCode: + Description: 'Unreachable code.' + Enabled: true + UselessAssignment: Description: 'Checks for useless assignment to a local variable.' Enabled: true UselessSetterCall: @@ -525,13 +549,11 @@ UselessComparison: Description: 'Checks for comparison of something with itself.' Enabled: true -ParenthesesAsGroupedExpression: - Description: > - Checks for method calls with a space before the opening - parenthesis. +Void: + Description: 'Possible use of operator/literal/variable in void context.' Enabled: true ##################### Rails ################################## HasAndBelongsToMany: