Skip to content

Commit fcaaeaf

Browse files
committed
Adding all options from help output to the readme file.
1 parent 344f11f commit fcaaeaf

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,29 @@ Refer to Composer's documentation on how to ensure global binaries are in your P
3434

3535
## Usage
3636

37-
Usage:
38-
39-
```
40-
php vendor/bin/drupal-check [OPTIONS] [DIRS]
41-
```
42-
37+
```
38+
php vendor/bin/drupal-check [options] [--] <path>...
39+
```
4340
Arguments:
44-
45-
* `OPTIONS` - See "Options" for allowed values. Specify multiples in sequence, e.g. `-ad`.
46-
* `DIRS` - One or more directories within the root of a Drupal project.
41+
* `path` - The Drupal code path(s) to inspect
4742

4843
Options:
49-
50-
* `-a` Check analysis
51-
* `-d` Check deprecations (default)
52-
* `-e` Exclude directories. Wildcards work. Separate multiple excluded directories with commas, no spaces. e.g.: \*/tests/codeception/acceptance/\*.php
53-
* `--drupal-root` Path to Drupal root. Fallback option if drupal-check could not identify Drupal root from the provided path(s).
44+
* `--drupal-root[=DRUPAL-ROOT]` - Path to Drupal root.
45+
* `--format[=FORMAT]` - Formatter to use: raw, table, checkstyle, json, or junit [default: "table"]
46+
* `-d, --deprecations` - Check for deprecations
47+
* `-a, --analysis` - Check code analysis
48+
* `-s, --style` - Check code style
49+
* `--php8` - Set PHPStan phpVersion for 8.1 (Drupal 10 requirement)
50+
* `--memory-limit[=MEMORY-LIMIT]` - Memory limit for analysis
51+
* `-e, --exclude-dir[=EXCLUDE-DIR]` - Directories to exclude. Separate multiple directories with a comma, no spaces.
52+
* `--no-progress` - Do not show progress bar, only results
53+
* `-h, --help` - Display this help message
54+
* `-q, --quiet` - Do not output any message
55+
* `-V, --version` - Display this application version
56+
* `--ansi` - Force ANSI output
57+
* `--no-ansi` - Disable ANSI output
58+
* `-n, --no-interaction` - Do not ask any interactive question
59+
* `-v|vv|vvv, --verbose` - Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
5460

5561
Examples:
5662

0 commit comments

Comments
 (0)