Add documentation about prek.toml (#1560)

update schema url

Author: j178

crates/prek/src/cli/mod.rs

@@ -591,7 +591,11 @@ pub(crate) struct ValidateManifestArgs {
 #[expect(clippy::option_option)]
 #[derive(Debug, Args)]
 pub(crate) struct SampleConfigArgs {
-    /// Write the sample config to a file (`.pre-commit-config.yaml` by default).
+    /// Write the sample config to a file.
+    ///
+    /// Defaults to `.pre-commit-config.yaml` unless `--format toml` is set,
+    /// which uses `prek.toml`. If a path is provided without `--format`,
+    /// the format is inferred from the file extension (`.toml` uses TOML).
     #[arg(
         short,
         long,

crates/prek/src/cli/sample_config.rs

@@ -24,7 +24,7 @@ repos:
 "};
 
 static SAMPLE_CONFIG_TOML: &str = indoc::indoc! {r#"
-#:schema: https://prek.j178.dev/prek.schema.json
+#:schema: https://json.schemastore.org/prek.json
 # Configuration file for `prek`, a git hook framework written in Rust.
 # See https://prek.j178.dev for more information.
 

crates/prek/tests/sample_config.rs

@@ -112,7 +112,7 @@ fn sample_config_toml() {
     "#);
 
     insta::assert_snapshot!(context.read("prek.toml"), @r#"
-    #:schema: https://prek.j178.dev/prek.schema.json
+    #:schema: https://json.schemastore.org/prek.json
     # Configuration file for `prek`, a git hook framework written in Rust.
     # See https://prek.j178.dev for more information.
 
@@ -134,7 +134,7 @@ fn sample_config_format() {
     success: true
     exit_code: 0
     ----- stdout -----
-    #:schema: https://prek.j178.dev/prek.schema.json
+    #:schema: https://json.schemastore.org/prek.json
     # Configuration file for `prek`, a git hook framework written in Rust.
     # See https://prek.j178.dev for more information.
 
@@ -224,7 +224,7 @@ fn respect_format_if_filename_missing() {
     ");
 
     insta::assert_snapshot!(context.read("prek.toml"), @r#"
-    #:schema: https://prek.j178.dev/prek.schema.json
+    #:schema: https://json.schemastore.org/prek.json
     # Configuration file for `prek`, a git hook framework written in Rust.
     # See https://prek.j178.dev for more information.
 

docs/cli.md

@@ -549,7 +549,8 @@ prek sample-config [OPTIONS]
 <li><code>always</code>:  Enables colored output regardless of the detected environment</li>
 <li><code>never</code>:  Disables colored output</li>
 </ul></dd><dt id="prek-sample-config--config"><a href="#prek-sample-config--config"><code>--config</code></a>, <code>-c</code> <i>config</i></dt><dd><p>Path to alternate config file</p>
-</dd><dt id="prek-sample-config--file"><a href="#prek-sample-config--file"><code>--file</code></a>, <code>-f</code> <i>file</i></dt><dd><p>Write the sample config to a file (<code>.pre-commit-config.yaml</code> by default)</p>
+</dd><dt id="prek-sample-config--file"><a href="#prek-sample-config--file"><code>--file</code></a>, <code>-f</code> <i>file</i></dt><dd><p>Write the sample config to a file.</p>
+<p>Defaults to <code>.pre-commit-config.yaml</code> unless <code>--format toml</code> is set, which uses <code>prek.toml</code>. If a path is provided without <code>--format</code>, the format is inferred from the file extension (<code>.toml</code> uses TOML).</p>
 </dd><dt id="prek-sample-config--format"><a href="#prek-sample-config--format"><code>--format</code></a> <i>format</i></dt><dd><p>Select the sample configuration format</p>
 <p>Possible values:</p>
 <ul>