test(validate-skills): document test helpers with JSDoc
Added JSDoc to the test/assert/hasTriggerFinding helpers so the new test file documents its own helpers. No behaviour change — the suite still passes 3/3.
This commit is contained in:
parent
05c1b20458
commit
aba48f90f1
|
|
@ -26,6 +26,11 @@ let totalTests = 0;
|
||||||
let passedTests = 0;
|
let passedTests = 0;
|
||||||
const failures = [];
|
const failures = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run a single named test case, recording the result and printing a status line.
|
||||||
|
* @param {string} name - Human-readable test description.
|
||||||
|
* @param {Function} fn - Test body; throw to signal failure.
|
||||||
|
*/
|
||||||
function test(name, fn) {
|
function test(name, fn) {
|
||||||
totalTests++;
|
totalTests++;
|
||||||
try {
|
try {
|
||||||
|
|
@ -38,11 +43,21 @@ function test(name, fn) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Throw an Error with `message` when `condition` is falsy.
|
||||||
|
* @param {boolean} condition - Expression that must hold.
|
||||||
|
* @param {string} message - Failure message.
|
||||||
|
*/
|
||||||
function assert(condition, message) {
|
function assert(condition, message) {
|
||||||
if (!condition) throw new Error(message);
|
if (!condition) throw new Error(message);
|
||||||
}
|
}
|
||||||
|
|
||||||
// True when validateSkill emitted the SKILL-06 "Use when/Use if" trigger finding.
|
/**
|
||||||
|
* Whether validateSkill emitted the SKILL-06 "Use when/Use if" trigger finding
|
||||||
|
* for the given fixture skill directory.
|
||||||
|
* @param {string} skillName - Fixture subdirectory name under FIXTURES.
|
||||||
|
* @returns {boolean} True if the trigger-phrase finding was reported.
|
||||||
|
*/
|
||||||
function hasTriggerFinding(skillName) {
|
function hasTriggerFinding(skillName) {
|
||||||
const findings = validateSkill(path.join(FIXTURES, skillName));
|
const findings = validateSkill(path.join(FIXTURES, skillName));
|
||||||
return findings.some((f) => f.rule === 'SKILL-06' && /trigger phrase/i.test(f.detail));
|
return findings.some((f) => f.rule === 'SKILL-06' && /trigger phrase/i.test(f.detail));
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue