Skip to content

test(theme): expand test fixtures to cover default TypeDoc reflections - #240

Merged
avivkeller merged 1 commit into
webpack:mainfrom
moshams272:test/expand-theme-coverage
Aug 15, 2026
Merged

test(theme): expand test fixtures to cover default TypeDoc reflections#240
avivkeller merged 1 commit into
webpack:mainfrom
moshams272:test/expand-theme-coverage

Conversation

@moshams272

@moshams272 moshams272 commented Aug 12, 2026

Copy link
Copy Markdown
Member

Summary

This PR expands the theme tests to cover common TypeDoc reflections (e.g., Enums, Namespaces, Accessors, Standalone Functions) that are handled by default TypeDoc partials and helpers. This prevents poorly written overrides from passing the tests silently, while actually breaking the generated Markdown in production.

Note: While @enum and @namespace are not currently used in the webpack source code, adding them to the tests ensures our documentation theme remains safe.

Use of AI

To investigate the important reflections in TypeDoc.

Summary by CodeRabbit

  • Tests
    • Expanded theme coverage for numeric enums, generic functions, constants, accessors, namespaces, and merge utilities.
    • Added snapshot validation for namespace index pages and generated index.md files.
    • Updated expected documentation output to include the newly supported declaration examples.

@vercel

vercel Bot commented Aug 12, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
webpack-doc-kit Ready Ready Preview Aug 12, 2026 5:28pm

Request Review

@github-actions github-actions Bot added the tests Pull requests that update tests label Aug 12, 2026
@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 7b2a0f63-e449-427a-899f-03f16db024a1

📥 Commits

Reviewing files that changed from the base of the PR and between f02a9a0 and acca1f0.

📒 Files selected for processing (3)
  • tests/theme/fixtures/input.js
  • tests/theme/theme.test.mjs
  • tests/theme/theme.test.mjs.snapshot

Walkthrough

The theme fixtures now include a renamed standalone constant, a numeric enum, a generic function, an accessor class, and a namespace-like utility with a merge method. Theme test discovery now includes index.md files. The snapshot adds generated documentation for these declarations, their members, namespace indexes, and the numeric enum type.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the expansion of theme test fixtures for default TypeDoc reflections.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@avivkeller
avivkeller merged commit 2966726 into webpack:main Aug 15, 2026
14 checks passed
@moshams272
moshams272 deleted the test/expand-theme-coverage branch August 15, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tests Pull requests that update tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants