Skip to content

chore(docs): update AGENTS.md to reflect recent changes - #124

Open
RedStar071 wants to merge 1 commit into
mainfrom
claude/nice-dijkstra-mnc6yk
Open

RedStar071 wants to merge 1 commit into
mainfrom
claude/nice-dijkstra-mnc6yk

Conversation

@RedStar071

@RedStar071 RedStar071 commented Oct 11, 2026 •

Copy link
Copy Markdown
Member

Context

Weekly AGENTS.md maintenance review of PRs merged into main in the last 7 days (2026-10-04 – 2026-10-11).

Only one PR merged in the window: #123 "chore(deps): update dependencies and migrate to http-framework 6". It bumped @wolfstar/http-framework from ^4.0.2 to ^6.2.2 and, as part of that migration, moved the ApplyOptions utility decorator (and other utility decorators like Requires*) out of @wolfstar/http-framework into a new @wolfstar/decorators package. src/middlewares/requestLogger.ts now imports ApplyOptions from @wolfstar/decorators instead of @wolfstar/http-framework.

.github/copilot-instructions.md (the file AGENTS.md delegates to) still documented the old state, which was now actively wrong and would mislead an agent writing new middleware.

Changes

  • API Route Structure / Middleware example: corrected the @ApplyOptions description and code sample to import from @wolfstar/decorators instead of @wolfstar/http-framework, and noted the package split happened in http-framework 6.
  • Key Dependencies: added an entry for @wolfstar/decorators, noting it was split out of @wolfstar/http-framework and that only ApplyOptions is currently used in this repo.

No other recent changes (dependency version bumps, lockfile maintenance, workspace config) required documentation updates — development commands, naming conventions, directory structure, and other patterns in the file remain accurate.

🤖 Generated with Claude Code

https://claude.ai/code/session_013GQkdeyfeWfftSHscqFgnk


Generated by Claude Code

RetriggerConfidence Score: 5/5

Safe to merge. The corrected guidance matches the working middleware and shared package exports, and the updated example passes compilation and runtime checks.

T-Rex evidence

Command output from the check

  • Compiled and executed the exact base Middleware example against installed dependencies, showing that its framework ApplyOptions import is unavailable.

Command output from the check

  • Compiled and executed the HEAD example and actual request logger, showing that the documented import, exports, and Middleware options contract work.

Command output from the check

  • Captured the scoped documentation, shared exports and changelog, installed interfaces, related manifests, and consumer searches, supporting the corrected guidance.

Command output from the check

  • Captured the complete harness execution with command, working directory, and exit code 0, confirming that the comparison and inspection completed successfully.

Command output from the check

  • Captured the initial TypeScript root API error before switching runtime emission to the installed transpiler, documenting a harness issue rather than an application defect.

Command output from the check

  • Captured successful contract checks followed by a package metadata export restriction, which was resolved by reading the installed package file directly.

Evidence from the check

  • Contains the exact authored harness that extracts both Git snippets, runs compilation and runtime checks, generates fixtures, and captures observed outputs.

Evidence from the check

  • Contains the exact shell commands used to inspect relevant documentation, dependencies, shared source, changelogs, and consumers without modifying repository source.

Evidence from the check

  • Contains the TypeScript snippet extracted directly from the base Git object and compiled in the failing comparison.

Evidence from the check

  • Contains the TypeScript snippet extracted directly from the HEAD Git object and compiled successfully in the corrected comparison.

Evidence from the check

  • Contains the isolated configuration extending project TypeScript settings and including the base example plus actual request logger.

Evidence from the check

  • Contains the matching isolated configuration extending project TypeScript settings and including the HEAD example plus actual request logger.

Evidence from the check

  • Contains the emitted base example and Middleware assertions, whose execution stops at the unavailable named import.

Evidence from the check

  • Contains the emitted HEAD example and executed assertions for option merging, Middleware identity, and request logger behavior, all of which pass.

Evidence from the check

  • Contains the exact runtime probe that observes framework exports and attempts to load the base example, demonstrating the missing export.

Evidence from the check

  • Contains the exact runtime probe that asserts ApplyOptions and all four Requires utilities are functions before executing the passing example.

Evidence from the check

  • Contains the transpiled actual requestLogger source used by the runtime assertions, confirming the existing consumer works with the documented decorator.

View artifacts

Reviews (1) · Last reviewed commit: "docs: update AGENTS.md guidance for http..." · Reviewed by Greptile

PR #123 migrated staryl to @wolfstar/http-framework ^6.2.2, which moved the
ApplyOptions decorator (and other utility decorators) out into a new
@wolfstar/decorators package. Update the agent instructions so the
middleware example and Key Dependencies list reflect the new import source.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013GQkdeyfeWfftSHscqFgnk
@coldtea-pr-lens

Copy link
Copy Markdown

Note

The title starts with chore(docs):, so PR Lens left this pull request undrawn. Comment @pr-lens draw to draw it

github.comment.notice: false in .github/pr-lens.yml turns this note off

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ No critical issues — one related doc left stale.

Reviewed changes

Docs-only review of the single commit; I checked each claim against package.json and src/middlewares/requestLogger.ts.

  • Middleware example: @ApplyOptions now imported from @wolfstar/decorators, matching requestLogger.ts:2.
  • Key Dependencies: new @wolfstar/decorators entry, consistent with the ^0.1.0 dependency in package.json.

ℹ️ .github/CONTRIBUTING.md still documents the removed #utils/applyOptions shim

.github/CONTRIBUTING.md (around lines 216–224) still says middleware uses "the local @ApplyOptions decorator (#utils/applyOptions)" and imports from #utils/applyOptions. That module no longer exists in src/, so a contributor following it would write a broken import. This predates the PR, but it is the same drift this PR fixes in copilot-instructions.md, so it fits here.

Technical details
# Stale middleware docs in CONTRIBUTING.md

## Affected sites
- .github/CONTRIBUTING.md:216 — prose says "local `@ApplyOptions` decorator (`#utils/applyOptions`)"
- .github/CONTRIBUTING.md:221 — `import { ApplyOptions } from "#utils/applyOptions";`

## Required outcome
- Prose and example import match `@wolfstar/decorators`, as in `.github/copilot-instructions.md`.

Pullfrog  | Fix it ➔ | View workflow run | Using claude-sonnet-5-5 | 𝕏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants