holocron/tests/test-vale-3-15-2-behaviours.sh

#!/usr/bin/env bash
# Reproduction fixtures for the Vale 3.15.2 behaviours the lint plugin's vale-config and vale-run
# skills state as house-verified (provenance key house-vale-3-15-2-repro). Each case builds a
# purpose-built fixture in a temp dir, runs the real `vale` binary and asserts exit code plus
# output. A behaviour that changes in a later Vale release fails here, which is the point: the
# skill text is only backed while this test passes.
#
# Not reproducible here (mdx2vast is not installed in CI): the native-MDX halves of the mdx
# suppression table. Only the mdx2vast-absent E100 and the `[formats] mdx = md` column are asserted.
set -uo pipefail

if ! command -v vale &>/dev/null; then
  echo "SKIP: vale is not installed"
  exit 77
fi
EXPECTED="3.15.2"
GOT="$(vale --version | awk '{print $3}')"
if [[ "$GOT" != "$EXPECTED" ]]; then
  echo "SKIP: behaviours are pinned to Vale $EXPECTED, found $GOT"
  exit 77
fi

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

WORK="$(mktemp -d)"
trap 'rm -rf "$WORK"' EXIT

OUT="" RC=0
# run <dir> <vale args...>: run vale from <dir>, capture combined output and exit code.
run() {
  local dir="$1"; shift
  OUT="$(cd "$dir" && vale --no-wrap "$@" 2>&1)"; RC=$?
  OUT="$(sed $'s/\x1b\\[[0-9;]*m//g' <<<"$OUT")"
}
# expect <label> <rc> <grep-fixed-pattern-or-empty>
expect() {
  local label="$1" rc="$2" pat="${3:-}"
  if [[ "$RC" -ne "$rc" ]]; then
    fail "$label: exit $RC, want $rc"; echo "$OUT" | sed 's/^/      /'; return
  fi
  if [[ -n "$pat" ]] && ! grep -qF -- "$pat" <<<"$OUT"; then
    fail "$label: output lacks '$pat'"; echo "$OUT" | sed 's/^/      /'; return
  fi
  pass "$label"
}

# tree <name>: fresh dir with styles/ and a one-line doc containing a repeated word.
tree() {
  local d="$WORK/$1"; mkdir -p "$d/styles"
  printf 'This is the the sample.\n' >"$d/doc.md"
  echo "$d"
}
rule() { # rule <dir> <style>: a one-rule custom style flagging the word "foo"
  mkdir -p "$1/styles/$2"
  cat >"$1/styles/$2/Foo.yml" <<'Y'
extends: existence
message: "found '%s'"
level: error
tokens:
  - foo
Y
}

echo "1. BasedOnStyles names a style absent from StylesPath"
d="$(tree c1)"
printf 'StylesPath = styles\n[*.md]\nBasedOnStyles = Nope\n' >"$d/.vale.ini"
run "$d" doc.md
expect "E100 loadStyles, exit 2" 2 "E100 [loadStyles]"
grep -qF "style 'Nope' does not exist on StylesPath" <<<"$OUT" && pass "message names the style" || fail "message names the style"

echo "2. vale sync for a name in BasedOnStyles but not Packages"
d="$(tree c2)"
printf 'StylesPath = styles\n[*.md]\nBasedOnStyles = Nope\n' >"$d/.vale.ini"
run "$d" sync
expect "Synced 0 package(s), exit 0" 0 "Synced 0 package(s)"
[[ -z "$(ls -A "$d/styles")" ]] && pass "nothing downloaded" || fail "nothing downloaded"
run "$d" doc.md
expect "next lint repeats E100" 2 "E100 [loadStyles]"

echo "3. StylesPath directory absent, only built-in Vale active"
d="$WORK/c3"; mkdir -p "$d"; printf 'x\n' >"$d/doc.md"
printf 'StylesPath = nostyles\n[*.md]\nBasedOnStyles = Vale\n' >"$d/.vale.ini"
run "$d" doc.md
expect "E201, exit 2" 2 "E201 Invalid value"
grep -q "does not exist" <<<"$OUT" && pass "path-does-not-exist message" || fail "path-does-not-exist message"

echo "4. Empty style directory loads and lints nothing"
d="$(tree c4)"; mkdir "$d/styles/Empty"
printf 'StylesPath = styles\n[*.md]\nBasedOnStyles = Empty\n' >"$d/.vale.ini"
run "$d" doc.md
expect "0 findings, exit 0" 0 "0 errors, 0 warnings and 0 suggestions"

echo "4b. Built-in Vale and committed YAML lint with no Packages entry"
d="$(tree c4b)"; rule "$d" Mine; printf 'a foo b\n' >>"$d/doc.md"
printf 'StylesPath = styles\n[*.md]\nBasedOnStyles = Vale, Mine\n' >"$d/.vale.ini"
run "$d" doc.md
expect "built-in Vale.Repetition fires, exit 1" 1 "Vale.Repetition"
grep -qF "Mine.Foo" <<<"$OUT" && pass "committed style fires" || fail "committed style fires"

echo "4c. Style in Packages-only (not BasedOnStyles) lints nothing"
d="$(tree c4c)"; rule "$d" Mine; printf 'a foo b\n' >>"$d/doc.md"
printf 'StylesPath = styles\nPackages = Mine\n[*.md]\nBasedOnStyles =\n' >"$d/.vale.ini"
run "$d" doc.md
expect "0 findings, exit 0" 0 "0 errors, 0 warnings and 0 suggestions"

echo "5. Core option below a [glob] header"
d="$(tree c5)"
printf '[*.md]\nBasedOnStyles = Vale\nStylesPath = styles\n' >"$d/.vale.ini"
run "$d" doc.md
expect "E201 core option, exit 2" 2 "is a core option"
d="$(tree c5b)"
printf 'StylesPath = styles\n[*.md]\nBasedOnStyles = Vale\nMinAlertLevel = error\n' >"$d/.vale.ini"
run "$d" doc.md
expect "MinAlertLevel below glob also E201" 2 "is a core option"
d="$(tree c5c)"
printf 'StylesPath = styles\n[*.md]\nBasedOnStyles = Vale\nPackages = Foo\n' >"$d/.vale.ini"
run "$d" doc.md
expect "Packages below glob: no error (exit 1 from the repetition finding)" 1 "Vale.Repetition"
run "$d" ls-config
grep -q '"Packages": false' <<<"$OUT" && pass "Packages parsed as per-glob rule toggle" || fail "Packages parsed as per-glob rule toggle"
run "$d" sync
expect "sync reports Synced 0 package(s)" 0 "Synced 0 package(s)"

echo "6. text.frontmatter.<key> scope across YAML forms"
d="$WORK/c6"; mkdir -p "$d/styles/FM"
cat >"$d/styles/FM/Foo.yml" <<'Y'
extends: existence
message: "found '%s'"
level: error
scope: text.frontmatter.description
tokens:
  - foo
Y
printf 'StylesPath = styles\n[*.md]\nBasedOnStyles = FM\n' >"$d/.vale.ini"
fm() { # fm <name> <frontmatter lines...>
  local n="$1"; shift
  { echo '---'; printf '%s\n' "$@"; echo '---'; echo; echo 'Body.'; } >"$d/$n.md"
}
fm single 'description: has foo here'
fm literal 'description: |' '  line one' '  has foo here'
fm folded 'description: >' '  line one' '  has foo here'
fm plain 'description: line one' '  has foo here'
fm squote "description: 'line one" "  has foo here'"
fm dquote 'description: "line one' '  has foo here"'
run "$d" single.md;  expect "single line lints" 1 "Foo"
run "$d" literal.md; expect "| literal lints" 1 "Foo"
run "$d" folded.md;  expect "> folded silent" 0 "0 errors"
run "$d" plain.md;   expect "plain continuation silent" 0 "0 errors"
run "$d" squote.md;  expect "single-quoted multi-line silent" 0 "0 errors"
run "$d" dquote.md;  expect "double-quoted multi-line silent" 0 "0 errors"

echo "7. .mdx without mapping and without mdx2vast"
d="$WORK/c7"; mkdir -p "$d/styles"
printf 'This is the the sample.\n' >"$d/doc.md"; cp "$d/doc.md" "$d/doc.mdx"
printf 'StylesPath = styles\n[*.{md,mdx}]\nBasedOnStyles = Vale\n' >"$d/.vale.ini"
if command -v mdx2vast &>/dev/null; then
  echo "  SKIP: mdx2vast is installed; the absent-binary case cannot run"
else
  run "$d" .
  expect "whole invocation dies with E100 lintMDX, exit 2" 2 "E100 [lintMDX]"
  grep -qF "mdx2vast not found" <<<"$OUT" && pass "mdx2vast not found" || fail "mdx2vast not found"
  grep -q "doc.md" <<<"$OUT" && fail ".md alongside produced no output" || pass ".md alongside produced no output"
fi

echo "8. mdx mapped onto md: suppression form"
d="$WORK/c8"; mkdir -p "$d/styles"
printf 'StylesPath = styles\n[formats]\nmdx = md\n[*.{md,mdx}]\nBasedOnStyles = Vale\n' >"$d/.vale.ini"
printf 'This is the the sample.\n' >"$d/ctl.mdx"
printf '<!-- vale off -->\nThis is the the sample.\n<!-- vale on -->\n' >"$d/html.mdx"
printf '{/* vale off */}\nThis is the the sample.\n{/* vale on */}\n' >"$d/jsx.mdx"
run "$d" ctl.mdx;  expect "control alerts" 1 "Vale.Repetition"
run "$d" html.mdx; expect "HTML comment suppresses" 0 "0 errors"
run "$d" jsx.mdx;  expect "JSX comment does not suppress" 1 "Vale.Repetition"

echo "9. spelling ignore path resolution"
mk_spell() { # mk_spell <name> ; leaves rule with ignore1.txt, no ignore file placed
  local d; d="$WORK/$1"; mkdir -p "$d/styles/MyStyle" "$d/proj"
  cat >"$d/styles/MyStyle/Spell.yml" <<'Y'
extends: spelling
message: "Did you really mean '%s'?"
level: error
ignore:
  - ignore1.txt
Y
  printf 'The zzqwidget is here.\n' >"$d/proj/doc.md"
  printf 'StylesPath = ../styles\n[*.md]\nBasedOnStyles = MyStyle\n' >"$d/proj/.vale.ini"
  echo "$d"
}
d="$(mk_spell s1)"; printf 'zzqwidget\n' >"$d/styles/ignore1.txt"
run "$d/proj" doc.md; expect "ignore file at StylesPath root works" 0 "0 errors"
d="$(mk_spell s2)"; printf 'zzqwidget\n' >"$d/proj/ignore1.txt"
run "$d/proj" doc.md; expect "ignore file in working directory works" 0 "0 errors"
run "$d" --config=proj/.vale.ini proj/doc.md; expect "working-dir copy fails from another directory" 1 "zzqwidget"
d="$(mk_spell s3)"; printf 'zzqwidget\n' >"$d/styles/MyStyle/ignore1.txt"
run "$d/proj" doc.md; expect "ignore file beside the rule is not read" 1 "zzqwidget"
d="$(mk_spell s4)"
run "$d/proj" doc.md; expect "absent ignore file fails silently" 1 "zzqwidget"
grep -qi "ignore1" <<<"$OUT" && fail "no diagnostic emitted for missing ignore file" || pass "no diagnostic emitted for missing ignore file"

echo "10. ls-config reports styles and paths, never rules"
d="$(tree c10)"; rule "$d" MyStyle
printf 'StylesPath = styles\n[*.md]\nBasedOnStyles = MyStyle\n' >"$d/.vale.ini"
printf 'a foo b\n' >"$d/doc.md"
run "$d" doc.md; expect "rule fires" 1 "MyStyle.Foo"
run "$d" ls-config
grep -qF '"MyStyle"' <<<"$OUT" && pass "ls-config names the style" || fail "ls-config names the style"
grep -qF 'Foo' <<<"$OUT" && fail "ls-config must not name the rule" || pass "ls-config does not name the rule"
for sub in ls-dirs ls-vars ls-metrics; do
  run "$d" "$sub"
  grep -qF 'Foo' <<<"$OUT" && fail "$sub must not name the rule" || pass "$sub does not name the rule"
done
run "$d" ls-config
grep -qF '"Checks": null' <<<"$OUT" && pass "Checks: null" || fail "Checks: null"

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