Json utils

[peter-jerry-ye]

Allow easy access to nested item without pattern matching around

[coderabbitai]

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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 84.68%. Comparing base (dd69a26) to head (4bbe287).
Report is 30 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #302      +/-   ##
==========================================
+ Coverage   84.64%   84.68%   +0.03%     
==========================================
  Files          65       66       +1     
  Lines        2710     2743      +33     
==========================================
+ Hits         2294     2323      +29     
- Misses        416      420       +4     

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

[bobzhang]

shall we make sure json/json5 share the types so that we need a package like
jsontypes

[hackwaly]

shall we make sure json/json5 share the types so that we need a package like jsontypes

Currently json5 has no types, it uses types in json directly.

[hackwaly]

I agree to remove functions like item_as_null(i: Int) and keep only as_vec(i: Int), so users can use json.as_vec().unwrap().get(). This way we won't get 3x6 pub functions

[peter-jerry-ye]

I don't see the problem with more helper functions.

[hackwaly]

I don't see the problem with more helper functions.

Ok, just my opinion.

[bobzhang]

@peter-jerry-ye I am okay with adding more utils, but the name is not very intuitive: item_as_number, value_as_number is hard to figure out the meaning without looking into implementations. Can we split it into two commits so that APIs without controversials can get in first?

We support optional chaining so that the API composition is not that bad, e.g, self.as_array().?item(3).as_obj().?(key)