fix: tolerate optional OKF index metadata#376
Merged
Colin Francis (colifran) merged 3 commits intoJul 17, 2026
Merged
Conversation
Treat non-string or blank optional title and description metadata as unavailable when rendering indexes, falling back to the filename and omitting the description.
Verify index rendering falls back when optional OKF title and description values cannot be displayed as non-empty strings.
WangWenJie (Eijnewgnaw)
marked this pull request as ready for review
July 17, 2026 06:32
| if (title !== undefined && typeof title !== "string") { | ||
| throw new Error(`${filePath} YAML title must be a string.`); | ||
| } | ||
| const usableDescription = usableString(description); |
Contributor
There was a problem hiding this comment.
nice - i like this. makes sense to not fail here.
Colin Francis (colifran)
approved these changes
Jul 17, 2026
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
2 participants
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
titleanddescriptionvalues while generating directory indexesWhy
OKF v0.1 requires a parseable frontmatter block and non-empty
type; optional display metadata should not prevent a consumer from indexing the rest of a bundle. Index generation now uses only optional values that can be rendered safely.Validation
pnpm exec prettier --check src/agent/index-middleware.ts test/index-middleware.test.tspnpm exec vitest run test/index-middleware.test.tspnpm run typecheckRelated to #84.