[ty] CLI reference (#17978)

Author: MichaReiser

.pre-commit-config.yaml

@@ -5,8 +5,7 @@ exclude: |
     .github/workflows/release.yml|
     crates/ty_vendored/vendor/.*|
     crates/ty_project/resources/.*|
-    crates/ty/docs/configuration.md|
-    crates/ty/docs/rules.md|
+    crates/ty/docs/(configuration|rules|cli).md|
     crates/ruff_benchmark/resources/.*|
     crates/ruff_linter/resources/.*|
     crates/ruff_linter/src/rules/.*/snapshots/.*|

Cargo.lock

@@ -38,6 +38,7 @@ ruff_source_file = { path = "crates/ruff_source_file" }
 ruff_text_size = { path = "crates/ruff_text_size" }
 ruff_workspace = { path = "crates/ruff_workspace" }
 
+ty = { path = "crates/ty" }
 ty_ide = { path = "crates/ty_ide" }
 ty_project = { path = "crates/ty_project", default-features = false }
 ty_python_semantic = { path = "crates/ty_python_semantic" }

Cargo.toml

@@ -11,6 +11,7 @@ repository = { workspace = true }
 license = { workspace = true }
 
 [dependencies]
+ty = { workspace = true }
 ty_project = { workspace = true, features = ["schemars"] }
 ruff = { workspace = true }
 ruff_diagnostics = { workspace = true }
@@ -32,6 +33,7 @@ imara-diff = { workspace = true }
 indicatif = { workspace = true }
 itertools = { workspace = true }
 libcst = { workspace = true }
+markdown = { version = "1.0.0" }
 pretty_assertions = { workspace = true }
 rayon = { workspace = true }
 regex = { workspace = true }

crates/ruff_dev/Cargo.toml

@@ -3,8 +3,8 @@
 use anyhow::Result;
 
 use crate::{
-    generate_cli_help, generate_docs, generate_json_schema, generate_ty_options, generate_ty_rules,
-    generate_ty_schema,
+    generate_cli_help, generate_docs, generate_json_schema, generate_ty_cli_reference,
+    generate_ty_options, generate_ty_rules, generate_ty_schema,
 };
 
 pub(crate) const REGENERATE_ALL_COMMAND: &str = "cargo dev generate-all";
@@ -43,5 +43,6 @@ pub(crate) fn main(args: &Args) -> Result<()> {
     })?;
     generate_ty_options::main(&generate_ty_options::Args { mode: args.mode })?;
     generate_ty_rules::main(&generate_ty_rules::Args { mode: args.mode })?;
+    generate_ty_cli_reference::main(&generate_ty_cli_reference::Args { mode: args.mode })?;
     Ok(())
 }

crates/ruff_dev/src/generate_all.rs

@@ -1,5 +1,4 @@
 //! Generate CLI help.
-#![allow(clippy::print_stdout)]
 
 use std::path::PathBuf;
 use std::{fs, str};

crates/ruff_dev/src/generate_cli_help.rs

@@ -1,5 +1,4 @@
 //! Generate Markdown documentation for applicable rules.
-#![allow(clippy::print_stdout, clippy::print_stderr)]
 
 use std::collections::HashSet;
 use std::fmt::Write as _;

crates/ruff_dev/src/generate_docs.rs

@@ -1,5 +1,3 @@
-#![allow(clippy::print_stdout, clippy::print_stderr)]
-
 use std::fs;
 use std::path::PathBuf;