feat(docgen): deep-merge user-supplied JSON-LD frame with built-in default#366
Merged
feat(docgen): deep-merge user-supplied JSON-LD frame with built-in default#366
Conversation
…fault Closes #313 A user-supplied frame is now merged on top of the built-in default frame, so consumers only need to specify their additions (e.g. extra @context entries) instead of duplicating all of docgen's defaults. Plain objects merge key-by-key; arrays and primitives in the user frame replace the default.
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
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.
Closes #313.
Summary
@contextentries) instead of duplicating all of docgen’s defaults.frame(), sogenerateDocumentation()and the CLI’s-foption both treat the user frame as optional.A consumer’s frame can now be as small as:
{ "@context": { "nde": "https://def.nde.nl#", "nde:futureChange": {}, "nde:version": {} } }Test plan
npx nx run @lde/docgen:test– existing integration test now exercises the no-frame default path; newframe.test.tscovers default-only, partial merge (preserves default coercions while adding user keys), and override (user coercion replaces default)npx nx run @lde/docgen:typecheckand:buildpassframe.ts