Fix verifyExamples.spec.ts to check if the excluded symbol is actually exported at all by PavelVanecek · Pull Request #7476 · recharts/recharts

PavelVanecek · 2026-06-20T07:55:47Z

Docs test only

Summary by CodeRabbit

New Features
- Added new method to retrieve all exported symbol names from the project, providing comprehensive access to the library's complete public exports without filtering.
Tests
- Updated example coverage verification rules to strengthen documentation standards across library exports with enhanced validation checks.

…y exported at all

coderabbitai · 2026-06-20T07:56:00Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ceb0fc09-eb78-4acc-8bf3-f5ba328324c7

📥 Commits

Reviewing files that changed from the base of the PR and between df650b4 and 71c1509.

📒 Files selected for processing (3)

omnidoc/DocReader.ts
omnidoc/readProject.ts
omnidoc/verifyExamples.spec.ts

Walkthrough

Adds a new getAllExportedNames() method to ProjectDocReader that returns all public exported symbol names without filtering. Updates DocReader interface doc comments for accuracy. Removes NiceTicks and AnimationStatus from the example-coverage exclusion list, and adds a test assertion that each excluded name still exists in the public exports.

Changes

Omnidoc export enumeration and example verification

Layer / File(s)	Summary
DocReader interface comments and `getAllExportedNames()` method `omnidoc/DocReader.ts`, `omnidoc/readProject.ts`	Doc comments on `getPublicSymbolNames()` and `getAllRuntimeExportedNames()` are corrected. `getAllExportedNames()` is added to `ProjectDocReader`, delegating to `getPublicSymbolNames()` with no `SymbolFlags` filter.
verifyExamples: remove exclusions and add presence assertion `omnidoc/verifyExamples.spec.ts`	`NiceTicks` and `AnimationStatus` are removed from the `exportsThatNeedExamples` exclusion array. A new `it` block is added to the parameterized excluded-export and excluded-prop suites asserting each excluded name is found in `getPublicSymbolNames()`.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

recharts/recharts#6897: Both PRs modify verifyExamples.spec.ts exclusion/assertion logic and interact with the ExampleReader/DocReader public export enumeration flow.
recharts/recharts#6979: Both PRs edit the exportsThatNeedExamples exclusion list in omnidoc/verifyExamples.spec.ts to change which exported symbols are required to have example usages.

Suggested reviewers

ckifer

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is severely incomplete. It provides only a brief phrase 'Docs test only' without addressing any required template sections like motivation, testing, or types of changes.	Complete the description by filling out required sections: explain the motivation/problem being solved, describe how the changes were tested, and select the appropriate type of change (bug fix/new feature/breaking change).

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding a check to verify excluded symbols are actually exported, which aligns with the primary modification to the test file.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

Create stacked PR
Commit on current branch

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch animationstatus

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 and usage tips.}

codecov · 2026-06-20T07:59:15Z

Bundle Report

Bundle size has no change ✅

chromatic-com · 2026-06-20T08:03:31Z

Tip

All tests passed and all changes approved!

🟢 UI Tests: 198 tests unchanged
🟢 UI Review: 198 stories published -- no changes
Storybook Publish: 198 stories published

codecov · 2026-06-20T08:03:45Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.41%. Comparing base (df650b4) to head (71c1509).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7476   +/-   ##
=======================================
  Coverage   88.41%   88.41%           
=======================================
  Files         602      602           
  Lines       13906    13906           
  Branches     3513     3513           
=======================================
  Hits        12295    12295           
  Misses       1428     1428           
  Partials      183      183

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

github-actions · 2026-06-20T08:07:59Z

Staging Deployment Details

These deployments will remain available for 30 days.

Fix verifyExamples.spec.ts to check if the excluded symbol is actuall…

71c1509

…y exported at all

PavelVanecek merged commit c332b29 into main Jun 20, 2026
65 checks passed

PavelVanecek deleted the animationstatus branch June 20, 2026 08:25

This was referenced Jun 21, 2026

Simplify and export some of the new animation props #7481

Merged

Add new example where chart animates by scroll #7484

Merged

coderabbitai Bot mentioned this pull request Jul 3, 2026

CartesianGrid theme #7525

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Fix verifyExamples.spec.ts to check if the excluded symbol is actually exported at all#7476

Fix verifyExamples.spec.ts to check if the excluded symbol is actually exported at all#7476
PavelVanecek merged 1 commit into
mainfrom
animationstatus

PavelVanecek commented Jun 20, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jun 20, 2026 •

edited

Loading

❌ Failed checks (1 warning)

Uh oh!

codecov Bot commented Jun 20, 2026

Uh oh!

chromatic-com Bot commented Jun 20, 2026 •

edited

Loading

All tests passed and all changes approved!

Uh oh!

codecov Bot commented Jun 20, 2026

Uh oh!

github-actions Bot commented Jun 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Uh oh!

Conversation

PavelVanecek commented Jun 20, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jun 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

❌ Failed checks (1 warning)

Uh oh!

codecov Bot commented Jun 20, 2026

Bundle Report

Uh oh!

chromatic-com Bot commented Jun 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

All tests passed and all changes approved!

Uh oh!

codecov Bot commented Jun 20, 2026

Codecov Report

Uh oh!

github-actions Bot commented Jun 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

PavelVanecek commented Jun 20, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 20, 2026 •

edited

Loading

chromatic-com Bot commented Jun 20, 2026 •

edited

Loading