Skip to content

chore: stop versioning generators#932

Open
avivkeller wants to merge 1 commit into
mainfrom
stop-ver-generators
Open

chore: stop versioning generators#932
avivkeller wants to merge 1 commit into
mainfrom
stop-ver-generators

Conversation

@avivkeller

Copy link
Copy Markdown
Member

consumers should refer to the main doc-kit version

@avivkeller
avivkeller requested a review from a team as a code owner July 22, 2026 05:10
Copilot AI review requested due to automatic review settings July 22, 2026 05:10
@cursor

cursor Bot commented Jul 22, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Metadata and documentation cleanup only; no runtime generator behavior or output format changes.

Overview
Removes per-generator version fields so consumers should use the main doc-kit package version instead of individual generator semver strings.

The version property is dropped from GeneratorMetadata in types.d.ts, from every createLazyGenerator({ ... }) definition under src/generators/, and from the generator authoring examples in docs/generators.md. The suite test that required valid semver on each generator is removed along with the semver import in index.test.mjs, and createLazyGenerator tests now assert description instead of version.

Reviewed by Cursor Bugbot for commit d1d5d8f. Bugbot is set up for automated code reviews on this repo. Configure here.

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@vercel

vercel Bot commented Jul 22, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
api-docs-tooling Ready Ready Preview, Comment Jul 22, 2026 5:11am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
nodejs-doc-kit Ignored Ignored Jul 22, 2026 5:11am

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

api-links Generator

Performance

Metric Base Head Diff
Elapsed time 1.53 s 1.14 s -390.00 ms (-25.49%)
User CPU time 2.82 s 2.45 s -370.00 ms (-13.12%)
System CPU time 350.00 ms 260.00 ms -90.00 ms (-25.71%)
Peak resident memory 347.15 MB 361.16 MB +14.01 MB (+4.04%)

legacy-html Generator

Performance

Metric Base Head Diff
Elapsed time 18.06 s 18.47 s +410.00 ms (+2.27%)
User CPU time 59.20 s 60.89 s +1.69 s (+2.85%)
System CPU time 2.71 s 2.62 s -90.00 ms (-3.32%)
Peak resident memory 2.32 GB 2.23 GB -95.87 MB (-4.03%)

legacy-json Generator

Performance

Metric Base Head Diff
Elapsed time 9.04 s 9.45 s +410.00 ms (+4.54%)
User CPU time 27.57 s 29.09 s +1.52 s (+5.51%)
System CPU time 1.93 s 2.06 s +130.00 ms (+6.74%)
Peak resident memory 1.64 GB 1.65 GB +6.42 MB (+0.38%)

llms-txt Generator

Performance

Metric Base Head Diff
Elapsed time 8.21 s 7.99 s -220.00 ms (-2.68%)
User CPU time 24.97 s 25.07 s +100.00 ms (+0.40%)
System CPU time 1.74 s 1.82 s +80.00 ms (+4.60%)
Peak resident memory 1.58 GB 1.61 GB +31.44 MB (+1.94%)

orama-db Generator

Performance

Metric Base Head Diff
Elapsed time 8.66 s 8.55 s -110.00 ms (-1.27%)
User CPU time 25.41 s 25.62 s +210.00 ms (+0.83%)
System CPU time 1.83 s 1.93 s +100.00 ms (+5.46%)
Peak resident memory 1.64 GB 1.66 GB +26.50 MB (+1.58%)

web Generator

Performance

Metric Base Head Diff
Elapsed time 77.41 s 75.44 s -1.97 s (-2.54%)
User CPU time 166.46 s 161.48 s -4.98 s (-2.99%)
System CPU time 4.75 s 4.62 s -130.00 ms (-2.74%)
Peak resident memory 5.69 GB 5.75 GB +58.70 MB (+1.01%)

@codecov

codecov Bot commented Jul 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.86%. Comparing base (6a217f0) to head (d1d5d8f).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #932      +/-   ##
==========================================
- Coverage   84.89%   84.86%   -0.04%     
==========================================
  Files         193      193              
  Lines       17512    17472      -40     
  Branches     1551     1550       -1     
==========================================
- Hits        14867    14827      -40     
  Misses       2639     2639              
  Partials        6        6              

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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