mypy_clean_slate icon indicating copy to clipboard operation
mypy_clean_slate copied to clipboard

It's common for clis to use `-` rather than `_`

Open eyurtsev opened this issue 11 months ago • 1 comments

A bit of a nit, but it's common for CLIs to favor - over _ for the names of options

So one would expect path-to-code rather than path_to_code

(langchain_3_11_4) ➜  core git:(eugene/unsafe_pydantic) ✗ mypy_clean_slate --help
usage: mypy_clean_slate [options]

CLI tool for providing a clean slate for mypy usage within a project.

Default expectation is to want to get a project into a state that it
will pass mypy when run with `--strict`, if this isn't the case custom
flags can be passed to mypy via the `--mypy_flags` argument.

options:
  -h, --help            show this help message and exit
  -r, --generate_mypy_error_report
                        Generate 'mypy_error_report.txt' in the cwd.
  -p PATH_TO_CODE, --path_to_code PATH_TO_CODE
                        Where code is that needs report generating for it.
  -a, --add_type_ignore
                        Add "# type: ignore[<error-code>]" to suppress all raised mypy errors.
  --remove_unused       Remove unused instances of "# type: ignore[<error-code>]" if raised as an error by mypy.
  -o MYPY_REPORT_OUTPUT, --mypy_report_output MYPY_REPORT_OUTPUT
                        File to save report output to (default is mypy_error_report.txt)
  --mypy_flags MYPY_FLAGS
                        Custom flags to pass to mypy (provide them as a single string, default is to use --strict)

eyurtsev avatar Mar 15 '24 17:03 eyurtsev