agentleFS
EndavaEndava/BEEQ/.agents/skills/write-unit-tests/SKILL.md

write-unit-tests

Skill162 starsChanged 11 days agoApache-2.0View on GitHub

Write Vitest unit tests for BEEQ shared utilities under `packages/beeq/src/shared/`. Use when adding or fixing tests for helpers and pure logic. For component behavior use write-e2e-tests.

11 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use security-audit and code-review.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • CloudflareSkill

    security-audit

    Security guidance and vulnerability review for codebases, APIs, services, CLI tools, libraries, and daemons. Use for security questions, focused reviews, vulnerability research, security audits, or pen tests. Run the complete workflow only for explicit codebase audit or pen-test requests, full/comprehensive/end-to-end reviews, or requested report artifacts.

    Also in 3 projects that use this

  • GoogleSkill

    code-review

    Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 2 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 10 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read the utility and list its branches: happy path, edge cases (null, undefined, empty string, 0, empty array), boundary values, error …

    line 15
  2. Very specific:

    Write one it('should <expected behavior>') per branch, in Arrange / Act / Assert order.

    line 17
  3. Distinctive:

    Run the file and fix failures.

    line 18
  4. Very specific:

    Call vi.restoreAllMocks() in afterEach, and vi.useRealTimers() as well when the test used vi.useFakeTimers().

    line 38
  5. Distinctive:

    Keep every test independent.

    line 39

“Common” is measured: kept by at least 6 in 10 of the 10 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Write BEEQ Unit Tests

Unit tests cover shared utilities only. For component tests (props, events, slots, DOM) use write-e2e-tests. General rules live in the testing instructions.

Procedure

  1. Read the utility and list its branches: happy path, edge cases (null, undefined, empty string, 0, empty array), boundary values, error conditions and side effects (callbacks called with the right args and count).
  2. Create packages/beeq/src/shared/utils/__tests__/<utility-name>.spec.ts.
  3. Write one it('should <expected behavior>') per branch, in Arrange / Act / Assert order.
  4. Run the file and fix failures.

Done when every branch from step 1 has a test and the file passes.

Conventions

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';

// Import from the barrel, not the individual file
import { myUtility } from '..';

describe(myUtility.name, () => {
  it('should <expected behavior>', () => {
    // Arrange, Act, Assert
  });
});
  • Name the describe block with fn.name so it follows renames.
  • Call vi.restoreAllMocks() in afterEach, and vi.useRealTimers() as well when the test used vi.useFakeTimers().
  • Keep every test independent; share no mutable state.

Run

pnpm exec nx run beeq:test -- <utility-name>.spec.ts

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.