Skip to content

fix(core): preserve shared metadata in json-simple - #1187

Open
dxnnystyles wants to merge 1 commit into
nodejs:mainfrom
dxnnystyles:fix/1182-json-simple-immutability
Open

dxnnystyles wants to merge 1 commit into
nodejs:mainfrom
dxnnystyles:fix/1182-json-simple-immutability

Conversation

@dxnnystyles

Copy link
Copy Markdown

Description

json-simple now filters copied entry content, leaving shared metadata unchanged. It returns and writes the filtered copies.

Validation

  • node --run test (Node v24.22.1): 748 tests passed.
  • node --run lint: passed.
  • node --run format:check: passed.
  • node --run build: passed.
  • Changeset status: passed for the @doc-kit/core patch.
  • The regression test reproduces the input mutation on the original implementation and passes with this change.

Related Issues

Fixes #1182

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run node --run test and all tests passed.
  • I have check code formatting with node --run format:check & node --run lint.
  • I've covered new added functionality with unit tests if necessary.
  • My commit includes a DCO 1.1 Signed-off-by trailer.

@dxnnystyles
dxnnystyles requested a review from a team as a code owner October 26, 2026 16:26
@vercel

vercel Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
api-docs-tooling Ready Ready Preview Oct 26, 2026 4:26pm UTC

Request Review

@ovflowd ovflowd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose this looks good to me.

Thanks for your first contribution!

@codecov

codecov Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 91.37931% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 93.47%. Comparing base (ec7751f) to head (03f4fa1).

Files with missing lines Patch % Lines
...kages/core/src/generators/json-simple/generate.mjs 61.53% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1187      +/-   ##
==========================================
+ Coverage   93.44%   93.47%   +0.03%     
==========================================
  Files         278      279       +1     
  Lines       27820    27873      +53     
  Branches     2790     2795       +5     
==========================================
+ Hits        25997    26055      +58     
+ Misses       1801     1796       -5     
  Partials       22       22              

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

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

Copy link
Copy Markdown
Contributor

api-links Generator

Performance estimate (single CI run)

  • Generation time: 2.8% faster (1.07 s → 1.04 s)
  • Peak memory: 2.8% higher (289.13 MB → 297.36 MB)

json Generator

Performance estimate (single CI run)

  • Generation time: 51.1% slower (7.46 s → 11.27 s)
  • Peak memory: 3.2% lower (1.18 GB → 1.14 GB)

legacy-html Generator

Performance estimate (single CI run)

  • Generation time: 58.8% slower (10.58 s → 16.80 s)
  • Peak memory: 2.1% lower (1.79 GB → 1.75 GB)

legacy-json Generator

Performance estimate (single CI run)

  • Generation time: 23.6% faster (9.04 s → 6.91 s)
  • Peak memory: 9.4% higher (1.15 GB → 1.26 GB)

llms-txt Generator

Performance estimate (single CI run)

  • Generation time: 26.3% faster (8.10 s → 5.97 s)
  • Peak memory: 2.5% lower (1.19 GB → 1.16 GB)

orama-db Generator

Output size: 1 file changed · net +2.35 KB

File size details
File Main PR Change
orama-db.json 29.24 MB 29.24 MB +2.35 KB (+0.0%)

Performance estimate (single CI run)

  • Generation time: 29.0% slower (7.35 s → 9.48 s)
  • Peak memory: 9.4% lower (1.28 GB → 1.16 GB)

web Generator

Performance estimate (single CI run)

  • Generation time: 11.0% slower (22.42 s → 24.89 s)
  • Peak memory: 4.9% higher (1.90 GB → 2.00 GB)

This branch was successfully deployed

1 active deployment
Preview – api-docs-tooling — 03f4fa16 Deployed Oct 26, 2026 by vercel[bot]
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.

json-simple: stop removing headings from the metadata it shares with other generators

2 participants