From 987c3651303be86453010167136b7afcf26802f3 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Mon, 28 Jul 2025 18:28:38 -0500 Subject: [PATCH] docs(ref): Include example of ignore-next-line --- .../tests/cmd/ignore-next-line.in/_typos.toml | 5 +++++ .../tests/cmd/ignore-next-line.in/file.ignore | 6 ++++++ .../typos-cli/tests/cmd/ignore-next-line.toml | 18 ++++++++++++++++++ docs/reference.md | 1 + 4 files changed, 30 insertions(+) create mode 100644 crates/typos-cli/tests/cmd/ignore-next-line.in/_typos.toml create mode 100644 crates/typos-cli/tests/cmd/ignore-next-line.in/file.ignore create mode 100644 crates/typos-cli/tests/cmd/ignore-next-line.toml diff --git a/crates/typos-cli/tests/cmd/ignore-next-line.in/_typos.toml b/crates/typos-cli/tests/cmd/ignore-next-line.in/_typos.toml new file mode 100644 index 00000000..1cf0de02 --- /dev/null +++ b/crates/typos-cli/tests/cmd/ignore-next-line.in/_typos.toml @@ -0,0 +1,5 @@ +[default] +extend-ignore-re = ["(#|//)\\s*spellchecker:ignore-next-line\\n.*"] + +[default.extend-identifiers] +hello = "goodbye" diff --git a/crates/typos-cli/tests/cmd/ignore-next-line.in/file.ignore b/crates/typos-cli/tests/cmd/ignore-next-line.in/file.ignore new file mode 100644 index 00000000..f12814fd --- /dev/null +++ b/crates/typos-cli/tests/cmd/ignore-next-line.in/file.ignore @@ -0,0 +1,6 @@ +hello +# spellchecker:ignore-next-line +hello +# spellchecker:ignore-next-line +henlo +hello diff --git a/crates/typos-cli/tests/cmd/ignore-next-line.toml b/crates/typos-cli/tests/cmd/ignore-next-line.toml new file mode 100644 index 00000000..f7229a41 --- /dev/null +++ b/crates/typos-cli/tests/cmd/ignore-next-line.toml @@ -0,0 +1,18 @@ +bin.name = "typos" +stdin = "--sort" +stdout = """ +error: `hello` should be `goodbye` + --> ./file.ignore:1:1 + | +1 | hello + | ^^^^^ + | +error: `hello` should be `goodbye` + --> ./file.ignore:6:1 + | +6 | hello + | ^^^^^ + | +""" +stderr = "" +status.code = 2 diff --git a/docs/reference.md b/docs/reference.md index 787814b3..b9c7de71 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -44,6 +44,7 @@ Configuration is read from the following (in precedence order) Common `extend-ignore-re`: - Line ignore with trailing `# spellchecker:disable-line`: `"(?Rm)^.*(#|//)\\s*spellchecker:disable-line$"` - Line block with `# spellchecker:`: `"(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on"` +- Next-line ignore `# spellchecker:ignore-next-line`: `(#|//)\\s*spellchecker:ignore-next-line\\n.*` - See also [ripsecret's regexes](https://github.com/sirwart/ripsecrets/blob/main/src/lib.rs) Common `extend-ignore-identifiers-re`: