Skip to content

chore: finish consistency audit cleanups - #490

Merged
HugoRCD merged 2 commits into
HugoRCD:mainfrom
happykawayigt:codex/consistency-audit-cleanups
Aug 1, 2026
Merged

chore: finish consistency audit cleanups#490
HugoRCD merged 2 commits into
HugoRCD:mainfrom
happykawayigt:codex/consistency-audit-cleanups

Conversation

@happykawayigt

@happykawayigt happykawayigt commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • silence the two intentional Nitro v3 max-params warnings using the existing local exemption pattern
  • update the adapter skill for the current categorized documentation paths and remove obsolete custom.md renumbering
  • explain that new PR scopes must already exist on the base branch or the subsystem PR title must remain unscoped

Validation

  • git diff --check
  • verified all documented paths exist and no stale 4.adapters / custom.md instructions remain
  • full local install could not complete because the C: drive reached ENOSPC; the incomplete node_modules and pnpm cache were removed, so the complete lint/typecheck/test matrix is left to Draft PR CI

Closes #488

Summary by CodeRabbit

  • Documentation

    • Updated adapter creation guidance to reflect the current documentation structure and validation steps.
    • Clarified framework integration PR title and scope-registration requirements.
    • Updated new-subsystem guidance for scope registration across pull requests.
  • Code Quality

    • Resolved linting warnings in event processing without changing functionality.

@changeset-bot

changeset-bot Bot commented Aug 1, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: d4260d7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel

vercel Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

@happykawayigt is attempting to deploy a commit to the HRCD Projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The PR updates adapter and framework integration workflow guidance for current documentation paths, changesets, verification, and scope validation. It also adds ESLint suppressions for two Nitro v3 helper functions that exceed the configured parameter limit.

Changes

Workflow guidance updates

Layer / File(s) Summary
Integration workflow guidance
.agents/skills/create-adapter/SKILL.md, .agents/skills/create-framework-integration/SKILL.md, AGENTS.md
The guidance uses categorized adapter documentation paths, replaces custom.md renumbering with changeset instructions, adds workspace preparation before verification, and permits scope registration in a preceding PR or omission from the subsystem PR.

Nitro plugin lint cleanup

Layer / File(s) Summary
Nitro helper lint suppressions
packages/evlog/src/nitro-v3/plugin.ts
Adds max-params suppression comments before callDrainHook and callEnrichAndDrain.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested labels: documentation

Suggested reviewers: hugorcd

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the repository-wide consistency cleanup changes.
Description check ✅ Passed The description covers the changes, linked issue, and validation results, but it omits the template checklist.
Linked Issues check ✅ Passed The changes satisfy the coding objectives in issue #488, including lint suppressions, documentation updates, and scope guidance.
Out of Scope Changes check ✅ Passed All changes support issue #488 objectives and no unrelated code or documentation changes are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Aug 1, 2026

Copy link
Copy Markdown
Contributor

Thank you for following the naming conventions! 🙏

@pkg-pr-new

pkg-pr-new Bot commented Aug 1, 2026

Copy link
Copy Markdown
npm i https://pkg.pr.new/@evlog/cli@490
npm i https://pkg.pr.new/evlog@490
npm i https://pkg.pr.new/@evlog/nuxthub@490
npm i https://pkg.pr.new/@evlog/telemetry@490

commit: 6df5fc8

@happykawayigt
happykawayigt marked this pull request as ready for review August 1, 2026 20:34

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.agents/skills/create-adapter/SKILL.md (1)

143-153: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Run pnpm run dev:prepare before package validation after a clean install.

The verification block starts in packages/evlog, but the repository instructions require root pnpm run dev:prepare before lint and typecheck after a clean install. Without it, generated framework TypeScript configuration can be missing and validation can fail.

Add pnpm run dev:prepare before cd packages/evlog, or document this prerequisite.

The root AGENTS.md specifies this preparation step for clean installs.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/create-adapter/SKILL.md around lines 143 - 153, Update the
Verification section to run the repository-root pnpm run dev:prepare before
entering packages/evlog and running package validation. Preserve the existing
lint, typecheck, test, and build commands, and note that preparation is required
after a clean install.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.agents/skills/create-adapter/SKILL.md:
- Around line 28-32: Add an eighth touchpoint to the adapter checklist for
creating a minor `.changeset/*.md` entry describing the new adapter, and update
the completion requirement from seven to eight touchpoints. Keep the existing
seven checklist items unchanged.

In @.agents/skills/create-framework-integration/SKILL.md:
- Line 467: Update the instruction in SKILL.md to require inserting the new
framework scope alphabetically in both scope lists, preserving the repository’s
AGENTS.md sorting rule.

---

Outside diff comments:
In @.agents/skills/create-adapter/SKILL.md:
- Around line 143-153: Update the Verification section to run the
repository-root pnpm run dev:prepare before entering packages/evlog and running
package validation. Preserve the existing lint, typecheck, test, and build
commands, and note that preparation is required after a clean install.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: d8bb18c4-6e97-41ca-8289-e6b639983bae

📥 Commits

Reviewing files that changed from the base of the PR and between a65397d and 6df5fc8.

📒 Files selected for processing (4)
  • .agents/skills/create-adapter/SKILL.md
  • .agents/skills/create-framework-integration/SKILL.md
  • AGENTS.md
  • packages/evlog/src/nitro-v3/plugin.ts

Comment thread .agents/skills/create-adapter/SKILL.md Outdated
## Step 15 & 16: PR Scopes

Add the framework name as a valid scope in **both** files so PR title validation passes:
Add the framework name as a valid scope in **both** files for future PRs. The semantic PR check reads its scope list from the base branch, so the integration PR must either use an unscoped title (as recommended above) or follow a preceding PR that registers the scope.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Require alphabetical insertion in both scope lists.

This instruction says to add the framework scope to both files but does not say where to insert it. Add that the new scope must be inserted alphabetically in both lists.

The repository rule in AGENTS.md requires both scope lists to remain alphabetically sorted.

🧰 Tools
🪛 SkillSpector (2.4.4)

[warning] 498: [RP1] null: npx commands without a version suffix (e.g. @1.0.0) create a rug-pull risk if the upstream server is compromised and publishes a malicious update.

Remediation: Pin the version: npx @scope/server@1.2.3

(MCP Rug Pull (RP1))


[warning] 356: [AS3] Skill Enumeration: Skill enumerates or reads other installed skills. Access to other skills' SKILL.md files or the skills directory reveals prompt instructions, capabilities, and secrets that should be invisible to peer skills.

Remediation: Remove all code or instructions that list or read other skills' files or directories. Skills should operate independently; cross-skill access is a privilege escalation.

(Agent Snooping (AS3))

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/create-framework-integration/SKILL.md at line 467, Update the
instruction in SKILL.md to require inserting the new framework scope
alphabetically in both scope lists, preserving the repository’s AGENTS.md
sorting rule.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.agents/skills/create-adapter/SKILL.md:
- Around line 158-161: Update the verification commands in the generated
workspace types preparation block to invoke the repository-managed package
manager via corepack pnpm for every pnpm command, rather than bare pnpm; keep
the existing command sequence and checks unchanged.

In @.agents/skills/create-framework-integration/SKILL.md:
- Line 467: Clarify the guidance around registering the framework name in both
alphabetized scope lists: require the scope-registration PR to merge before
using feat({framework}): in the integration PR title, or instruct authors to use
an unscoped title until it merges.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: b703654f-6603-4735-a0a7-ee743b64e1a5

📥 Commits

Reviewing files that changed from the base of the PR and between 6df5fc8 and d4260d7.

📒 Files selected for processing (2)
  • .agents/skills/create-adapter/SKILL.md
  • .agents/skills/create-framework-integration/SKILL.md

Comment on lines +158 to +161
After a clean install, prepare generated workspace types from the repo root before running the package checks:

```bash
pnpm run dev:prepare

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Use the Corepack-managed pnpm executable.

The verification block invokes bare pnpm. This can select a different global version from the repository-managed version. Use corepack pnpm for each command, or enable Corepack explicitly before the block.

Based on learnings, this repository uses pnpm through Corepack.

🧰 Tools
🪛 SkillSpector (2.4.4)

[warning] 30: [AS3] Skill Enumeration: Skill enumerates or reads other installed skills. Access to other skills' SKILL.md files or the skills directory reveals prompt instructions, capabilities, and secrets that should be invisible to peer skills.

Remediation: Remove all code or instructions that list or read other skills' files or directories. Skills should operate independently; cross-skill access is a privilege escalation.

(Agent Snooping (AS3))


[warning] 134: [AS3] Skill Enumeration: Skill enumerates or reads other installed skills. Access to other skills' SKILL.md files or the skills directory reveals prompt instructions, capabilities, and secrets that should be invisible to peer skills.

Remediation: Remove all code or instructions that list or read other skills' files or directories. Skills should operate independently; cross-skill access is a privilege escalation.

(Agent Snooping (AS3))

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/create-adapter/SKILL.md around lines 158 - 161, Update the
verification commands in the generated workspace types preparation block to
invoke the repository-managed package manager via corepack pnpm for every pnpm
command, rather than bare pnpm; keep the existing command sequence and checks
unchanged.

Source: Learnings

## Step 15 & 16: PR Scopes

Add the framework name as a valid scope in **both** files so PR title validation passes:
Add the framework name as a valid scope in **both** files for future PRs, keeping both scope lists alphabetically sorted. The semantic PR check reads its scope list from the base branch, so the integration PR must either use an unscoped title (as recommended above) or follow a preceding PR that registers the scope.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Require the scope-registration PR to merge first.

The semantic check reads scopes from the base branch. “Follow a preceding PR” does not state that the registration PR must be merged before this integration PR uses feat({framework}):. If the registration PR is still open, validation can reject the scoped title.

Proposed wording
-Add the framework name as a valid scope in both files for future PRs, keeping both scope lists alphabetically sorted. The semantic PR check reads its scope list from the base branch, so the integration PR must either use an unscoped title (as recommended above) or follow a preceding PR that registers the scope.
+Add the framework name as a valid scope in both files for future PRs, keeping both scope lists alphabetically sorted. The semantic PR check reads its scope list from the base branch, so merge the scope-registration PR before using a scoped title. Otherwise, keep the integration PR title unscoped.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Add the framework name as a valid scope in **both** files for future PRs, keeping both scope lists alphabetically sorted. The semantic PR check reads its scope list from the base branch, so the integration PR must either use an unscoped title (as recommended above) or follow a preceding PR that registers the scope.
Add the framework name as a valid scope in both files for future PRs, keeping both scope lists alphabetically sorted. The semantic PR check reads its scope list from the base branch, so merge the scope-registration PR before using a scoped title. Otherwise, keep the integration PR title unscoped.
🧰 Tools
🪛 SkillSpector (2.4.4)

[warning] 498: [RP1] null: npx commands without a version suffix (e.g. @1.0.0) create a rug-pull risk if the upstream server is compromised and publishes a malicious update.

Remediation: Pin the version: npx @scope/server@1.2.3

(MCP Rug Pull (RP1))


[warning] 356: [AS3] Skill Enumeration: Skill enumerates or reads other installed skills. Access to other skills' SKILL.md files or the skills directory reveals prompt instructions, capabilities, and secrets that should be invisible to peer skills.

Remediation: Remove all code or instructions that list or read other skills' files or directories. Skills should operate independently; cross-skill access is a privilege escalation.

(Agent Snooping (AS3))

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In @.agents/skills/create-framework-integration/SKILL.md at line 467, Clarify
the guidance around registering the framework name in both alphabetized scope
lists: require the scope-registration PR to merge before using
feat({framework}): in the integration PR title, or instruct authors to use an
unscoped title until it merges.

@HugoRCD
HugoRCD merged commit f3ec7ac into HugoRCD:main Aug 1, 2026
5 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: two small cleanups left from the consistency audit

2 participants