verify.yml Starter Kits

.planwright/verify.yml

The test commands agents are handed. Commit it; it applies once it lands on your default branch.

version: 1
setup: pnpm install --frozen-lockfile && pnpm exec playwright install chromium
run: >-
  status=0;
  pnpm vitest run -t "{grep}" --passWithNoTests
  --reporter=junit --outputFile=reports/junit.xml
  --coverage --coverage.reporter=lcov --coverage.reportsDirectory=coverage
  --coverage.reportOnFailure
  || status=1;
  PLAYWRIGHT_JSON_OUTPUT_NAME=reports/playwright.json
  pnpm playwright test --grep "{grep}" --pass-with-no-tests --reporter=json
  || status=1;
  exit $status
files: pnpm vitest run {files} --passWithNoTests --reporter=junit --outputFile=reports/files.xml
reports:
  - path: reports/junit.xml
    format: junit
  - path: reports/playwright.json
    format: playwright
  - path: reports/files.xml
    format: junit
  - path: coverage/lcov.info
    format: lcov
coverage: pnpm vitest run {file} --coverage --coverage.reporter=lcov --coverage.reportsDirectory=coverage
full: >-
  status=0;
  pnpm vitest run --reporter=junit --outputFile=reports/junit.xml || status=1;
  PLAYWRIGHT_JSON_OUTPUT_NAME=reports/playwright.json
  pnpm playwright test --reporter=json || status=1;
  exit $status

src/notes.test.ts

Unit tests. The marker ends the title; the last test has none, so it runs only with the full suite.

import { describe, expect, it } from "vitest";
import { addNote } from "./notes";

describe("addNote", () => {
  it("refuses a blank note [AC:3f2a91c0:ac_3]", () => {
    expect(() => addNote([], "   ")).toThrow("blank");
  });

  it("never stores surrounding whitespace [INV:notes-trimmed]", () => {
    expect(addNote([], "  buy milk ")).toEqual(["buy milk"]);
  });

  it("keeps earlier notes", () => {
    expect(addNote(["a"], "b")).toEqual(["a", "b"]);
  });
});

e2e/notes.spec.ts

An end-to-end test with its own marker. A real one would open your app with page.goto.

import { expect, test } from "@playwright/test";

test("shows a saved note [AC:3f2a91c0:ac_1]", async ({ page }) => {
  await page.setContent("<ul><li>buy milk</li></ul>");
  await expect(page.getByRole("listitem")).toHaveText("buy milk");
});

.planwright/verify.yml

The test commands agents are handed. Commit it; it applies once it lands on your default branch.

version: 1
setup: python -m pip install -r requirements-dev.txt
run: >-
  python -m pytest --planwright {markers}
  --junitxml=reports/junit.xml
  --cov --cov-report=lcov:coverage/lcov.info
files: python -m pytest {files} --junitxml=reports/files.xml
reports:
  - path: reports/junit.xml
    format: junit
  - path: reports/files.xml
    format: junit
  - path: coverage/lcov.info
    format: lcov
coverage: python -m pytest {file} --cov --cov-report=lcov:coverage/lcov.info
full: python -m pytest --junitxml=reports/junit.xml

tests/test_notes.py

The marker is a parametrize id, so it lands in the test's name. The last test has none, so it runs only with the full suite.

import pytest

from notes import add_note


@pytest.mark.parametrize("marker", ["AC:3f2a91c0:ac_3"])
def test_refuses_a_blank_note(marker):
    with pytest.raises(ValueError, match="blank"):
        add_note([], "   ")


@pytest.mark.parametrize("marker", ["INV:notes-trimmed"])
def test_never_stores_surrounding_whitespace(marker):
    assert add_note([], "  buy milk ") == ["buy milk"]


def test_keeps_earlier_notes():
    assert add_note(["a"], "b") == ["a", "b"]

conftest.py

Adds --planwright: run only the tests whose names carry one of the given markers. Public pytest hooks only.

def pytest_addoption(parser):
    parser.addoption(
        "--planwright",
        nargs="*",
        metavar="MARKER",
        help="Run only tests whose names contain one of these [AC:...] / [INV:...] markers.",
    )


def pytest_collection_modifyitems(config, items):
    wanted = config.getoption("--planwright")
    if wanted is None:
        return
    selected, deselected = [], []
    for item in items:
        (selected if any(m in item.name for m in wanted) else deselected).append(item)
    if deselected:
        config.hook.pytest_deselected(items=deselected)
        items[:] = selected

.planwright/verify.yml

The test commands agents are handed. Commit it; it applies once it lands on your default branch.

version: 1
setup: go install gotest.tools/gotestsum@v1.12.0
run: >-
  status=0;
  gotestsum --junitfile reports/junit.xml --
  -run '/({grep})' -coverprofile=coverage.out ./...
  || status=1;
  mkdir -p coverage &&
  go run github.com/jandelgado/gcov2lcov@v1.1.1 -infile=coverage.out -outfile=coverage/absolute.info &&
  sed "s|^SF:$PWD/|SF:|" coverage/absolute.info > coverage/lcov.info;
  exit $status
files: >-
  gotestsum --junitfile reports/files.xml --
  $(for f in {files}; do echo "./$(dirname "$f")"; done | sort -u)
reports:
  - path: reports/junit.xml
    format: junit
  - path: reports/files.xml
    format: junit
  - path: coverage/lcov.info
    format: lcov
coverage: >-
  go test -coverprofile=coverage.out ./$(dirname {file}) &&
  mkdir -p coverage &&
  go run github.com/jandelgado/gcov2lcov@v1.1.1 -infile=coverage.out -outfile=coverage/absolute.info &&
  sed "s|^SF:$PWD/|SF:|" coverage/absolute.info > coverage/lcov.info
full: gotestsum --junitfile reports/junit.xml -- ./...

notes/notes_test.go

Each marked check is a subtest whose name ends with the marker. The last has none, so it runs only with the full suite.

package notes

import (
	"reflect"
	"testing"
)

func TestAddNote(t *testing.T) {
	t.Run("refuses a blank note [AC:3f2a91c0:ac_3]", func(t *testing.T) {
		if _, err := AddNote(nil, "   "); err == nil {
			t.Fatal("expected an error for a blank note")
		}
	})

	t.Run("never stores surrounding whitespace [INV:notes-trimmed]", func(t *testing.T) {
		got, _ := AddNote(nil, "  buy milk ")
		if !reflect.DeepEqual(got, []string{"buy milk"}) {
			t.Fatalf("got %q", got)
		}
	})

	t.Run("keeps earlier notes", func(t *testing.T) {
		got, _ := AddNote([]string{"a"}, "b")
		if !reflect.DeepEqual(got, []string{"a", "b"}) {
			t.Fatalf("got %q", got)
		}
	})
}