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

deno: --help should get either wrapped to 80 symbols or terminal width #2147

Open
yarikoptic opened this issue Oct 3, 2024 · 1 comment
Open

Comments

@yarikoptic
Copy link
Contributor

ATM it would look like

Image

with me having

❯ stty size
56 86

on my terminal. And require a very wide terminal to actually show it unwrapped/without distortions

Image

so overall seems like if (Default ...) is printed under the option descrioption, it would already be mostly ok

@effigies
Copy link
Collaborator

The max width is currently set, pretty firmly, in the CLI library. c4spar/deno-cliffy#761 implements flexible resizing of the description and type columns, based on the terminal width.

At 72 characters, it's:

❯ deno run -A ~/Projects/bids/bids-validator/bids-validator/src/bids-validator.ts --help

Usage:   bids-validator <dataset_directory>
Version: v1.14.15-dev.0-11-g8f3519b3

Description:

  This tool checks if a dataset in a given directory is compatible with
  the Brain Imaging Data Structure specification. To learn more about
  Brain Imaging Data Structure visit http://bids.neuroimaging.io

Options:

  -h, --help                              - Show this help.
  -V, --version                           - Show the
                                            version number
                                            for this
                                            program.
  --json                                  - Output machine
                                            readable JSON
  -s, --schema           <URL-or-tag>     - Specify a
                                            schema version
                                            to use for
                                            validation
  -c, --config           <file>           - Path to a JSON
                                            configuration
                                            file
  -v, --verbose                           - Log more
                                            extensive
                                            information
                                            about issues
  --ignoreWarnings                        - Disregard
                                            non-critical
                                            issues
  --ignoreNiftiHeaders                    - Disregard NIfTI
                                            header content
                                            during
                                            validation
  --debug                <level>          - Enable debug     (Default:
                                            output           "ERROR",
                                                             Values:
                                                             "NOTSET",
                                                             "DEBUG",
                                                             "INFO",
                                                             "WARN",
                                                             "ERROR",
                                                             "CRITICAL"
                                                             )
  --filenameMode                          - Enable filename
                                            checks for
                                            newline
                                            separated
                                            filenames read
                                            from stdin
  --blacklistModalities  <modalities...>  - Array of         (Default:
                                            modalities to    [],
                                            error on if      Values:
                                            detected.        "MRI",
                                                             "PET",
                                                             "MEG",
                                                             "EEG",
                                                             "iEEG",
                                                             "Microscop
                                                             y",
                                                             "NIRS",
                                                             "MRS")
  -r, --recursive                         - Validate
                                            datasets found
                                            in derivatives
                                            directories in
                                            addition to
                                            root dataset
  -o, --outfile          <file>           - File to write
                                            validation
                                            results to.
  --color, --no-color    [color]          - Enable/disable   (Default:
                                            color output     true)
                                            (defaults to
                                            detected
                                            support)

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

No branches or pull requests

2 participants