Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions packages/cli/src/utils/feedbackLint.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@ describe("lintFeedbackComment", () => {
expect(warnings[0]?.message).toContain("REPRO COMMAND:");
});

it.each([
["marker only", "REPRO COMMAND:"],
["whitespace only", "REPRO COMMAND: \n \t"],
["same-line next packet section", "REPRO COMMAND: EXPECTED / ACTUAL: completes / hangs"],
["next packet section", ["REPRO COMMAND:", "EXPECTED / ACTUAL: completes / hangs"].join("\n")],
])("warns when the repro command body is %s", (_case, comment) => {
const warnings = lintFeedbackComment({ rating: 8, comment });

expect(warnings.map((warning) => warning.code)).toContain("missing-repro-command");
});

it("stays silent when the reporter already included a REPRO COMMAND: block", () => {
const warnings = lintFeedbackComment({
rating: 4,
Expand All @@ -42,6 +53,19 @@ describe("lintFeedbackComment", () => {
expect(warnings).toEqual([]);
});

it("accepts a repro command body on the following line", () => {
const warnings = lintFeedbackComment({
rating: 8,
comment: [
"Repro command:",
" cd project && npx hyperframes render",
"EXPECTED / ACTUAL: completes / hangs",
].join("\n"),
});

expect(warnings).toEqual([]);
});

it("warns on rating<=7 visual-defect comments missing COMPOSITION_STRUCTURE:", () => {
const warnings = lintFeedbackComment({
rating: 5,
Expand Down
41 changes: 38 additions & 3 deletions packages/cli/src/utils/feedbackLint.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,14 @@ export const COMPOSITION_STRUCTURE_RATING_CEILING = 7;

const REPRO_MARKER = "REPRO COMMAND:";
const STRUCTURE_MARKER = "COMPOSITION_STRUCTURE:";
const FEEDBACK_PACKET_MARKERS = [
REPRO_MARKER,
"EXPECTED / ACTUAL:",
"EXACT ERROR:",
"OUTCOME:",
"WORKAROUND:",
STRUCTURE_MARKER,
] as const;

export interface FeedbackLintInput {
rating: number;
Expand All @@ -56,7 +64,7 @@ export interface FeedbackLintWarning {
* 2. Comment missing / empty — no check. `feedback --rating 6` with no
* comment is a valid quick vote; the maintainer sees rating drift without
* the reporter having to synthesize a fake repro.
* 3. Comment present + rating < 10 + no `REPRO COMMAND:` — warn.
* 3. Comment present + rating < 10 + no non-empty `REPRO COMMAND:` body — warn.
* 4. Comment present + rating ≤ 7 + visual-defect keyword + no
* `COMPOSITION_STRUCTURE:` — warn (in addition to any #3 warning).
*/
Expand All @@ -72,11 +80,11 @@ export function lintFeedbackComment(input: FeedbackLintInput): FeedbackLintWarni
const upperTrimmed = trimmed.toUpperCase();
const warnings: FeedbackLintWarning[] = [];

if (!upperTrimmed.includes(REPRO_MARKER)) {
if (!hasReproCommandBody(trimmed)) {
warnings.push({
code: "missing-repro-command",
message: [
`Comment on a ${rating}/${FEEDBACK_RATING_SCALE} report is missing a "${REPRO_MARKER}" block —`,
`Comment on a ${rating}/${FEEDBACK_RATING_SCALE} report is missing a non-empty "${REPRO_MARKER}" block —`,
"maintainers can't rerun the failure from a symptom summary alone.",
"See `references/preview-render.md` → feedback for the required packet shape.",
].join(" "),
Expand All @@ -102,6 +110,33 @@ export function lintFeedbackComment(input: FeedbackLintInput): FeedbackLintWarni
return warnings;
}

/**
* A marker is useful only when it carries a command. Accept the command on the
* marker line or on the next non-empty line, but do not let the next packet
* section masquerade as the command body.
*/
function hasReproCommandBody(comment: string): boolean {
const lines = comment.split(/\r?\n/);

return lines.some((line, index) => {
const markerIndex = line.toUpperCase().indexOf(REPRO_MARKER);
if (markerIndex === -1) return false;

const inlineBody = line.slice(markerIndex + REPRO_MARKER.length).trim();
if (inlineBody) return !startsWithFeedbackPacketMarker(inlineBody);

const nextContentLine = lines.slice(index + 1).find((candidate) => candidate.trim());
if (!nextContentLine) return false;

return !startsWithFeedbackPacketMarker(nextContentLine.trimStart());
});
}

function startsWithFeedbackPacketMarker(value: string): boolean {
const upperValue = value.toUpperCase();
return FEEDBACK_PACKET_MARKERS.some((marker) => upperValue.startsWith(marker));
}

// Compile once. Word-boundary at both sides prevents "black" matching
// "blackboard", "blank" matching "blanket", "visual" matching "visualize".
// Plural forms (e.g. "flickers") won't match — accepted tradeoff for a soft
Expand Down
Loading