Skip to content

docs(agents): add typed-test checklist to the ESLint suppressions guidance - #1420

Open
easonLiangWorldedtech wants to merge 1 commit into
Zoo-Code-Org:mainfrom
easonLiangWorldedtech:docs/agents-typed-test-guidance
Open

docs(agents): add typed-test checklist to the ESLint suppressions guidance#1420
easonLiangWorldedtech wants to merge 1 commit into
Zoo-Code-Org:mainfrom
easonLiangWorldedtech:docs/agents-typed-test-guidance

Conversation

@easonLiangWorldedtech

Copy link
Copy Markdown
Contributor

Closes #1419.

Adds a concise typed-test checklist to the ESLint Suppressions section of AGENTS.md so agents do not add blanket no-explicit-any suppression entries for new or substantially changed test files:

  • Typed structural doubles: mock context/proxy classes typed against the real public types they stand in for, unknown for storage values and mock callback parameters.
  • Bracket notation for private members; public members called without casts so their generic signatures keep checking arguments.
  • A single documented construction-site double assertion instead of per-use as any casts.
  • Required validation: check-types + narrowest Vitest suite + eslint --prune-suppressions with no new entry and no raised count.
  • An exception requires a next-to-cast comment and maintainer approval.

Documentation-only change, grounded in the typing pass that retired the 137-count parallelMode suppression entry in #977 (f91e19c).

…dance

Closes Zoo-Code-Org#1419.

Agents kept adding blanket no-explicit-any suppression entries for large
new test files (137 in the parallelMode spec of Zoo-Code-Org#977). Give the ESLint
Suppressions section a concrete typed-test workflow so the existing
"counts must never increase" rule is applied consistently at test-file
scale: typed structural doubles, bracket notation for private members,
single documented construction-site double assertions, the required
check-types + vitest + eslint --prune-suppressions validation, and a
maintainer-approved exception path.

Documentation-only change.
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

Next included review available in 21 minutes.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c223cf4e-501f-402f-b2f0-cb59f475bf82

📥 Commits

Reviewing files that changed from the base of the PR and between b0fdbc7 and 9c00ef4.

📒 Files selected for processing (1)
  • AGENTS.md

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.

@codecov

codecov Bot commented Aug 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions github-actions Bot added the awaiting-review PR changes are ready and waiting for maintainer re-review label Aug 28, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Review process

Thanks for contributing. This comment tracks the review sequence and the next action.

  1. Required CI checks pass.
  2. The workflow starts CodeRabbit automatically.
  3. CodeRabbit reviews and approves the latest commit.
  4. A human maintainer reviews and approves after CodeRabbit.

Current step: Required CI passed. Wait for CodeRabbit to approve the latest commit.

@github-actions github-actions Bot added coderabbit-review-active Required CI passed; CodeRabbit review is active awaiting-coderabbit Waiting for CodeRabbit to approve the latest commit awaiting-review PR changes are ready and waiting for maintainer re-review and removed awaiting-review PR changes are ready and waiting for maintainer re-review labels Aug 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting-coderabbit Waiting for CodeRabbit to approve the latest commit awaiting-review PR changes are ready and waiting for maintainer re-review coderabbit-review-active Required CI passed; CodeRabbit review is active

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enhance AGENTS.md guidance for typed tests and ESLint suppressions

2 participants