Add pretty printing for vajson serializer by JuriSchroeder · Pull Request #636 · eclipse-score/baselibs

JuriSchroeder · 2026-09-29T12:39:57Z

No description provided.

…tty-print

+
+    /// \brief Returns the underlying output stream to write scalar values into
+    /// \return The output stream passed on construction.
+    auto Stream() const noexcept -> std::ostream&


github-actions · 2026-09-29T12:55:51Z

Documentation preview for this pull request is available at:
pr-636: https://eclipse-score.github.io/baselibs/pr-636/

Copilot

Copilot review overview

🟡 Changes recommended

The newly added tests use legacy requirement metadata that must be replaced with current component-requirement links.

Review effort: Balanced
Findings: 2

Open (2)

Replace legacy test traceability metadata · New
Replace legacy test traceability metadata · New

What changed in this PR

Adds optional pretty printing to the vaJSON serializer while preserving backend-specific behavior.

Changes:

Propagates a pretty_print option through JsonWriter and serializer backends.
Adds structural whitespace handling for nested JSON containers.
Adds compact and pretty-print serialization tests.

File	Description
`score/json/json_writer.h`	Exposes the formatting option.
`score/json/json_writer.cpp`	Propagates formatting to backends.
`score/json/json_writer_test.cpp`	Updates shared expectations and tests compact output.
`score/json/internal/writer/writer_backend.h`	Extends backend interfaces.
`score/json/internal/writer/vajson/writer/serializers/util/formatting_writer.h`	Implements whitespace and indentation.
`score/json/internal/writer/vajson/writer/serializers/structures/serializer.h`	Uses the formatting writer type.
`score/json/internal/writer/vajson/writer/serializers/structures/key_serializer.h`	Formats object members.
`score/json/internal/writer/vajson/writer/serializers/structures/generic_value_serializer.h`	Formats values and arrays.
`score/json/internal/writer/vajson/writer/serializers/structures/generic_value_serializer_impl.h`	Formats objects.
`score/json/internal/writer/vajson/vajson_serialize.h`	Extends vaJSON serialization APIs.
`score/json/internal/writer/vajson/vajson_serialize.cpp`	Configures formatting per serialization.
`score/json/internal/writer/vajson/vajson_serialize_test.cpp`	Covers pretty and compact output.
`score/json/internal/writer/vajson/vajson_backend.cpp`	Forwards formatting through vaJSON.
`score/json/internal/writer/json_serialize/json_serialize_backend.cpp`	Accepts but ignores formatting configuration.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

mihajlo-k

Nice implementation!
I have a couple of comments that could be addressed in the follow-up, thus non-blocking.

mihajlo-k · 2026-09-29T18:21:55Z

-#if defined(WRITER_VAJSON)
-    static constexpr auto expected = R"([1234,"string",{"key":"value"}])";


here the test coverage for compact formatting is lost. maybe now we can parametrize the tests here to cover both formatting.

mihajlo-k · 2026-09-29T19:04:13Z

-                                    const score::filesystem::AtomicUpdateOwnershipFlags ownership) noexcept
-    : IJsonWriter{}, file_sync_mode_{file_sync_mode}, atomic_ownership_{ownership}
+                                    const score::filesystem::AtomicUpdateOwnershipFlags ownership,
+                                    const bool pretty_print) noexcept


If someone encounters a call like this:
JsonWriter writer{sync_mode, ownership, true};,
it might not be clear to them what true means, and they might need to look into the constructor itself to understand.

To make the API more understandable we could use scoped enum (e.g. PrettyPrint::kDisabled and PrettyPrint::kEnabled or Formatting::kCompact and Formatting::kPrettyPrint).

mihajlo-k · 2026-09-29T20:39:46Z

It is worth noting that there is a slight deviation in formatting between json serializer and vajson serializer with pretty printing. Namely json serializer serializes the empty list/object in a way that it splits opening and closing brackets in two separate lines ([\n ] or {\n }), while vajson serializer with pretty printing writes them in a single line ([] or {}).

4og · 2026-09-30T07:18:16Z

It is worth noting that there is a slight deviation in formatting between json serializer and vajson serializer with pretty printing. Namely json serializer serializes the empty list/object in a way that it splits opening and closing brackets in two separate lines ([\n ] or {\n }), while vajson serializer with pretty printing writes them in a single line ([] or {}).

The [] or {} in a single line make more sense, don't they?

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: JuriSchroeder <84773803+JuriSchroeder@users.noreply.github.com>

…eder/baselibs into vajson-serializer-pretty-print

Copilot

Copilot review overview

🟡 Changes recommended

New tests use obsolete requirement metadata, and the new header violates documented header conventions.

Review effort: Balanced
Findings: 3

Open (3)

Use current requirement metadata for the new test · New
Fix include guard to match the required header path · New
Use @-prefixed Doxygen tags · New

Resolved since last review (2)

Replace legacy test traceability metadata
Replace legacy test traceability metadata

JuriSchroeder and others added 4 commits September 25, 2026 14:32

Merge remote-tracking branch 'origin/main' into vajson-serializer-pre…

9344962

…tty-print

Merge remote-tracking branch 'origin/main' into vajson-serializer-pre…

9ea42bb

…tty-print

Add pretty printing

4c16627

Merge branch 'eclipse-score:main' into vajson-serializer-pretty-print

cd66d99

github-project-automation Bot added this to BAS - Baselibs FT Sep 29, 2026

JuriSchroeder temporarily deployed to workflow-approval September 29, 2026 12:40 — with GitHub Actions Inactive

github-actions Bot added comp-json Related to score/json component c++ C++ code labels Sep 29, 2026

github-advanced-security Bot found potential problems Sep 29, 2026

View reviewed changes

Comment thread score/json/internal/writer/vajson/writer/serializers/util/formatting_writer.h

/// \brief Returns the underlying output stream to write scalar values into

/// \return The output stream passed on construction.

auto Stream() const noexcept -> std::ostream&

4og requested review from mihajlo-k and a balanced review from Copilot September 29, 2026 13:01

Copilot started reviewing on behalf of 4og September 29, 2026 13:02

View session

Copilot AI reviewed Sep 29, 2026

View reviewed changes

Comment thread score/json/internal/writer/vajson/vajson_serialize_test.cpp Outdated

Comment thread score/json/json_writer_test.cpp Outdated

mihajlo-k approved these changes Sep 29, 2026

View reviewed changes

mihajlo-k mentioned this pull request Sep 30, 2026

json writer: remove writer selection and delete the json_serialize writer #644

Closed

anmittag assigned JuriSchroeder Sep 30, 2026

JuriSchroeder and others added 2 commits October 1, 2026 12:43

Use scoped enum for pretty printing

e872214

Update test properties for JSON serialization tests

163d867

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: JuriSchroeder <84773803+JuriSchroeder@users.noreply.github.com>

JuriSchroeder temporarily deployed to workflow-approval October 1, 2026 10:48 — with GitHub Actions Inactive

JuriSchroeder and others added 2 commits October 1, 2026 13:07

Introduce parameterized test for compact coverage

ff91baa

Merge branch 'eclipse-score:main' into vajson-serializer-pretty-print

dfeb029

JuriSchroeder had a problem deploying to workflow-approval October 1, 2026 11:23 — with GitHub Actions Error

Merge branch 'vajson-serializer-pretty-print' of github.com:JuriSchro…

47e4123

…eder/baselibs into vajson-serializer-pretty-print

JuriSchroeder marked this pull request as ready for review October 1, 2026 11:32

JuriSchroeder requested review from 4og, antonkri, arkjedrz, fbaeuerle and pawelrutkaq as code owners October 1, 2026 11:32

JuriSchroeder temporarily deployed to workflow-approval October 1, 2026 11:32 — with GitHub Actions Inactive

github-actions Bot added the bazel Bazel and Starlark build files label Oct 1, 2026

4og requested review from mihajlo-k and a balanced review from Copilot October 1, 2026 13:25

Copilot started reviewing on behalf of 4og October 1, 2026 13:28

View session

Copilot AI reviewed Oct 1, 2026

View reviewed changes

Comment thread score/json/internal/writer/vajson/vajson_serialize_test.cpp

Comment thread score/json/internal/writer/vajson/writer/serializers/util/formatting_writer.h

Comment thread score/json/internal/writer/vajson/writer/serializers/util/formatting_writer.h

mihajlo-k approved these changes Oct 2, 2026

View reviewed changes

4og enabled auto-merge October 2, 2026 07:32

4og approved these changes Oct 2, 2026

View reviewed changes

4og added this pull request to the merge queue Oct 2, 2026

Merged via the queue into eclipse-score:main with commit bcea44c Oct 2, 2026
27 checks passed

github-project-automation Bot moved this from On Hold to Done in BAS - Baselibs FT Oct 2, 2026

		#if defined(WRITER_VAJSON)
		static constexpr auto expected = R"([1234,"string",{"key":"value"}])";

Conversation

JuriSchroeder commented Sep 29, 2026

Uh oh!

github-actions Bot commented Sep 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

mihajlo-k left a comment

Choose a reason for hiding this comment

Uh oh!

mihajlo-k Sep 29, 2026

Choose a reason for hiding this comment

Uh oh!

JuriSchroeder Oct 1, 2026

Choose a reason for hiding this comment

Uh oh!

mihajlo-k Sep 29, 2026

Choose a reason for hiding this comment

Uh oh!

JuriSchroeder Oct 1, 2026

Choose a reason for hiding this comment

Uh oh!

mihajlo-k commented Sep 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

4og commented Sep 30, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This branch was previously deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mihajlo-k commented Sep 29, 2026 •

edited

Loading