docs(validator): say why fillDefaults drops the boolean arm - #68
Open
David Chicaiza (david0723) wants to merge 1 commit into
Open
docs(validator): say why fillDefaults drops the boolean arm#68David Chicaiza (david0723) wants to merge 1 commit into
David Chicaiza (david0723) wants to merge 1 commit into
Conversation
BlueprintValidator's useDefaults is `boolean | 'always' | 'requiredOnly'` and fillDefaults is only the two strings. Read cold, the missing arm looks like an oversight rather than a decision. It is a decision: `true` is a legacy alias for 'always', not a third behaviour, and the platform's public validation parameter already exposes only the two named modes. Comment only, no behaviour change. MAIA-1286
Copilot started reviewing on behalf of
David Chicaiza (david0723)
September 2, 2026 08:27
View session
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
Comment-only JSDoc clarification that aligns with existing behavior and improves the public API contract without introducing risk.
Pull request overview
Updates the public JSDoc for FormanValidationOptions.fillDefaults to explain why the BlueprintValidator boolean (useDefaults: true) mode is intentionally not mirrored in this library’s option surface, clarifying the contract without changing behavior.
Changes:
- Expand the
fillDefaultsJSDoc to document the deliberate omission of BlueprintValidator’sbooleanarm and the rationale behind it.
File summaries
| File | Description |
|---|---|
src/types.ts |
Adds explanatory JSDoc clarifying why fillDefaults only supports `'requiredOnly' |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
[Has Ai Code]
Jira: https://make.atlassian.net/browse/MAIA-1286
One comment line, no behaviour change. Closes the loose end from the #65 addendum.
fillDefaultsis'requiredOnly' | 'always'while BlueprintValidator'suseDefaultsisboolean | 'always' | 'requiredOnly'. The JSDoc claimed to mirror those modes without saying anything about the missing arm, so read cold it looks like an oversight. It isnt:trueis a legacy alias for'always'rather than a third behaviour, and the platform's public validation parameter already exposes only the two named modes, so there is nothing behind the boolean for a new library to inherit.That reasoning was established in review on #65 and then never made it into the code. This puts it where the next person greps.
Notes