github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/ruby-client/rubocop.mustache (about)

     1  # This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
     2  # Automatically generated by OpenAPI Generator (https://openapi-generator.tech)
     3  AllCops:
     4    TargetRubyVersion: 2.4
     5    # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
     6    # to ignore them, so only the ones explicitly set in this file are enabled.
     7    DisabledByDefault: true
     8    Exclude:
     9      - '**/templates/**/*'
    10      - '**/vendor/**/*'
    11      - 'actionpack/lib/action_dispatch/journey/parser.rb'
    12  
    13  # Prefer &&/|| over and/or.
    14  Style/AndOr:
    15    Enabled: true
    16  
    17  # Align `when` with `case`.
    18  Layout/CaseIndentation:
    19    Enabled: true
    20  
    21  # Align comments with method definitions.
    22  Layout/CommentIndentation:
    23    Enabled: true
    24  
    25  Layout/ElseAlignment:
    26    Enabled: true
    27  
    28  Layout/EmptyLineAfterMagicComment:
    29    Enabled: true
    30  
    31  # In a regular class definition, no empty lines around the body.
    32  Layout/EmptyLinesAroundClassBody:
    33    Enabled: true
    34  
    35  # In a regular method definition, no empty lines around the body.
    36  Layout/EmptyLinesAroundMethodBody:
    37    Enabled: true
    38  
    39  # In a regular module definition, no empty lines around the body.
    40  Layout/EmptyLinesAroundModuleBody:
    41    Enabled: true
    42  
    43  Layout/FirstArgumentIndentation:
    44    Enabled: true
    45  
    46  # Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
    47  Style/HashSyntax:
    48    Enabled: false
    49  
    50  # Method definitions after `private` or `protected` isolated calls need one
    51  # extra level of indentation.
    52  Layout/IndentationConsistency:
    53    Enabled: true
    54    EnforcedStyle: indented_internal_methods
    55  
    56  # Two spaces, no tabs (for indentation).
    57  Layout/IndentationWidth:
    58    Enabled: true
    59  
    60  Layout/LeadingCommentSpace:
    61    Enabled: true
    62  
    63  Layout/SpaceAfterColon:
    64    Enabled: true
    65  
    66  Layout/SpaceAfterComma:
    67    Enabled: true
    68  
    69  Layout/SpaceAroundEqualsInParameterDefault:
    70    Enabled: true
    71  
    72  Layout/SpaceAroundKeyword:
    73    Enabled: true
    74  
    75  Layout/SpaceAroundOperators:
    76    Enabled: true
    77  
    78  Layout/SpaceBeforeComma:
    79      Enabled: true
    80  
    81  Layout/SpaceBeforeFirstArg:
    82      Enabled: true
    83  
    84  Style/DefWithParentheses:
    85    Enabled: true
    86  
    87  # Defining a method with parameters needs parentheses.
    88  Style/MethodDefParentheses:
    89    Enabled: true
    90  
    91  Style/FrozenStringLiteralComment:
    92    Enabled: false
    93    EnforcedStyle: always
    94  
    95  # Use `foo {}` not `foo{}`.
    96  Layout/SpaceBeforeBlockBraces:
    97    Enabled: true
    98  
    99  # Use `foo { bar }` not `foo {bar}`.
   100  Layout/SpaceInsideBlockBraces:
   101    Enabled: true
   102  
   103  # Use `{ a: 1 }` not `{a:1}`.
   104  Layout/SpaceInsideHashLiteralBraces:
   105    Enabled: true
   106  
   107  Layout/SpaceInsideParens:
   108    Enabled: true
   109  
   110  # Check quotes usage according to lint rule below.
   111  #Style/StringLiterals:
   112  #  Enabled: true
   113  #  EnforcedStyle: single_quotes
   114  
   115  # Detect hard tabs, no hard tabs.
   116  Layout/Tab:
   117    Enabled: true
   118  
   119  # Blank lines should not have any spaces.
   120  Layout/TrailingEmptyLines:
   121    Enabled: true
   122  
   123  # No trailing whitespace.
   124  Layout/TrailingWhitespace:
   125    Enabled: false
   126  
   127  # Use quotes for string literals when they are enough.
   128  Style/RedundantPercentQ:
   129    Enabled: true
   130  
   131  # Align `end` with the matching keyword or starting expression except for
   132  # assignments, where it should be aligned with the LHS.
   133  Layout/EndAlignment:
   134    Enabled: true
   135    EnforcedStyleAlignWith: variable
   136    AutoCorrect: true
   137  
   138  # Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
   139  Lint/RequireParentheses:
   140    Enabled: true
   141  
   142  Style/RedundantReturn:
   143    Enabled: true
   144    AllowMultipleReturnValues: true
   145  
   146  Style/Semicolon:
   147    Enabled: true
   148    AllowAsExpressionSeparator: true