feat: support JSON schema

[njzjz]

Summary by CodeRabbit

• New Features

  • Introduced the ability to generate JSON schemas from arguments, enabling integration with JSON editors like Visual Studio Code.

• Documentation

  • Added a new file explaining how to generate JSON schemas and use them in JSON editors.

• Tests

  • Added test cases to validate JSON schema generation and type conversion.

• Dependencies

  • Added jsonschema as an optional dependency for testing.

[coderabbitai]

Walkthrough

Walkthrough

The update introduces functionality to generate JSON schemas from Argument instances, facilitating integration with JSON editors like Visual Studio Code. It includes functions to convert Argument objects to JSON schema representations, handling various data types and nested structures. Additionally, tests and documentation have been added to validate and explain this new feature.

Changes

File Path	Change Summary
README.md	Added a summary of the new JSON schema generation feature.
dargs/json_schema.py	Introduced functions to generate JSON schemas from Argument instances, including type conversion.
docs/json_schema.md	Added documentation on generating JSON schemas from Argument instances using the new functions.
pyproject.toml	Added jsonschema to the list of optional dependencies for testing.
tests/dpmdargs.py	Added a function gen_args() to generate test arguments.
tests/test_json_schema.py	Introduced tests for JSON schema generation and type conversion functions.
dargs/dargs.py	Updated _check_strict method to allow $schema in any dictionary for compatibility with JSON schema.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant JSONSchema
    participant Argument
    participant VSCode
    
    User->>JSONSchema: Call generate_json_schema(argument)
    JSONSchema->>Argument: Convert Argument to JSON Schema
    Argument-->>JSONSchema: Return JSON Schema
    JSONSchema-->>User: Return JSON Schema
    User->>VSCode: Use JSON Schema for validation
    VSCode-->>User: Provide validation feedback

Loading

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 88a2a3c and 7697058.

Files selected for processing (2)

• dargs/json_schema.py (1 hunks)
• tests/dpmdargs.py (2 hunks)

Files skipped from review as they are similar to previous changes (2)

• dargs/json_schema.py
• tests/dpmdargs.py

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 generate unit testing code for this file.
  • @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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @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.

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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.76%. Comparing base (fc8cac4) to head (7697058).
Report is 13 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #63      +/-   ##
==========================================
+ Coverage   82.71%   83.76%   +1.05%     
==========================================
  Files           4        5       +1     
  Lines         648      690      +42     
==========================================
+ Hits          536      578      +42     
  Misses        112      112              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 2