mirror of
https://github.com/kopia/kopia.git
synced 2026-01-12 08:27:51 -05:00
6cd728394d
* fix(site): escape flags with backticks In the generated markdown docs, flags like `--foo` inside help texts currently get pretty-printed as `–foo` with an em-dash. This change applies backticks via a regex replacement, so that they appear as `--foo` in the docs but remain as --foo in the CLI output. --------- Co-authored-by: Julio Lopez <1953782+julio-lopez@users.noreply.github.com>
84 lines
1.9 KiB
Go
84 lines
1.9 KiB
Go
package main
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestEscapeFlags(t *testing.T) {
|
|
cases := []struct {
|
|
name string
|
|
input string
|
|
expected string
|
|
}{
|
|
{
|
|
name: "empty string",
|
|
input: "",
|
|
expected: "",
|
|
},
|
|
{
|
|
name: "basic single flag",
|
|
input: "use -flag to enable",
|
|
expected: "use `-flag` to enable",
|
|
},
|
|
{
|
|
name: "double dash flag",
|
|
input: "use --long-flag-name to configure",
|
|
expected: "use `--long-flag-name` to configure",
|
|
},
|
|
{
|
|
name: "multiple flags",
|
|
input: "use -a or --bee flags",
|
|
expected: "use `-a` or `--bee` flags",
|
|
},
|
|
{
|
|
name: "should not match in-place",
|
|
input: "performs in-place modification",
|
|
expected: "performs in-place modification",
|
|
},
|
|
{
|
|
name: "flags with numbers and hyphens",
|
|
input: "use --http2-max-streams or -h2-timeout",
|
|
expected: "use `--http2-max-streams` or `-h2-timeout`",
|
|
},
|
|
{
|
|
name: "flag at start of string",
|
|
input: "-flag at start",
|
|
expected: "`-flag` at start",
|
|
},
|
|
{
|
|
name: "existing backticks",
|
|
input: "use `--existing` and -new flags",
|
|
expected: "use `--existing` and `-new` flags",
|
|
},
|
|
{
|
|
name: "multiple spaces before flag",
|
|
input: "test -flag with spaces",
|
|
expected: "test `-flag` with spaces",
|
|
},
|
|
{
|
|
name: "mixed valid and invalid patterns",
|
|
input: "test in-place and -valid --flags",
|
|
expected: "test in-place and `-valid` `--flags`",
|
|
},
|
|
{
|
|
name: "separator line",
|
|
input: "---------------",
|
|
expected: "---------------",
|
|
},
|
|
{
|
|
name: "too many dashes",
|
|
input: "none ---of these --- dashes ----should match",
|
|
expected: "none ---of these --- dashes ----should match",
|
|
},
|
|
}
|
|
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
got := escapeFlags(tc.input)
|
|
require.Equal(t, tc.expected, got)
|
|
})
|
|
}
|
|
}
|