Skip to content

Commit

Permalink
Fix command flags formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
krzysiek1507 authored and bbatsov committed Jun 12, 2020
1 parent 82931b1 commit 9338db1
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions docs/modules/ROOT/pages/usage/basic_usage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,10 @@ $ rubocop -h
| `-a/--auto-correct`
| Auto-correct certain offenses. _Experimental_, use with caution. See xref:auto_correct.adoc[Auto-correct].

| ` --auto-gen-config`
| `--auto-gen-config`
| Generate a configuration file acting as a TODO list.

| ` --[no-]color`
| `--[no-]color`
| Force color output on or off.

| `-c/--config`
Expand All @@ -136,25 +136,25 @@ $ rubocop -h
| `-d/--debug`
| Displays some extra debug output.

| ` --disable-pending-cops`
| `--disable-pending-cops`
| Run without pending cops.

| ` --disable-uncorrectable`
| `--disable-uncorrectable`
| Used with --auto-correct to annotate any offenses that do not support autocorrect with `rubocop:todo` comments.

| `-D/--[no-]display-cop-names`
| Displays cop names in offense messages. Default is true.

| ` --display-only-fail-level-offenses`
| `--display-only-fail-level-offenses`
| Only output offense messages at the specified `--fail-level` or above

| ` --enable-pending-cops`
| `--enable-pending-cops`
| Run with pending cops.

| ` --except`
| `--except`
| Run all cops enabled by configuration except the specified cop(s) and/or departments.

| ` --exclude-limit`
| `--exclude-limit`
| Limit how many individual files `--auto-gen-config` can list in `Exclude` parameters, default is 15.

| `-E/--extra-details`
Expand All @@ -166,22 +166,22 @@ $ rubocop -h
| `-F/--fail-fast`
| Inspect files in order of modification time and stops after first file with offenses.

| ` --fail-level`
| `--fail-level`
| Minimum link:configuration.md#severity[severity] for exit with error code. Full severity name or upper case initial can be given. Normally, auto-corrected offenses are ignored. Use `A` or `autocorrect` if you'd like them to trigger failure.

| ` --force-exclusion`
| `--force-exclusion`
| Force excluding files specified in the configuration `Exclude` even if they are explicitly passed as arguments.

| ` --only-recognized-file-types`
| `--only-recognized-file-types`
| Inspect files given on the command line only if they are listed in `AllCops`/`Include` parameters of user configuration or default configuration.

| `-h/--help`
| Print usage information.

| ` --ignore-parent-exclusion`
| `--ignore-parent-exclusion`
| Ignores all Exclude: settings from all .rubocop.yml files present in parent folders. This is useful when you are importing submodules when you want to test them without being affected by the parent module's rubocop settings.

| ` --init`
| `--init`
| Generate a .rubocop.yml file in the current directory.

| `-l/--lint`
Expand All @@ -190,31 +190,31 @@ $ rubocop -h
| `-L/--list-target-files`
| List all files RuboCop will inspect.

| ` --no-auto-gen-timestamp`
| `--no-auto-gen-timestamp`
| Don't include the date and time when --auto-gen-config was run in the config file it generates

| ` --no-offense-counts`
| `--no-offense-counts`
| Don't show offense counts in config file generated by --auto-gen-config

| ` --only`
| `--only`
| Run only the specified cop(s) and/or cops in the specified departments.

| `-o/--out`
| Write output to a file instead of STDOUT.

| ` --parallel`
| `--parallel`
| Use available CPUs to execute inspection in parallel.

| `-r/--require`
| Require Ruby file (see link:extensions.md#loading-extensions[Loading Extensions]).

| ` --safe`
| `--safe`
| Run only safe cops.

| ` --safe-auto-correct`
| `--safe-auto-correct`
| Omit cops annotated as "not safe". See xref:auto_correct.adoc[Auto-correct].

| ` --show-cops`
| `--show-cops`
| Shows available cops and their configuration.

| `-s/--stdin`
Expand Down

0 comments on commit 9338db1

Please sign in to comment.