holocron/tests/test-vale-wrap.sh

#!/usr/bin/env bash
# Regression test for scripts/vale-wrap.sh: Vale's `text.frontmatter.description`
# NLP scope silently stops matching when the description value is a YAML block
# scalar spanning 2+ physical lines. vale-wrap.sh flattens it to one line before
# handing off to the real vale binary — this asserts that actually happens.
set -euo pipefail

REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
SCRIPT="$REPO_ROOT/scripts/vale-wrap.sh"
PASS=0
FAIL=0

pass() { echo "  PASS: $1"; PASS=$((PASS + 1)); }
fail() { echo "  FAIL: $1"; FAIL=$((FAIL + 1)); }

if ! command -v vale &>/dev/null; then
  echo "vale is not installed — skipping (matches skill-audit/agent-audit's own fallback behavior)"
  exit 0
fi

make_fixture() {
  local dir desc_lines file
  dir="$(mktemp -d)"
  (cd "$dir" && git init -q)
  mkdir -p "$dir/plugins/testplugin/skills/zzzskill"
  desc_lines="$1"
  file="$dir/plugins/testplugin/skills/zzzskill/SKILL.md"
  {
    echo "---"
    echo "name: zzzskill"
    echo "description: >"
    for ((i = 1; i <= desc_lines; i++)); do
      echo "  Line $i mentions helps with and utilize, plus a colon: like this."
    done
    echo "---"
    echo ""
    echo "Body."
  } > "$file"
  echo "$dir"
}

# --- 1. A known-bad single-line description is caught (sanity check on Vale itself) ---
echo ""
echo "--- catches vague wording in a single-line description ---"
FIXTURE1="$(make_fixture 1)"
trap 'rm -rf "$FIXTURE1"' EXIT
if (cd "$FIXTURE1" && bash "$SCRIPT" --config "$REPO_ROOT/.vale.ini" \
  plugins/testplugin/skills/zzzskill/SKILL.md) | grep -q "VagueWording"; then
  pass "flags vague wording when description is a single physical line"
else
  fail "did not flag known-bad single-line description"
fi

# --- 2. The same known-bad wording across 2+ physical lines is still caught ---
echo ""
echo "--- catches vague wording in a multi-line folded description ---"
FIXTURE2="$(make_fixture 2)"
trap 'rm -rf "$FIXTURE1" "$FIXTURE2"' EXIT
if (cd "$FIXTURE2" && bash "$SCRIPT" --config "$REPO_ROOT/.vale.ini" \
  plugins/testplugin/skills/zzzskill/SKILL.md) | grep -q "VagueWording"; then
  pass "flags vague wording when description spans 2+ physical lines"
else
  fail "silently missed known-bad wording in a multi-line description — the bug this test guards against"
fi

# --- 3. Line count is preserved so unrelated report line numbers don't shift ---
echo ""
echo "--- preserves total line count when flattening ---"
FIXTURE3="$(make_fixture 3)"
trap 'rm -rf "$FIXTURE1" "$FIXTURE2" "$FIXTURE3"' EXIT
ORIG_LINES=$(wc -l < "$FIXTURE3/plugins/testplugin/skills/zzzskill/SKILL.md")
OUT=$(cd "$FIXTURE3" && bash "$SCRIPT" --config "$REPO_ROOT/.vale.ini" \
  plugins/testplugin/skills/zzzskill/SKILL.md 2>&1 || true)
MAX_LINE=$(echo "$OUT" | grep -oE '^[[:space:]]*[0-9]+:[0-9]+' | tr -d '[:space:]' | cut -d: -f1 | sort -n | tail -1)
if [[ -n "$MAX_LINE" ]] && (( MAX_LINE <= ORIG_LINES )); then
  pass "reported line numbers stay within the original file's line count"
else
  fail "reported line number ($MAX_LINE) exceeds original file line count ($ORIG_LINES)"
fi

# make_raw_fixture writes stdin verbatim to a fresh fixture's SKILL.md, for
# cases where the exact description body needs to be hand-crafted rather than
# generated from the desc_lines loop above.
make_raw_fixture() {
  local dir
  dir="$(mktemp -d)"
  (cd "$dir" && git init -q)
  mkdir -p "$dir/plugins/testplugin/skills/zzzskill"
  cat > "$dir/plugins/testplugin/skills/zzzskill/SKILL.md"
  echo "$dir"
}

# --- 4. A folded description containing a double quote is still caught ---
# This is the exact case that silently passed (zero alerts) before switching
# from json.dumps (double-quoted, backslash-escaped) to a single-quoted scalar.
echo ""
echo "--- catches vague wording when the folded description contains a double quote ---"
FIXTURE4="$(make_raw_fixture <<'EOF'
---
name: zzzskill
description: >
  Use when the user says "audit this skill" and helps with and utilize things.
  Second line continues the same folded scalar for flattening.
---

Body.
EOF
)"
trap 'rm -rf "$FIXTURE1" "$FIXTURE2" "$FIXTURE3" "$FIXTURE4"' EXIT
if (cd "$FIXTURE4" && bash "$SCRIPT" --config "$REPO_ROOT/.vale.ini" \
  plugins/testplugin/skills/zzzskill/SKILL.md) | grep -q "VagueWording"; then
  pass "flags vague wording when the description contains a double quote"
else
  fail "silently missed vague wording in a description containing a double quote — the bug this test guards against"
fi

# --- 5. A folded description containing an apostrophe fires and stays valid YAML ---
echo ""
echo "--- catches vague wording when the folded description contains an apostrophe ---"
FIXTURE5="$(make_raw_fixture <<'EOF'
---
name: zzzskill
description: >
  Use when the user's task helps with and utilize things across two lines.
  Second continuation line for the fold.
---

Body.
EOF
)"
trap 'rm -rf "$FIXTURE1" "$FIXTURE2" "$FIXTURE3" "$FIXTURE4" "$FIXTURE5"' EXIT
OUT5=$(cd "$FIXTURE5" && bash "$SCRIPT" --config "$REPO_ROOT/.vale.ini" \
  plugins/testplugin/skills/zzzskill/SKILL.md 2>&1)
if echo "$OUT5" | grep -q "VagueWording"; then
  pass "flags vague wording when the description contains an apostrophe"
else
  fail "silently missed vague wording in a description containing an apostrophe"
fi
if echo "$OUT5" | grep -qi "yaml:"; then
  fail "flattened copy with an apostrophe produced a YAML parse error"
else
  pass "flattened copy with an apostrophe is valid YAML (no parse error)"
fi

# --- 6. A folded description with a backslash and a non-ASCII character ---
echo ""
echo "--- catches vague wording when the folded description has a backslash and non-ASCII text ---"
FIXTURE6="$(make_raw_fixture <<'EOF'
---
name: zzzskill
description: >
  Use when the café résumé naïve thing helps with and utilize things here.
  Path is C:\Users\test and this is the second continuation line.
---

Body.
EOF
)"
trap 'rm -rf "$FIXTURE1" "$FIXTURE2" "$FIXTURE3" "$FIXTURE4" "$FIXTURE5" "$FIXTURE6"' EXIT
if (cd "$FIXTURE6" && bash "$SCRIPT" --config "$REPO_ROOT/.vale.ini" \
  plugins/testplugin/skills/zzzskill/SKILL.md) | grep -q "VagueWording"; then
  pass "flags vague wording when the description has a backslash and non-ASCII text"
else
  fail "silently missed vague wording in a description with a backslash and non-ASCII text"
fi

# --- 7. A folded description with a blank line between two paragraphs ---
echo ""
echo "--- handles a blank line inside a folded description without crashing ---"
FIXTURE7="$(make_raw_fixture <<'EOF'
---
name: zzzskill
description: >
  Use when the user needs a general helper.

  Do not use when this helps with and utilize things instead.
---

Body.
EOF
)"
trap 'rm -rf "$FIXTURE1" "$FIXTURE2" "$FIXTURE3" "$FIXTURE4" "$FIXTURE5" "$FIXTURE6" "$FIXTURE7"' EXIT
OUT7=$(cd "$FIXTURE7" && bash "$SCRIPT" --config "$REPO_ROOT/.vale.ini" \
  plugins/testplugin/skills/zzzskill/SKILL.md 2>&1)
if echo "$OUT7" | grep -q "Traceback"; then
  fail "crashed while flattening a description with a blank line between paragraphs"
elif echo "$OUT7" | grep -q "VagueWording"; then
  pass "still flags vague wording in the second paragraph after a blank line"
else
  fail "silently missed vague wording in the second paragraph after a blank line — the bug this test guards against"
fi

# --- 8. --config=<path> (equals form) resolves the same as the two-argv form ---
echo ""
echo "--- --config=<path> equals form resolves from a subdirectory like the two-argv form ---"
FIXTURE8="$(mktemp -d)"
(cd "$FIXTURE8" && git init -q)
cp "$REPO_ROOT/.vale.ini" "$FIXTURE8/.vale.ini"
cp -r "$REPO_ROOT/styles" "$FIXTURE8/styles"
mkdir -p "$FIXTURE8/plugins/testplugin/skills/zzzskill"
{
  echo "---"
  echo "name: zzzskill"
  echo "description: >"
  echo "  Line one mentions helps with and utilize, plus a colon: like this."
  echo "  Line two continues the same folded scalar for flattening."
  echo "---"
  echo ""
  echo "Body."
} > "$FIXTURE8/plugins/testplugin/skills/zzzskill/SKILL.md"
trap 'rm -rf "$FIXTURE1" "$FIXTURE2" "$FIXTURE3" "$FIXTURE4" "$FIXTURE5" "$FIXTURE6" "$FIXTURE7" "$FIXTURE8"' EXIT
SUBDIR8="$FIXTURE8/plugins/testplugin/skills/zzzskill"
REL8="plugins/testplugin/skills/zzzskill/SKILL.md"
OUT_EQ=$(cd "$SUBDIR8" && bash "$SCRIPT" --config=.vale.ini "$REL8" 2>&1)
OUT_TWO=$(cd "$SUBDIR8" && bash "$SCRIPT" --config .vale.ini "$REL8" 2>&1)
if echo "$OUT_EQ" | grep -q "VagueWording" && [[ "$OUT_EQ" == "$OUT_TWO" ]]; then
  pass "--config=<path> from a subdirectory resolves and matches the two-argv form"
else
  fail "--config=<path> equals form did not resolve the same as the two-argv form"
fi

# --- 9. Zero file args (or a file list that filters to nothing) exits promptly ---
echo ""
echo "--- exits promptly instead of hanging on stdin when no files are passed ---"
if timeout 5 bash "$SCRIPT" --config "$REPO_ROOT/.vale.ini" < <(sleep 100) >/dev/null 2>&1; then
  pass "exits promptly with zero file args"
else
  RC=$?
  if [[ $RC -eq 124 ]]; then
    fail "hung waiting on stdin with zero file args — the bug this test guards against"
  else
    pass "exits promptly (nonzero exit) with zero file args"
  fi
fi

echo ""
echo "--- exits promptly when a file list filters down to nothing ---"
if timeout 5 bash "$SCRIPT" --config "$REPO_ROOT/.vale.ini" --no-such-flag < <(sleep 100) >/dev/null 2>&1; then
  pass "exits promptly when no file-shaped args remain"
else
  RC=$?
  if [[ $RC -eq 124 ]]; then
    fail "hung waiting on stdin when the file list filtered to nothing — the bug this test guards against"
  else
    pass "exits promptly (nonzero exit) when the file list filters to nothing"
  fi
fi

# --- 10. An absolute path to the fixture SKILL.md is still linted, not skipped ---
echo ""
echo "--- lints an absolute path to a skill file instead of silently skipping it ---"
FIXTURE10="$(make_fixture 2)"
trap 'rm -rf "$FIXTURE1" "$FIXTURE2" "$FIXTURE3" "$FIXTURE4" "$FIXTURE5" "$FIXTURE6" "$FIXTURE7" "$FIXTURE8" "$FIXTURE10"' EXIT
ABS_FILE10="$FIXTURE10/plugins/testplugin/skills/zzzskill/SKILL.md"
if (cd "$FIXTURE10" && bash "$SCRIPT" --config "$REPO_ROOT/.vale.ini" "$ABS_FILE10") | grep -q "VagueWording"; then
  pass "an absolute path under repo_root is linted, not silently skipped"
else
  fail "an absolute path under repo_root was silently skipped — the bug this test guards against"
fi

# --- 11. A literal (|) block scalar passes through unflattened (no regression) ---
echo ""
echo "--- leaves a literal (|) block scalar untouched (narrowed >-only scope) ---"
FIXTURE11="$(make_raw_fixture <<'EOF'
---
name: zzzskill
description: |
  Line one mentions helps with and utilize things here.
  Line two continues the literal block scalar for this test.
---

Body.
EOF
)"
trap 'rm -rf "$FIXTURE1" "$FIXTURE2" "$FIXTURE3" "$FIXTURE4" "$FIXTURE5" "$FIXTURE6" "$FIXTURE7" "$FIXTURE8" "$FIXTURE10" "$FIXTURE11"' EXIT
REL11="plugins/testplugin/skills/zzzskill/SKILL.md"
WRAPPED_OUT=$(cd "$FIXTURE11" && bash "$SCRIPT" --config "$REPO_ROOT/.vale.ini" "$REL11" 2>&1 || true)
BARE_OUT=$(cd "$FIXTURE11" && vale --config "$REPO_ROOT/.vale.ini" "$REL11" 2>&1 || true)
if [[ "$WRAPPED_OUT" == "$BARE_OUT" ]]; then
  pass "literal (|) block scalar output matches bare vale exactly — untouched by flattening"
else
  fail "wrapper altered output for a literal (|) block scalar description — should be left untouched"
fi

echo ""
echo "Results: $PASS passed, $FAIL failed"
[[ $FAIL -eq 0 ]]