Conversation
…llup plugin dependency
…s in contributing.md
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
View your CI Pipeline Execution ↗ for commit 3261bc6
☁️ Nx Cloud last updated this comment at |
There was a problem hiding this comment.
Pull request overview
This PR introduces a comprehensive documentation site with auto-generated API reference documentation, transforms the build system to produce self-contained zero-dependency library bundles, adds a new lib-json-utils library to replace external dependencies (jsonschema and to-json-schema), and consolidates 13 individual library CI workflows into unified workflows.
Changes:
- Added docs-site with API reference components, navigation, and content utilities
- Enhanced build system to bundle workspace dependencies as self-contained packages
- Created
lib-json-utilswith JSON Schema validation and generation (100% test coverage) - Migrated from
jsonschemaandto-json-schemato@hyperfrontend/json-utils - Consolidated CI workflows and added sequential execution with
parallel=1 - Updated all library READMEs with docs-site links and removed bundlephobia badges
- Updated dependencies (Nx 22.4.5, GitHub Actions, lefthook, minimatch, etc.)
Reviewed changes
Copilot reviewed 190 out of 192 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
tsconfig.base.json |
Added path mapping for @hyperfrontend/json-utils |
tools/package/src/executors/build/lib/types.ts |
Added bundleWorkspaceDeps configuration to ESM/CJS configs |
tools/package/src/executors/build/lib/rollup-plugins.ts |
Enhanced plugins to support workspace dependency bundling |
tools/package/src/executors/build/lib/package-json.ts |
Added logic to filter workspace dependencies from published package.json |
tools/package/src/executors/build/lib/externals.ts |
Refactored external dependency handling for bundling mode |
tools/package/src/executors/build/lib/config-esm.ts |
Updated ESM config to pass bundling parameters |
tools/package/src/executors/build/lib/config-cjs.ts |
Updated CJS config to pass bundling parameters |
tools/package/src/executors/build/lib/assets.ts |
Changed from async to sync glob operations |
tools/package/src/executors/build/executor.ts |
Updated asset copying to synchronous |
libs/utils/json/* |
New library with validation, generation, types, and comprehensive tests |
libs/nexus/src/schema/validate/* |
Migrated from jsonschema to @hyperfrontend/json-utils |
libs/network-protocol/src/lib/data/* |
Migrated from jsonschema/to-json-schema to @hyperfrontend/json-utils |
libs/*/project.json |
Added bundleWorkspaceDeps: true to ESM/CJS configurations |
libs/*/README.md |
Updated documentation links and removed bundlephobia badges |
apps/docs-site/src/* |
New documentation site components and utilities |
.github/workflows/* |
Consolidated library/plugin workflows, updated action versions |
package.json |
Removed external dependencies, updated devDependencies |
nx.json |
Added parallel: 1 and removed rollup plugin |
jest.preset.cjs |
Fixed regex escaping in testPathIgnorePatterns |
Files not reviewed (1)
- apps/docs-site/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Description
This PR introduces the comprehensive documentation site (
docs-site) with auto-generated API reference documentation for all libraries, alongside significant build improvements to bundle libraries as self-contained zero-dependency packages.Related Issue
Fixes #63
Type of Change
✨ Feature | 📝 Docs | ♻️ Refactor | 🔧 Build/Config
Changes Made
Documentation Site (
docs-site)generate-docs.tsscript for comprehensive API doc generationvalidate-links.tsscript for link validationBuild System Improvements
lib-nexus,lib-network-protocol,lib-cryptography,lib-logginglib-state-machine,lib-list-utils,lib-random-generator-utils,lib-ui-utilslib-data-utils,lib-json-utils,lib-immutable-api-utils,lib-function-utils,lib-time-utils,lib-string-utilstools/packageexecutor with optional bundling supportNew Library
lib-json-utilsto replace external dependencies (jsonschema,to-json-schema)lib-json-utilsCI/CD Simplification
ci-libraries.ymlandci-plugins.ymlDocumentation Updates
Dependency Updates
@swcdependencieseslint-config-nextdependencyTesting
lib-json-utilswith complete coverageScreenshots/Videos
N/A - Documentation site preview available via Vercel deployment
Checklist
npm run commitfor conventional commit messagesAdditional Notes
Build Impact: Libraries now produce self-contained bundles, eliminating the need for consumers to install peer dependencies.
Breaking Changes: None - all changes are backward compatible.
Performance:
lib-json-utilsregex performance issues were fixed.Files Changed: 192 files with approximately 14,648 insertions and 13,986 deletions across the codebase.
📝 CLA Requirement
By submitting this pull request, you acknowledge that:
For more information, see our Contributing Guide.
Thank you for contributing to hyperfrontend! 🚀