feat: add @@meta and @meta attributes

[ymc9]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce new @meta and @@meta attributes for attaching arbitrary metadata to schema fields and models/types. The metadata extraction logic is refactored to use a recursive helper for parsing attribute argument values, supporting complex structures. Integration tests are added to verify correct metadata handling and extraction.

Changes

File(s)	Change Summary
packages/schema/src/res/stdlib.zmodel	Added @meta(name, value) and @@meta(name, value) attributes for attaching metadata to fields/models.
packages/sdk/src/model-meta-generator.ts	Refactored attribute value extraction logic; added exprToValue and exprToObject helpers for recursive parsing.
tests/integration/tests/misc/meta-annotation.test.ts	Added integration tests to verify @meta and @@meta attribute extraction and handling.

Sequence Diagram(s)

sequenceDiagram
    participant Schema as Schema Definition
    participant Parser as Schema Parser
    participant MetaGen as Model Meta Generator
    participant Test as Integration Test

    Schema->>Parser: Defines model/type with @meta and @@meta attributes
    Parser->>MetaGen: Passes parsed schema with attribute expressions
    MetaGen->>MetaGen: Recursively parses attribute values (exprToValue)
    MetaGen-->>Parser: Returns metadata as JS objects
    Parser-->>Test: Supplies parsed metadata
    Test->>Test: Asserts metadata structure and values

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 93617a4 and 2e2b7c3.

📒 Files selected for processing (3)

• packages/schema/src/res/stdlib.zmodel (1 hunks)
• packages/sdk/src/model-meta-generator.ts (4 hunks)
• tests/integration/tests/misc/meta-annotation.test.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

tests/integration/tests/misc/meta-annotation.test.ts (1)

packages/testtools/src/schema.ts (1)

• loadSchema (173-379)

🔇 Additional comments (5)

packages/schema/src/res/stdlib.zmodel (1)

753-761: LGTM! Well-designed metadata attributes.

The new @@meta and @meta attributes are properly defined with appropriate parameter types. Using Any for the value parameter provides the flexibility needed for arbitrary metadata while maintaining type safety for the name parameter.

tests/integration/tests/misc/meta-annotation.test.ts (1)

1-59: Excellent test coverage for the new metadata functionality.

The test comprehensively validates:

• Model-level @@meta annotations with both simple and complex values
• Field-level @meta annotations with various data types
• Multiple annotations on the same target
• Nested object structures in metadata values

The use of expect.arrayContaining provides flexibility while ensuring all expected metadata is present.

packages/sdk/src/model-meta-generator.ts (3)

6-6: Good addition of necessary imports for enhanced expression parsing.

The new imports support the refactored metadata extraction logic:

• Expression, isObjectExpr, ObjectExpr for handling object expressions
• match from ts-pattern for clean pattern matching implementation

Also applies to: 13-13, 17-17, 26-26

---

369-371: Clean refactoring of argument value extraction.

The replacement of inline parsing logic with the exprToValue helper improves code organization and reusability. The simplified approach maintains the same functionality while being more maintainable.

---

599-620: Well-implemented recursive expression parsing with robust error handling.

The exprToValue function uses pattern matching to handle different expression types elegantly:

• Supports all common literal types (string, boolean, number)
• Handles arrays and objects recursively
• Provides appropriate fallback for unsupported expressions

The number parsing logic correctly tries parseInt first, then parseFloat, with proper NaN handling. The exprToObject helper cleanly processes object fields using Object.fromEntries.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.