Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme does not match actual options allowed in command. #287

Closed
dan612 opened this issue May 12, 2023 · 0 comments · Fixed by #288
Closed

Readme does not match actual options allowed in command. #287

dan612 opened this issue May 12, 2023 · 0 comments · Fixed by #288

Comments

@dan612
Copy link
Contributor

dan612 commented May 12, 2023

How is drupal-check installed?
drupal-check is installed as a dependency to my project

Environment:

  • OS: macOS
  • PHP Version: 8.1
  • Drupal core: 9.5.8

Describe the bug
When viewing the readme on Github there are only a few options presented:

-a Check analysis
-d Check deprecations (default)
-e Exclude directories. Wildcards work. Separate multiple excluded directories with commas, no spaces. e.g.: */tests/codeception/acceptance/*.php
--drupal-root Path to Drupal root. Fallback option if drupal-check could not identify Drupal root from the provided path(s).

When in fact there are quite a few more options that can be passed here:

Description:
  Checks a Drupal site

Usage:
  check [options] [--] <path>...

Arguments:
  path                               The Drupal code path(s) to inspect

Options:
      --drupal-root[=DRUPAL-ROOT]    Path to Drupal root.
      --format[=FORMAT]              Formatter to use: raw, table, checkstyle, json, or junit [default: "table"]
  -d, --deprecations                 Check for deprecations
  -a, --analysis                     Check code analysis
  -s, --style                        Check code style
      --php8                         Set PHPStan phpVersion for 8.1 (Drupal 10 requirement)
      --memory-limit[=MEMORY-LIMIT]  Memory limit for analysis
  -e, --exclude-dir[=EXCLUDE-DIR]    Directories to exclude. Separate multiple directories with a comma, no spaces.
      --no-progress                  Do not show progress bar, only results
  -h, --help                         Display this help message
  -q, --quiet                        Do not output any message
  -V, --version                      Display this application version
      --ansi                         Force ANSI output
      --no-ansi                      Disable ANSI output
  -n, --no-interaction               Do not ask any interactive question
  -v|vv|vvv, --verbose               Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

It would be nice to add these to the readme.md file so that everything matches.

Console output
n/a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant