QBall-IncQBall-Inc/the-bulwark/skills/component-patterns/SKILL.md

component-patterns

Skill8 starsChanged 5 months agoMITView on GitHub

Per-component-type verification approaches. Use when generating verification scripts for different component types.

In this repository29 other files it gives its agents.
- anthropic-validatorSkill
- assertion-patternsSkill
- bug-magnet-dataSkill
- bulwark-brainstormSkill
- bulwark-researchSkill
- bulwark-scaffoldSkill
- bulwark-statuslineSkill
- bulwark-verifySkill
- code-reviewSkill
- continuous-feedbackSkill
- create-skillSkill
- create-subagentSkill
- fix-bugSkill
- governance-protocolSkill
- initSkill
- issue-debuggingSkill
- mock-detectionSkill
- pipeline-templatesSkill
- plan-creationSkill
- plan-to-tasksSkill
- product-ideationSkill
- session-handoffSkill
- setup-lspSkill
- spec-drift-checkSkill
- subagent-output-templatingSkill
- subagent-promptingSkill
- test-auditSkill
- test-classificationSkill
- test-fixture-creationSkill

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Read the appropriate pattern file from references/:
line 71
Distinctive:
Generic/Other: Use Bash template
line 82
Distinctive:
All patterns follow the same principle: verify observable output, not mock calls.
line 112
Very specific:
Write diagnostic output to logs/diagnostics/component-patterns-{YYYYMMDD-HHMMSS}.yaml:
line 125

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

Component Patterns

Purpose

Provide verification strategies for different component types. This skill defines how to test real behavior for CLIs, servers, parsers, processes, databases, and external APIs.

When to Use

Load this skill when:

Generating verification scripts via bulwark-verify skill
Determining how to test a specific component type
Implementing test-audit Step 7 rewrites

Component Type Detection

Analyze the code to determine component type based on these indicators:

Indicators	Component Type	Pattern Reference
Imports `child_process`, has `spawn`/`exec`/`execSync`	Process Spawner	`references/pattern-process-spawner.md`
Imports `http`/`https`/`express`/`fastify`/`koa`, has `listen()`	HTTP Server	`references/pattern-http-server.md`
Imports `fs`, reads/parses files, has parse functions	File Parser	`references/pattern-file-parser.md`
Has CLI argument parsing (`process.argv`, `yargs`, `commander`, `argparse`)	CLI Command	`references/pattern-cli-command.md`
Imports database driver (`pg`, `mysql`, `mongoose`, `sqlite`, `prisma`)	Database	`references/pattern-database.md`
Makes outbound HTTP calls (`fetch`, `axios`, `got`, `requests`)	External API	`references/pattern-external-api.md`

Pattern Reference Files

Each pattern reference contains:

Strategy: High-level approach for testing the component type
Templates: Ready-to-use verification script templates in Bash, Node/Jest, and Python/pytest
Placeholders: Variables to substitute with component-specific values

Available Patterns

Pattern	File	Languages
CLI Command	`references/pattern-cli-command.md`	Bash, Node, Python
HTTP Server	`references/pattern-http-server.md`	Bash, Node (supertest), Python
File Parser	`references/pattern-file-parser.md`	Bash, Node, Python
Process Spawner	`references/pattern-process-spawner.md`	Bash, Node
Database	`references/pattern-database.md`	Node, Python, Bash (SQLite)
External API	`references/pattern-external-api.md`	Node (MSW), Python (responses)

Usage Instructions

Step 1: Detect Component Type

Analyze the target component code using the detection table above.

Step 2: Load Pattern Reference

Read the appropriate pattern file from references/:

Read skills/component-patterns/references/pattern-{type}.md

Step 3: Select Template

Choose the template that matches the project language:

Node projects (package.json present): Use Node/Jest template
Python projects (pyproject.toml or setup.py present): Use Python/pytest template
Generic/Other: Use Bash template

Step 4: Substitute Placeholders

Replace all {placeholder} values with component-specific information:

Common Placeholders	Description
`{component_name}`	Name of the component being tested
`{component_path}`	Import path to the module
`{port}`	Network port (for servers/processes)
`{expected_value}`	Expected output to verify

Quick Reference: Component to Pattern

Component Type	Verification Strategy	Key Assertion
CLI Command	Spawn, capture stdout/stderr	Exit code + output text
HTTP Server	Start, HTTP request, verify response	Status code + response body
File Parser	Create input, parse, check structure	Parsed fields + values
Process Spawner	Spawn, check port/pid, verify behavior	Process alive + responds
Database	Setup DB, execute ops, query state	Records exist/modified
External API	MSW intercept, real fetch, check result	Response data matches

Key Principle: Real Verification

All patterns follow the same principle: verify observable output, not mock calls.

Anti-Pattern	Real Pattern
`expect(spawn).toHaveBeenCalled()`	`expect(await checkPort(8080)).toBe(true)`
`expect(fs.writeFile).toHaveBeenCalled()`	`expect(fs.existsSync(path)).toBe(true)`
`expect(fetch).toHaveBeenCalledWith(url)`	`const resp = await fetch(url); expect(resp.status).toBe(200)`
`expect(db.save).toHaveBeenCalled()`	`const found = await db.find(id); expect(found).toBeDefined()`

Diagnostic Output

Write diagnostic output to logs/diagnostics/component-patterns-{YYYYMMDD-HHMMSS}.yaml:

skill: component-patterns
timestamp: {ISO-8601}
diagnostics:
  component_type_detected: cli|http|file-parser|process|database|api
  pattern_applied: "CLI Command Verification"
  template_language: bash|node|python
  files_analyzed: 1
  completion_status: success

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.

Check your setup, free