Skip to content
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

feat: Add JSON serialization capabilities #49

Merged
merged 2 commits into from
Jun 25, 2024

Conversation

FrogTheFrog
Copy link
Collaborator

Description

Added JSON serialization capabilities for custom types using the NLOHMAN JSON library.
The implementation details (library) are not exposed by design! As a side effect, people will have to
declare which types they want to use.

The main purpose of JSON is for logging mostly and in one case it will be used for persistence (future PR).

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update (updates to dependencies)
  • Documentation update (changes to documentation)
  • Repository update (changes to repository files, e.g. .github/...)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

  • I want maintainers to keep my branch updated

Copy link

codecov bot commented Jun 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.37%. Comparing base (dbceacf) to head (bab53d5).

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #49      +/-   ##
==========================================
+ Coverage   91.77%   92.37%   +0.59%     
==========================================
  Files          19       26       +7     
  Lines        1033     1101      +68     
  Branches      571      591      +20     
==========================================
+ Hits          948     1017      +69     
  Misses         46       46              
+ Partials       39       38       -1     
Flag Coverage Δ
Linux 96.24% <97.72%> (+2.83%) ⬆️
Windows 92.31% <100.00%> (+0.54%) ⬆️
macOS 66.89% <66.66%> (+8.27%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...ommon/include/displaydevice/detail/jsonconverter.h 100.00% <100.00%> (ø)
...clude/displaydevice/detail/jsonserializerdetails.h 100.00% <100.00%> (ø)
src/common/json.cpp 100.00% <100.00%> (ø)
src/common/jsonserializer.cpp 100.00% <100.00%> (ø)
src/common/logging.cpp 98.66% <100.00%> (+2.66%) ⬆️
src/windows/json.cpp 100.00% <100.00%> (ø)
src/windows/jsonserializer.cpp 100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

cmake/Boost_DD.cmake Outdated Show resolved Hide resolved
tests/CMakeLists.txt Outdated Show resolved Hide resolved
@ReenigneArcher ReenigneArcher merged commit 4e8fd6d into LizardByte:master Jun 25, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants