Skip to content

For website#30

Merged
baxyz merged 4 commits intomainfrom
for-website
Apr 7, 2026
Merged

For website#30
baxyz merged 4 commits intomainfrom
for-website

Conversation

@baxyz
Copy link
Copy Markdown
Contributor

@baxyz baxyz commented Apr 7, 2026

Description

Please include a summary of what this PR does and why it's needed.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactoring
  • Test improvement

Related Issues

Closes #(issue number)

How Has This Been Tested?

Describe the tests you ran and how to reproduce them:

  • Test A
  • Test B

Checklist

  • My code follows the code style of this project
  • I have updated the documentation accordingly
  • I have added tests for my changes
  • All new and existing tests passed locally
  • My commits follow the conventional commit format

Screenshots (if applicable)

Add screenshots for UI changes.

Additional Context

Add any other context about the PR here.

baxyz added 2 commits April 7, 2026 21:26
- move build project step after version bump
docs(observable): 📝 add @SInCE annotations to observable helpers
docs(promise): 📝 add @SInCE annotations to promise helpers
docs(string): 📝 add @SInCE annotations to string helpers
docs(type): 📝 add @SInCE annotations to type helpers
docs(url): 📝 add @SInCE annotations to URL helpers
docs(version): 📝 add @SInCE annotations to version helpers
build: 📦 remove unused build steps and add website metadata generation
Copilot AI review requested due to automatic review settings April 7, 2026 21:52
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the build pipeline to generate a new “website metadata” bundle per category (API docs, examples, and dependency licenses) under build/<category>/meta/, and annotates many helpers with @since tags so the generated metadata can expose version availability.

Changes:

  • Replace per-category api.json / examples.json / licenses.json generation with a single meta/-based website metadata generator.
  • Add @since tags across many helpers for improved website/API documentation.
  • Adjust release workflow ordering so the build runs after the version bump.

Reviewed changes

Copilot reviewed 64 out of 64 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
scripts/build/index.ts Switch build pipeline to call buildWebsiteMetadata instead of separate api/examples/licenses generators.
scripts/build/build-website-metadata.ts Add a new generator that emits meta/api.json, meta/examples.json, and meta/licenses.json per category.
helpers/version/stripV.ts Add @since tag.
helpers/version/satisfiesRange.ts Add @since tag.
helpers/version/parse.ts Add @since tags on interface/function docs.
helpers/version/increment.ts Add @since tag.
helpers/version/compare.ts Add @since tag.
helpers/url/withTrailingSlash.ts Add @since tags across overload docblocks.
helpers/url/withoutTrailingSlash.ts Add @since tags across overload docblocks.
helpers/url/withoutLeadingSlash.ts Add @since tags across overload docblocks.
helpers/url/withLeadingSlash.ts Add @since tags across overload docblocks.
helpers/url/relativeURLToAbsolute.ts Add missing JSDoc (incl. @since).
helpers/url/onlyPath.ts Add @since tags across overload docblocks.
helpers/url/extractPureURI.ts Add @since tag.
helpers/url/cleanPath.ts Add @since tag.
helpers/type/typeChecks.ts Add @since tags for exported type/functions.
helpers/type/isSpecialObject.ts Add @since tag.
helpers/type/isEmpty.ts Add @since tag.
helpers/string/slugify.ts Add @since tag.
helpers/string/labelize.ts Add @since tag.
helpers/string/kebabCase.ts Add @since tag.
helpers/string/errorToReadableMessage.ts Add @since tags across overload docblocks.
helpers/string/capitalize.ts Add @since tag.
helpers/string/camelCase.ts Add @since tag.
helpers/promise/truthyPromiseOrThrow.ts Add @since (currently placed in a license block comment).
helpers/promise/retry.ts Add @since tag.
helpers/promise/meaningPromiseOrThrow.ts Add @since (currently placed in a license block comment).
helpers/promise/falsyPromiseOrThrow.ts Add @since (currently placed in a license block comment).
helpers/promise/delay.ts Add @since tag.
helpers/promise/consoleLogPromise.ts Add @since (currently placed in a license block comment).
helpers/observable/combineLatest.ts Add @since tag.
helpers/observable/combine.ts Add @since tag.
helpers/object/set.ts Add @since tag.
helpers/object/removeUndefinedNull.ts Add @since tags across overload docblocks.
helpers/object/quickCompare.ts Add @since tag.
helpers/object/get.ts Add @since tag.
helpers/object/deepMerge.ts Add @since tag.
helpers/object/deepCompare.ts Add @since tags for exported interface/function.
helpers/object/deepClone.ts Add @since tag.
helpers/number/roundTo.ts Add @since tag.
helpers/number/random.ts Add @since tags.
helpers/number/clamp.ts Add @since tag.
helpers/function/throttle.ts Add @since tag.
helpers/function/returnOrThrowError.ts Add @since tag.
helpers/function/memoize.ts Add @since tag.
helpers/function/isDefinedAndNotNull.ts Add @since tag.
helpers/function/debounce.ts Add @since tag.
helpers/date/timestamp.ts Add @since tags.
helpers/date/safeDate.ts Add @since tags.
helpers/date/is.ts Add @since tag.
helpers/date/format.ts Add @since tags.
helpers/date/difference.ts Add @since tag.
helpers/date/compare.ts Add @since tags for exported interface/function.
helpers/array/unique.ts Add @since tag.
helpers/array/sort.ts Add @since tags for exported types/constants/functions.
helpers/array/quickCompare.ts Add @since tag.
helpers/array/oneInCommon.ts Add @since tag.
helpers/array/intersection.ts Add @since tag.
helpers/array/difference.ts Add @since tag.
helpers/array/deepCompare.ts Add @since tag.
helpers/array/chunk.ts Add @since tag.
helpers/array/arrayEquals.ts Add @since tag.
.template/category/package.json Move exported JSON artifacts under ./meta/* and include meta/ in published files.
.github/workflows/release.yml Run build after version bump in release workflow.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 7, 2026

✅ PR Validation Passed

All checks passed and coverage target reached!


📋 Pipeline Status

Job Status
🔢 Version passing
🏗️ Build passing
🧪 Tests passing
📝 Lint passing
📘 TypeCheck passing
🔐 Security Audit passing
🧾 Conventional Commits passing
🔗 Coherency passing

📊 Code Coverage

Overall Coverage: 100.0% — Target reached! 🎯

Metric Progress Coverage
Lines ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100%
Branches ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100%
Functions ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100%
Statements ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓ 100%

🧬 Mutation Testing

🟢 Mutation Score: 91.13% — excellent

Metric Progress Score
🟢 Mutation Score ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░ 91.13%

🧬 Mutation testing is informational only and does not block the PR


ℹ️ About this report
  • 🎯 Coverage Target: 100% for all metrics
  • 🧬 Mutation Testing: powered by Stryker (non-blocking)
  • 🔄 This comment updates automatically with each push
  • 📈 Coverage is measured using Vitest + v8

🤖 Generated by @helpers4 CI • 2026-04-07

@baxyz baxyz merged commit 17de6c7 into main Apr 7, 2026
12 checks passed
@baxyz baxyz deleted the for-website branch April 7, 2026 22:19
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