Replace Settings with JsonSerializerOptions

[CoryCharlton]

Description

• Create new JsonSerializerOptions class that mirrors .NET Full.
• Update Settings to delegate properties to JsonSerializerOptions.Default
• Add DeserializeObject overloads that accept JsonSerializerOptions
• Mark Settings as obsolete

Motivation and Context

This is an opinionated change and entirely optional. My strong belief is that code should be self documenting and the existing Settings class, without the namespace context, is ambiguous.

By renaming to JsonSerializerOptions the intent is clear and users (like me) that don't read the documentation are more likely to discover the class.

• Support deserializing/serializing camelCase JSON fields to PascalCase properties Home#1382

• Rename Settings to JsonSettings #312

How Has This Been Tested?

• Unit tests
• Live device

Screenshots

Types of changes

• Improvement (non-breaking change that improves a feature, code or algorithm)
• Bug fix (non-breaking change which fixes an issue with code or algorithm)
• New feature (non-breaking change which adds functionality to code)
• Breaking change (fix or feature that would cause existing functionality to change)
• Config and build (change in the configuration and build system, has no impact on code or features)
• Dependencies (update dependencies and changes associated, has no impact on code or features)
• Unit Tests (add new Unit Test(s) or improved existing one(s), has no impact on code or features)
• Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

• My code follows the code style of this project (only if there are changes in source code).
• My changes require an update to the documentation (there are changes that require the docs website to be updated).
• I have updated the documentation accordingly (the changes require an update on the docs in this repo).
• I have read the CONTRIBUTING document.
• I have tested everything locally and all new and existing tests passed (only if there are changes in source code).
• I have added new tests to cover my changes.

[coderabbitai]

Important

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (16)

• nanoFramework.Json.Test/Configuration/SettingsTests.cs is excluded by none and included by none
• nanoFramework.Json.Test/JsonSerializerOptionsTests.cs is excluded by none and included by none
• nanoFramework.Json.Test/JsonSettingsTests.cs is excluded by none and included by none
• nanoFramework.Json.Test/Mocks/MockMemberResolver.cs is excluded by none and included by none
• nanoFramework.Json.Test/Resolvers/MemberResolverCaseInsensitiveExceptionTests.cs is excluded by none and included by none
• nanoFramework.Json.Test/Resolvers/MemberResolverCaseInsensitiveTests.cs is excluded by none and included by none
• nanoFramework.Json.Test/Resolvers/MemberResolverCaseSensitiveExceptionTests.cs is excluded by none and included by none
• nanoFramework.Json.Test/Resolvers/MemberResolverCaseSensitiveTests.cs is excluded by none and included by none
• nanoFramework.Json.Test/nanoFramework.Json.Test.nfproj is excluded by none and included by none
• nanoFramework.Json/Configuration/Settings.cs is excluded by none and included by none
• nanoFramework.Json/JsonConvert.cs is excluded by none and included by none
• nanoFramework.Json/JsonSerializerDefaults.cs is excluded by none and included by none
• nanoFramework.Json/JsonSerializerOptions.cs is excluded by none and included by none
• nanoFramework.Json/Resolvers/IMemberResolver.cs is excluded by none and included by none
• nanoFramework.Json/Resolvers/MemberResolver.cs is excluded by none and included by none
• nanoFramework.Json/nanoFramework.Json.nfproj is excluded by none and included by none

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.
  • @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.

[josesimoes]

LGTM!

[sonarcloud]

Quality Gate passed

Issues
191 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
1.6% Duplication on New Code

See analysis details on SonarCloud