docs(data-modeling): document build-time expression validation guardrails (#1928)#3201
Merged
Merged
Conversation
…ails The formula/flow guardrail series (#1928) added build-time checks that were never documented. Add a "Build-time validation" section to the formulas guide covering: qualify field references (bare-ref → null), field existence, unknown functions, and the text/boolean-in-arithmetic type-soundness warning — with their severities (error vs advisory warning), the note that integer-literal arithmetic (amount / 100) works at runtime, and how flow conditions differ (bare fields, did-you-mean typo warnings). Add a companion note + cross-link to the validation guide. Docs-only; verified against the shipped behavior in @objectstack/formula and @objectstack/lint. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Hnji7EEYR2mGt6pY53a8Bm
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
documentation
os-zhuang
marked this pull request as ready for review
July 18, 2026 09:16
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.
What
The formula/flow guardrail series (#1928, now closed) added build-time expression checks that were never documented. The
docs-driftbot flagged the formula/validation guides on both #3178 and #3190 for exactly this reason. This adds the missing docs.Changes
formulas.mdx— new Build-time validation section:amount→record.amount; a bare ref silently evaluates tonull) — errorrecord.<field>→ did-you-mean) — errorrecord.amount / 100, no100.0workaround needed — the engine handlesdouble × int); equality against any type is safe.registerFlow).validation.mdx— a short companion note + cross-link to the new section.Accuracy
Every claim is verified against the shipped behavior in
@objectstack/formula/@objectstack/lint, including the correct severities (tier-1/2 fail the build; tier-3/4 are advisory, fatal only under--strict). Deliberately does not claim an agentvalidate_expressiontool exists (it doesn't) — onlyobjectstack build+registerFlow.node scripts/check-doc-authoring.mjs→ ✓ 200 files clean.#build-time-validationand cross-links verified.Docs-only; no code change.
Refs: #1928 (closed), #3178, #3190.
🤖 Generated with Claude Code
https://claude.ai/code/session_01Hnji7EEYR2mGt6pY53a8Bm
Generated by Claude Code