larksuite-cli/shortcuts/doc/docs_update_check_test.go

// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT

package doc

import (
	"strings"
	"testing"
)

func TestCheckDocsUpdateReplaceMultilineMarkdown(t *testing.T) {
	t.Parallel()

	tests := []struct {
		name     string
		mode     string
		markdown string
		wantHint bool
	}{
		{
			name:     "replace_range with blank line emits hint",
			mode:     "replace_range",
			markdown: "new paragraph\n\nsecond paragraph",
			wantHint: true,
		},
		{
			name:     "replace_all with blank line emits hint",
			mode:     "replace_all",
			markdown: "first\n\nsecond",
			wantHint: true,
		},
		{
			name:     "replace_range single paragraph is fine",
			mode:     "replace_range",
			markdown: "just a single paragraph of text",
			wantHint: false,
		},
		{
			name:     "single newline is not a paragraph break",
			mode:     "replace_range",
			markdown: "line one\nline two",
			wantHint: false,
		},
		{
			name:     "crlf paragraph break is also detected",
			mode:     "replace_range",
			markdown: "first\r\n\r\nsecond",
			wantHint: true,
		},
		{
			name:     "other modes are not flagged",
			mode:     "insert_before",
			markdown: "first\n\nsecond",
			wantHint: false,
		},
		{
			name:     "append mode is not flagged",
			mode:     "append",
			markdown: "first\n\nsecond",
			wantHint: false,
		},
		{
			name:     "empty markdown is fine",
			mode:     "replace_range",
			markdown: "",
			wantHint: false,
		},
		{
			// The check must ignore blank lines inside fenced code; otherwise
			// a user replacing one block with a legitimate code sample that
			// contains blank lines would see a spurious warning.
			name:     "blank line inside backtick fenced code is not flagged",
			mode:     "replace_range",
			markdown: "```\nline1\n\nline2\n```",
			wantHint: false,
		},
		{
			name:     "blank line inside tilde fenced code is not flagged",
			mode:     "replace_range",
			markdown: "~~~\ncode line one\n\ncode line two\n~~~",
			wantHint: false,
		},
		{
			// Mixed prose + fenced code: any blank line in prose still wins,
			// even if the fenced content also contains blanks.
			name:     "blank line in prose outside fence still flags even when fence has blanks",
			mode:     "replace_range",
			markdown: "first paragraph\n\nsecond paragraph\n\n```\ncode\n\nmore\n```",
			wantHint: true,
		},
		{
			// Fenced code with no blank lines inside must not trip on the
			// fence markers themselves.
			name:     "fenced code with no blank lines does not flag",
			mode:     "replace_range",
			markdown: "prose before\n```go\nfmt.Println(\"hi\")\n```\nprose after",
			wantHint: false,
		},
		{
			// CommonMark §4.5: the closing fence must be ≥ opening fence length.
			// A 4-backtick close for a 3-backtick open is a legitimate way to
			// embed triple-backticks in a code sample; the check must see the
			// fence as properly closed and not treat the rest of the document
			// as still-inside-fence.
			name:     "longer close marker closes fence correctly",
			mode:     "replace_range",
			markdown: "```\nsome code\n````\n\nprose paragraph after",
			wantHint: true, // the blank line AFTER the fence is real prose
		},
		{
			name:     "longer close marker still hides blank line inside fence",
			mode:     "replace_range",
			markdown: "```\nbefore\n\nafter\n````",
			wantHint: false,
		},
		{
			// 4+ leading spaces make the line an indented code block, not a
			// fence open. The "fence"-looking line is code content; the
			// surrounding blank must still be detected.
			name:     "four-space indented fence-like line is not a fence open",
			mode:     "replace_range",
			markdown: "first paragraph\n\n    ```\n    code\n    ```",
			wantHint: true,
		},
		{
			// A tab in the leading whitespace is always ≥4 columns and thus
			// forces indented-code-block semantics.
			name:     "tab-indented fence-like line is not a fence open",
			mode:     "replace_range",
			markdown: "first paragraph\n\n\t```\n\tcode\n\t```",
			wantHint: true,
		},
		{
			// 3 leading spaces is still within the fence-tolerance window.
			name:     "three-space indented fence is still a fence",
			mode:     "replace_range",
			markdown: "   ```\ncode\n\nmore\n   ```",
			wantHint: false,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			t.Parallel()
			got := checkDocsUpdateReplaceMultilineMarkdown(tt.mode, tt.markdown)
			hasHint := got != ""
			if hasHint != tt.wantHint {
				t.Fatalf("checkDocsUpdateReplaceMultilineMarkdown(%q, %q) = %q, wantHint=%v",
					tt.mode, tt.markdown, got, tt.wantHint)
			}
			if tt.wantHint && (!strings.Contains(got, "delete_range") || !strings.Contains(got, "insert_before")) {
				t.Errorf("hint should suggest delete_range/insert_before remediation, got: %s", got)
			}
		})
	}
}

func TestCheckDocsUpdateBoldItalic(t *testing.T) {
	t.Parallel()

	tests := []struct {
		name     string
		input    string
		wantHint bool
	}{
		{
			name:     "triple asterisks flagged",
			input:    "a ***key insight*** here",
			wantHint: true,
		},
		{
			name:     "triple asterisks single char flagged",
			input:    "a ***X*** here",
			wantHint: true,
		},
		{
			name:     "bold wrapping underscore italic flagged",
			input:    "note: **_important_** detail",
			wantHint: true,
		},
		{
			name:     "underscore wrapping double asterisk flagged",
			input:    "note: _**important**_ detail",
			wantHint: true,
		},
		{
			name:     "plain bold is fine",
			input:    "this is **bold** text",
			wantHint: false,
		},
		{
			name:     "plain italic is fine",
			input:    "this is *italic* or _italic_ text",
			wantHint: false,
		},
		{
			name:     "horizontal rule is not flagged",
			input:    "paragraph\n\n---\n\nnext",
			wantHint: false,
		},
		{
			name:     "bold followed by italic with space is not flagged",
			input:    "**bold** and *italic*",
			wantHint: false,
		},
		{
			name:     "empty input is fine",
			input:    "",
			wantHint: false,
		},
		{
			// The emphasis check must not fire on literal Markdown samples
			// inside a fenced code block — the canonical use case is docs
			// authors pasting tutorials that demonstrate these exact patterns.
			name:     "triple asterisks inside backtick fenced code is not flagged",
			input:    "example:\n```\nthe shape ***keyword*** downgrades\n```",
			wantHint: false,
		},
		{
			name:     "underscore-bold inside fenced code is not flagged",
			input:    "example:\n```markdown\nuse **_strong italic_** carefully\n```",
			wantHint: false,
		},
		{
			name:     "bold-underscore inside fenced code is not flagged",
			input:    "example:\n~~~\n_**outside-underscore**_ is a bad shape\n~~~",
			wantHint: false,
		},
		{
			name:     "triple asterisks inside inline code span is not flagged",
			input:    "the literal `***text***` marker is just a sample",
			wantHint: false,
		},
		{
			name:     "underscore-bold inside inline code is not flagged",
			input:    "the shape `**_italic_**` would downgrade, but only if it were real",
			wantHint: false,
		},
		{
			name:     "escaped triple asterisks rendered as literal text is not flagged",
			input:    `the literal \***text*** with escaped opener`,
			wantHint: false,
		},
		{
			name:     "escaped bold inside underscore-italic is not flagged",
			input:    `shape \*\*_text_\*\* is literal, not emphasis`,
			wantHint: false,
		},
		{
			// Real emphasis outside the code span must still be detected —
			// the strip step must not over-sanitize.
			name:     "real triple asterisks outside inline code still flags",
			input:    "real ***strong*** and literal `***keyword***` — the first one counts",
			wantHint: true,
		},
		{
			name:     "real triple asterisks outside fenced code still flags",
			input:    "real ***strong***\n\n```\nliteral ***keyword*** in code\n```",
			wantHint: true,
		},
		// --- Triple-underscore combined emphasis: ___text___ ---
		{
			name:     "triple underscores flagged",
			input:    "a ___key insight___ here",
			wantHint: true,
		},
		{
			name:     "triple underscores single char flagged",
			input:    "a ___X___ here",
			wantHint: true,
		},
		{
			name:     "triple underscores inside fenced code not flagged",
			input:    "sample:\n```\nuse ___keyword___ carefully\n```",
			wantHint: false,
		},
		{
			name:     "triple underscores inside inline code not flagged",
			input:    "the literal `___phrase___` marker",
			wantHint: false,
		},
		{
			name:     "escaped triple underscores not flagged",
			input:    `literal \___phrase___ with escaped opener`,
			wantHint: false,
		},
		// --- Underscore-bold wrapping asterisk-italic: __*text*__ ---
		{
			name:     "underscore-bold wrapping asterisk-italic flagged",
			input:    "note: __*important*__ text",
			wantHint: true,
		},
		{
			name:     "underscore-bold wrapping asterisk-italic inside fenced code not flagged",
			input:    "```\nnote: __*important*__ sample\n```",
			wantHint: false,
		},
		{
			name:     "underscore-bold wrapping asterisk-italic inside inline code not flagged",
			input:    "literal `__*important*__` marker",
			wantHint: false,
		},
		// --- Asterisk-italic wrapping underscore-bold: *__text__* ---
		{
			name:     "asterisk-italic wrapping underscore-bold flagged",
			input:    "note: *__phrase__* text",
			wantHint: true,
		},
		{
			name:     "asterisk-italic wrapping underscore-bold inside fenced code not flagged",
			input:    "```md\nnote: *__phrase__* sample\n```",
			wantHint: false,
		},
		// --- Positive tests: real emphasis in prose coexisting with fake in code ---
		{
			// Underscore-variant in prose must still fire when an asterisk
			// variant appears inside a code span — verifies the strip does
			// not over-sanitize across the six regex alternatives.
			name:     "real triple underscores outside inline code still flag when asterisk variant is in code",
			input:    "real ___strong___ and literal `***shape***` in code",
			wantHint: true,
		},
		{
			// Longer close fence closes properly; real ***emphasis*** after
			// the fence must fire.
			name:     "real emphasis after a fence closed by longer marker still flags",
			input:    "```\nliteral ***phrase*** in code\n````\n\nand then real ***phrase*** after",
			wantHint: true,
		},
		{
			// 4-space indented "```" is an indented code block, not a fence
			// open. The fence helper should refuse it; emphasis outside the
			// (non-existent) fence must still be detected.
			name:     "four-space indented fence-like line does not open a fence for the emphasis check",
			input:    "prose\n\n    ```\n    not a fence\n    ```\n\nreal ***strong*** here",
			wantHint: true,
		},
		{
			// 3-space indented fence is valid per CommonMark. Emphasis inside
			// must be sanitized away, so the check must not fire.
			name:     "three-space indented fence still hides triple-asterisk inside",
			input:    "   ```\n   literal ***text*** inside\n   ```",
			wantHint: false,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			t.Parallel()
			got := checkDocsUpdateBoldItalic(tt.input)
			hasHint := got != ""
			if hasHint != tt.wantHint {
				t.Fatalf("checkDocsUpdateBoldItalic(%q) = %q, wantHint=%v", tt.input, got, tt.wantHint)
			}
		})
	}
}

func TestDocsUpdateWarningsAggregates(t *testing.T) {
	t.Parallel()

	// Both flags trigger: replace_range with blank line AND triple-asterisk.
	warnings := docsUpdateWarnings("replace_range", "***opening***\n\nsecond paragraph")
	if len(warnings) != 2 {
		t.Fatalf("expected 2 warnings, got %d: %v", len(warnings), warnings)
	}
}

func TestDocsUpdateWarningsEmpty(t *testing.T) {
	t.Parallel()

	// Clean markdown in a non-replace mode produces zero warnings.
	warnings := docsUpdateWarnings("insert_before", "plain paragraph text")
	if len(warnings) != 0 {
		t.Fatalf("expected no warnings, got: %v", warnings)
	}
}