.vim/bundle/ale/doc/ale-ruby.txt

   1 ===============================================================================
   2 ALE Ruby Integration                                         *ale-ruby-options*
   3
   4
   5 ===============================================================================
   6 brakeman                                                    *ale-ruby-brakeman*
   7
   8                                          *ale-options.ruby_brakeman_executable*
   9                                                *g:ale_ruby_brakeman_executable*
  10                                                *b:ale_ruby_brakeman_executable*
  11 ruby_brakeman_executable
  12 g:ale_ruby_brakeman_executable
  13   Type: |String|
  14   Default: `'brakeman'`
  15
  16   Override the invoked brakeman binary. Set this to `'bundle'` to invoke
  17   `'bundle` `exec` brakeman'.
  18
  19                                             *ale-options.ruby_brakeman_options*
  20                                                   *g:ale_ruby_brakeman_options*
  21                                                   *b:ale_ruby_brakeman_options*
  22 ruby_brakeman_options
  23 g:ale_ruby_brakeman_options
  24   Type: |String|
  25   Default: `''`
  26
  27   The contents of this variable will be passed through to brakeman.
  28
  29
  30 ===============================================================================
  31 cspell                                                        *ale-ruby-cspell*
  32
  33 See |ale-cspell-options|
  34
  35
  36 ===============================================================================
  37 debride                                                      *ale-ruby-debride*
  38
  39                                           *ale-options.ruby_debride_executable*
  40                                                 *g:ale_ruby_debride_executable*
  41                                                 *b:ale_ruby_debride_executable*
  42 ruby_debride_executable
  43 g:ale_ruby_debride_executable
  44   Type: |String|
  45   Default: `'debride'`
  46
  47   Override the invoked debride binary. Set this to `'bundle'` to invoke
  48   `'bundle` `exec` debride'.
  49
  50                                              *ale-options.ruby_debride_options*
  51                                                    *g:ale_ruby_debride_options*
  52                                                    *b:ale_ruby_debride_options*
  53 ruby_debride_options
  54 g:ale_ruby_debride_options
  55   Type: |String|
  56   Default: `''`
  57
  58   This variable can be changed to modify flags given to debride.
  59
  60
  61 ===============================================================================
  62 packwerk                                                    *ale-ruby-packwerk*
  63
  64                                          *ale-options.ruby_packwerk_executable*
  65                                                *g:ale_ruby_packwerk_executable*
  66                                                *b:ale_ruby_packwerk_executable*
  67 ruby_packwerk_executable
  68 g:ale_ruby_packwerk_executable
  69   Type: |String|
  70   Default: `'packwerk'`
  71
  72   Override the invoked packwerk binary. Set this to `'bundle'` to invoke
  73   `'bundle` `exec` packwerk'.
  74
  75                                             *ale-options.ruby_packwerk_options*
  76                                                   *g:ale_ruby_packwerk_options*
  77                                                   *b:ale_ruby_packwerk_options*
  78 ruby_packwerk_options
  79 g:ale_ruby_packwerk_options
  80   Type: |String|
  81   Default: `''`
  82
  83   This variable can be changed to modify flags given to packwerk.
  84
  85
  86 ===============================================================================
  87 prettier                                                    *ale-ruby-prettier*
  88
  89 See |ale-javascript-prettier| for information about the available options.
  90
  91
  92 ===============================================================================
  93 rails_best_practices                            *ale-ruby-rails_best_practices*
  94
  95                              *ale-options.ruby_rails_best_practices_executable*
  96                                    *g:ale_ruby_rails_best_practices_executable*
  97                                    *b:ale_ruby_rails_best_practices_executable*
  98 ruby_rails_best_practices_executable
  99 g:ale_ruby_rails_best_practices_executable
 100   Type: |String|
 101   Default: `'rails_best_practices'`
 102
 103   Override the invoked rails_best_practices binary. Set this to `'bundle'` to
 104   invoke `'bundle` `exec` rails_best_practices'.
 105
 106
 107                                 *ale-options.ruby_rails_best_practices_options*
 108                                       *g:ale_ruby_rails_best_practices_options*
 109                                       *b:ale_ruby_rails_best_practices_options*
 110 ruby_rails_best_practices_options
 111 g:ale_ruby_rails_best_practices_options
 112   Type: |String|
 113   Default: `''`
 114
 115   The contents of this variable will be passed through to rails_best_practices.
 116
 117
 118 ===============================================================================
 119 reek                                                            *ale-ruby-reek*
 120
 121                                              *ale-options.ruby_reek_executable*
 122                                                    *g:ale_ruby_reek_executable*
 123                                                    *b:ale_ruby_reek_executable*
 124 ruby_reek_executable
 125 g:ale_ruby_reek_executable
 126   Type: |String|
 127   Default: `'reek'`
 128
 129   Override the invoked reek binary. Set this to `'bundle'` to invoke
 130   `'bundle` `exec` reek'.
 131
 132                                            *ale-options.ruby_reek_show_context*
 133                                                  *g:ale_ruby_reek_show_context*
 134                                                  *b:ale_ruby_reek_show_context*
 135 ruby_reek_show_context
 136 g:ale_ruby_reek_show_context
 137   Type: |Number|
 138   Default: `0`
 139
 140   Controls whether context is included in the linter message. Defaults to off
 141   because context is usually obvious while viewing a file.
 142
 143                                          *ale-options.ruby_reek_show_wiki_link*
 144                                                *g:ale_ruby_reek_show_wiki_link*
 145                                                *b:ale_ruby_reek_show_wiki_link*
 146 ruby_reek_show_wiki_link
 147 g:ale_ruby_reek_show_wiki_link
 148   Type: |Number|
 149   Default: `0`
 150
 151   Controls whether linter messages contain a link to an explanatory wiki page
 152   for the type of code smell. Defaults to off to improve readability.
 153
 154
 155 ===============================================================================
 156 rubocop                                                      *ale-ruby-rubocop*
 157
 158                                           *ale-options.ruby_rubocop_executable*
 159                                                 *g:ale_ruby_rubocop_executable*
 160                                                 *b:ale_ruby_rubocop_executable*
 161 ruby_rubocop_executable
 162 g:ale_ruby_rubocop_executable
 163   Type: |String|
 164   Default: `'rubocop'`
 165
 166   Override the invoked rubocop binary. Set this to `'bundle'` to invoke
 167   `'bundle` `exec` rubocop'.
 168
 169                                              *ale-options.ruby_rubocop_options*
 170                                                    *g:ale_ruby_rubocop_options*
 171                                                    *b:ale_ruby_rubocop_options*
 172 ruby_rubocop_options
 173 g:ale_ruby_rubocop_options
 174   Type: |String|
 175   Default: `''`
 176
 177   This variable can be changed to modify flags given to rubocop.
 178
 179                                     *ale-options.ruby_rubocop_auto_correct_all*
 180                                           *g:ale_ruby_rubocop_auto_correct_all*
 181                                           *b:ale_ruby_rubocop_auto_correct_all*
 182 ruby_rubocop_auto_correct_all
 183 g:ale_ruby_rubocop_auto_correct_all
 184   Type: |Number|
 185   Default: `0`
 186
 187   This variable can be changed to make rubocop to correct all offenses (unsafe).
 188
 189
 190 ===============================================================================
 191 ruby                                                            *ale-ruby-ruby*
 192
 193                                              *ale-options.ruby_ruby_executable*
 194                                                    *g:ale_ruby_ruby_executable*
 195                                                    *b:ale_ruby_ruby_executable*
 196 ruby_ruby_executable
 197 g:ale_ruby_ruby_executable
 198   Type: |String|
 199   Default: `'ruby'`
 200
 201   This variable can be changed to use a different executable for ruby.
 202
 203
 204 ===============================================================================
 205 rufo                                                            *ale-ruby-rufo*
 206
 207                                              *ale-options.ruby_rufo_executable*
 208                                                    *g:ale_ruby_rufo_executable*
 209                                                    *b:ale_ruby_rufo_executable*
 210 ruby_rufo_executable
 211 g:ale_ruby_rufo_executable
 212   Type: |String|
 213   Default: `'rufo'`
 214
 215   Override the invoked rufo binary. This is useful for running rufo from
 216   binstubs or a bundle.
 217
 218
 219 ===============================================================================
 220 solargraph                                                *ale-ruby-solargraph*
 221
 222                                        *ale-options.ruby_solargraph_executable*
 223                                              *g:ale_ruby_solargraph_executable*
 224                                              *b:ale_ruby_solargraph_executable*
 225 ruby_solargraph_executable
 226 g:ale_ruby_solargraph_executable
 227   Type: |String|
 228   Default: `'solargraph'`
 229
 230   Override the invoked solargraph binary. This is useful for running solargraph
 231   from binstubs or a bundle.
 232
 233
 234 ===============================================================================
 235 sorbet                                                        *ale-ruby-sorbet*
 236
 237                                            *ale-options.ruby_sorbet_executable*
 238                                                  *g:ale_ruby_sorbet_executable*
 239                                                  *b:ale_ruby_sorbet_executable*
 240 ruby_sorbet_executable
 241 g:ale_ruby_sorbet_executable
 242   Type: |String|
 243   Default: `'srb'`
 244
 245   Override the invoked sorbet binary. Set this to `'bundle'` to invoke
 246   `'bundle` `exec` srb'.
 247
 248                                               *ale-options.ruby_sorbet_options*
 249                                                     *g:ale_ruby_sorbet_options*
 250                                                     *b:ale_ruby_sorbet_options*
 251 ruby_sorbet_options
 252 g:ale_ruby_sorbet_options
 253   Type: |String|
 254   Default: `''`
 255
 256   This variable can be changed to modify flags given to sorbet.
 257
 258                                       *ale-options.ruby_sorbet_enable_watchman*
 259                                             *g:ale_ruby_sorbet_enable_watchman*
 260                                             *b:ale_ruby_sorbet_enable_watchman*
 261 ruby_sorbet_enable_watchman
 262 g:ale_ruby_sorbet_enable_watchman
 263   Type: |Number|
 264   Default: `0`
 265
 266   Whether or not to use watchman to let the LSP server to know about changes
 267   to files from outside of vim. Defaults to disable watchman because it
 268   requires watchman to be installed separately from sorbet.
 269
 270
 271 ===============================================================================
 272 standardrb                                                *ale-ruby-standardrb*
 273
 274                                        *ale-options.ruby_standardrb_executable*
 275                                              *g:ale_ruby_standardrb_executable*
 276                                              *b:ale_ruby_standardrb_executable*
 277 ruby_standardrb_executable
 278 g:ale_ruby_standardrb_executable
 279   Type: |String|
 280   Default: `'standardrb'`
 281
 282   Override the invoked standardrb binary. Set this to `'bundle'` to invoke
 283   `'bundle` `exec` standardrb'.
 284
 285                                           *ale-options.ruby_standardrb_options*
 286                                                 *g:ale_ruby_standardrb_options*
 287                                                 *b:ale_ruby_standardrb_options*
 288 ruby_standardrb_options
 289 g:ale_ruby_standardrb_options
 290   Type: |String|
 291   Default: `''`
 292
 293   This variable can be changed to modify flags given to standardrb.
 294
 295
 296 ===============================================================================
 297 syntax_tree                                              *ale-ruby-syntax_tree*
 298
 299                                       *ale-options.ruby_syntax_tree_executable*
 300                                             *g:ale_ruby_syntax_tree_executable*
 301                                             *b:ale_ruby_syntax_tree_executable*
 302 ruby_syntax_tree_executable
 303 g:ale_ruby_syntax_tree_executable
 304   Type: |String|
 305   Default: `'stree'`
 306
 307   Override the invoked SyntaxTree binary. Set this to `'bundle'` to invoke
 308   `'bundle` `exec` stree'.
 309
 310                                          *ale-options.ruby_syntax_tree_options*
 311                                                *g:ale_ruby_syntax_tree_options*
 312                                                *b:ale_ruby_syntax_tree_options*
 313 ruby_syntax_tree_options
 314 g:ale_ruby_syntax_tree_options
 315   Type: |String|
 316   Default: `''`
 317
 318   This variable can be changed to modify flags given to SyntaxTree.
 319
 320
 321 ===============================================================================
 322 rubyfmt                                                       *ale-ruby-rubyfmt*
 323
 324                                           *ale-options.ruby_rubyfmt_executable*
 325                                                 *g:ale_ruby_rubyfmt_executable*
 326                                                  *b:ale_ruby_rubyfmt_executable*
 327 ruby_rubyfmt_executable
 328 g:ale_ruby_rubyfmt_executable
 329   Type: |String|
 330   Default: `'rubyfmt'`
 331
 332   This option can be changed to change the path for `rubyfmt`.
 333
 334                                              *ale-options.ruby_rubyfmt_options*
 335                                                    *g:ale_ruby_rubyfmt_options*
 336                                                     *b:ale_ruby_rubyfmt_options*
 337 ruby_rubyfmt_options
 338 g:ale_ruby_rubyfmt_options
 339   Type: |String|
 340   Default: `''`
 341
 342   This option can be changed to pass extra options to `'rubyfmt'`.
 343
 344
 345 ===============================================================================
 346   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: