-
Notifications
You must be signed in to change notification settings - Fork 0
Add comprehensive formula and rules syntax documentation #28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
|
@copilot 我不需要中文文档,我不想维护两套文档 |
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
|
@copilot 我的意思是删除中文文档,我不需要 |
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request adds comprehensive documentation for formula and validation rule syntax used in the ObjectQL project. The documentation provides English-language guides for defining calculated fields and business rules.
Changes:
- Added complete formulas and rules syntax guide with 50+ examples covering formula syntax, validation rules, permission rules, operators, and best practices
- Added condensed quick reference guide for rapid lookup
- Updated VitePress navigation to include new guides in "Data & Logic Layers" section
- Enhanced README.md with formula field example and link to syntax guide
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/guide/formulas-and-rules.md | Complete 690-line guide covering formula expressions, validation types, permission rules, operators, and best practices with extensive examples |
| docs/guide/formulas-and-rules-quick-ref.md | 270-line condensed syntax reference for quick lookup of common patterns and operators |
| docs/.vitepress/config.mts | Added navigation menu entries for new guides under "Data & Logic Layers" section with proper indentation |
| README.md | Added formula field example demonstrating calculated fields and updated feature list to include formulas, with link to new syntax guide |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
User requested documentation of the formula and validation rule syntax currently used in the ObjectQL project.
Changes
Documentation added:
docs/guide/formulas-and-rules.md(16KB) - Complete English guide covering formula syntax, validation rules, permission rules, operators, and 50+ examplesdocs/guide/formulas-and-rules-quick-ref.md(5KB) - Condensed syntax referenceUpdates:
README.md- Added formula field example and link to syntax guideCoverage
Formula syntax:
$today,$now,$current_userValidation rules:
Operators: Comparison (
=,!=,>,>=,<,<=), set membership (in,not_in,contains), logical (all_of,any_of,none_of), special (not_empty,is_null)All examples verified against actual codebase patterns in
/packages/starters/and/packages/foundation/.Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.