feat(page-compiler): move features internally and add transform options #38
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mark getBreadcrumbs, getNavTree, titleList, getTitle, and getTitleFromStaticFile as deprecated. These will be moved to @kamado-io/page-compiler in the next major version.
Copy breadcrumbs, nav, title, and title-list modules to page-compiler/src/features/ and import directly instead of from kamado/features. This prepares for v2.0.0 where kamado/features will be removed.
Add MILESTONE.md to track breaking changes for v2.0.0 including the removal of kamado/features module. Update CHANGELOG.md with deprecation notices for all affected functions.
…ion features Add synchronous transformItem option to getBreadcrumbs for customizing breadcrumb items. Add transformNode option to getNavTree for customizing or filtering navigation nodes. Change getBreadcrumbs from async to sync function. Remove page property from BreadcrumbItem (async access no longer needed). Update PageCompilerOptions to expose transformBreadcrumbItem and transformNavNode. Add comprehensive test coverage for both features.
…guide Add documentation for transformBreadcrumbItem and transformNavNode options. Update MILESTONE.md to reflect completed feature migration tasks. Clarify that features are internal to @kamado-io/page-compiler and accessed via transform options.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
kamado/featuresto@kamado-io/page-compiler/featurestransformBreadcrumbItem,transformNavNode) for customizing outputgetBreadcrumbsfrom async to sync functionkamado/featuresfor removal in v2.0.0Changes
Feature Migration
getBreadcrumbs,getNavTree,getTitleList,getTitlemoved to@kamado-io/page-compiler/featureskamado/featuresnow re-exports from@kamado-io/page-compilerwith deprecation warningsNew Transform Options
transformBreadcrumbItem: Synchronous function to customize breadcrumb itemspageproperty fromBreadcrumbItem(no longer needed for sync operation)transformNavNode: Synchronous function to customize or filter navigation nodesnull/undefinedto remove nodes from treeBreaking Changes (scheduled for v2.0.0)
kamado/featureswill be removed in v2.0.0@kamado-io/page-compiler/featuresinsteadTest Plan
🤖 Generated with Claude Code