Add `--quiet` CLI flag to `ty check`

[ibraheemdev]

This has come up a few times and is useful for benchmarking and memory profiling reports. It should silence all diagnostics and only provide an exit code, I think Ruff calls this --silent.

[AlexWaygood]

would this be different to e.g. --ignore=ALL? (Or would we implement this instead of --ignore=ALL?)

[zanieb]

Isn't this just silencing diagnostic output? Wouldn't --ignore=ALL make it exit with a zero?

[AlexWaygood]

That makes sense, thanks! Though in that case I almost wonder if --output-format=none might work?

[MichaReiser]

I think it's different from an --output-format=none because --quiet (ruff also has --silent) also silence all other messages. E.g. ty wouldn't report: Found x diagnostics at the end of checking and it also disables any other tracing output (needs to be decided up to which level)

[zanieb]

--output-format=none might be sufficient for benchmarking though, if the problem is printing all the diagnostics?

uv also uses --quiet and --silent: https://github.com/astral-sh/uv/blob/1d20530f2dfbfa8e20dad236558d4ae82ebebdf3/crates/uv/src/printer.rs#L6-L9

I think I'd expect --quiet to retain summary output?

[AlexWaygood]

I think it's different from an --output-format=none because --quiet (ruff also has --silent) also silence all other messages

Including, e.g., the messages with the memory usage stats that we'd usually print if the TY_MEMORY_REPORT environment variable was set?

[ibraheemdev]

Including, e.g., the messages with the memory usage stats that we'd usually print if the TY_MEMORY_REPORT environment variable was set?

No I think we want to print those. Part of the motivation of the flag was to be able to print the memory report without diagnostics affecting the diff (or taking up your terminal screen locally). The memory report is somewhat of a special case though, it's not a standard output of the CLI command (similar to if you enabled RUST_LOG).

[AlexWaygood]

Right, that was why I was asking. If we only really want to suppress diagnostic output, but not (per Zanie) the summary output or (per you) the memory usage stats, then that implies to me that a better name for the flag might be --output-format=none. It sounds like the main thing we care about for this use case is suppressing diagnostic output, not all output.

[zanieb]

Fwiw I find --output-format=none non-obvious whereas --quiet is pretty clear and covers the use-case just fine? I think the only semantic difference is that --quiet would change the tracing log level.

[AlexWaygood]

If a user did --output-format=full --quiet, which would take priority -- I guess --quiet? What if --quiet was specified in a pyproject.toml file but --output-format=full was specified on the CLI?

[MichaReiser]

To me, --quiet is the opposite of -v (and -vv). It's a CLI only argument and is fairly common across CLI tools (eslint and cargo both have it) although they often have different semantics.

What I expect from someone who picks up this task is to explore the design space and propose whether we should use --quiet and --silent (precedence in ruff and uv) or --output-format.

[zanieb]

I think quiet wouldn't be exposed in the pyproject.toml.