Skip to content

feat: add Overlay parser adapters#188

Merged
char0n merged 2 commits intomainfrom
char0n/overlay-parser-adapters
Mar 21, 2026
Merged

feat: add Overlay parser adapters#188
char0n merged 2 commits intomainfrom
char0n/overlay-parser-adapters

Conversation

@char0n
Copy link
Copy Markdown
Member

@char0n char0n commented Mar 21, 2026

No description provided.

@char0n char0n requested a review from Copilot March 21, 2026 20:20
@char0n char0n self-assigned this Mar 21, 2026
@char0n char0n added the enhancement New feature or request label Mar 21, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds new parser adapters for the Overlay 1.x.y specification, enabling unified parsing and media type detection for both JSON and YAML Overlay documents within the ApiDOM ecosystem.

Changes:

  • Introduces @speclynx/apidom-parser-adapter-overlay-json-1 and @speclynx/apidom-parser-adapter-overlay-yaml-1 packages (adapter implementation, media types, build/test tooling).
  • Adds test coverage (detect/parse behavior, media type resolution, snapshots, fixtures) for both adapters.
  • Updates root documentation and tooling scripts to reference the new packages.

Reviewed changes

Copilot reviewed 38 out of 39 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
README.md Documents installation commands for the new Overlay adapters.
package.json Extends the root unlink script to include the new adapter packages.
package-lock.json Adds workspace links and dependency entries for the new packages.
packages/apidom-parser-adapter-overlay-yaml-1/tsconfig.json TypeScript config for the new YAML adapter package.
packages/apidom-parser-adapter-overlay-yaml-1/tsconfig.declaration.json Declaration build configuration for the YAML adapter.
packages/apidom-parser-adapter-overlay-yaml-1/test/mocha-bootstrap.ts Test bootstrap (snapshot serializers) for the YAML adapter.
packages/apidom-parser-adapter-overlay-yaml-1/test/media-types.ts Verifies media type detection via unified parser for YAML Overlay.
packages/apidom-parser-adapter-overlay-yaml-1/test/fixtures/sample-overlay.yaml YAML fixture for Overlay parsing/detection tests.
packages/apidom-parser-adapter-overlay-yaml-1/test/fixtures/sample-overlay.json JSON fixture used in YAML adapter tests (YAML 1.2 superset behavior).
packages/apidom-parser-adapter-overlay-yaml-1/test/adapter.ts Unit tests for YAML adapter detect/parse behavior and sourcemaps.
packages/apidom-parser-adapter-overlay-yaml-1/test/snapshots/adapter.mjs.snap Snapshot output for YAML adapter parse results.
packages/apidom-parser-adapter-overlay-yaml-1/src/media-types.ts Media type list selection for YAML adapter (generic + yaml).
packages/apidom-parser-adapter-overlay-yaml-1/src/adapter.ts YAML adapter implementation (detect/parse/namespace wiring).
packages/apidom-parser-adapter-overlay-yaml-1/README.md Package-level usage documentation for YAML adapter.
packages/apidom-parser-adapter-overlay-yaml-1/package.json Package metadata, build/test scripts, and dependencies for YAML adapter.
packages/apidom-parser-adapter-overlay-yaml-1/config/webpack/traits.config.js Shared webpack traits for browser builds.
packages/apidom-parser-adapter-overlay-yaml-1/config/webpack/browser.config.js Browser (UMD) build configuration for YAML adapter.
packages/apidom-parser-adapter-overlay-yaml-1/config/api-extractor/api-extractor.json API Extractor config for YAML adapter typings.
packages/apidom-parser-adapter-overlay-yaml-1/.npmrc Package npm config defaults.
packages/apidom-parser-adapter-overlay-yaml-1/.mocharc.json Mocha configuration for YAML adapter tests.
packages/apidom-parser-adapter-overlay-yaml-1/.gitignore Ignores build artifacts for YAML adapter package.
packages/apidom-parser-adapter-overlay-json-1/tsconfig.json TypeScript config for the new JSON adapter package.
packages/apidom-parser-adapter-overlay-json-1/tsconfig.declaration.json Declaration build configuration for the JSON adapter.
packages/apidom-parser-adapter-overlay-json-1/test/mocha-bootstrap.ts Test bootstrap (snapshot serializers) for the JSON adapter.
packages/apidom-parser-adapter-overlay-json-1/test/media-types.ts Verifies media type detection via unified parser for JSON Overlay.
packages/apidom-parser-adapter-overlay-json-1/test/fixtures/sample-overlay.yaml YAML fixture used to ensure JSON adapter does not detect YAML.
packages/apidom-parser-adapter-overlay-json-1/test/fixtures/sample-overlay.json JSON fixture for Overlay parsing/detection tests.
packages/apidom-parser-adapter-overlay-json-1/test/adapter.ts Unit tests for JSON adapter detect/parse behavior.
packages/apidom-parser-adapter-overlay-json-1/test/snapshots/adapter.mjs.snap Snapshot output for JSON adapter parse results.
packages/apidom-parser-adapter-overlay-json-1/src/media-types.ts Media type list selection for JSON adapter (generic + json).
packages/apidom-parser-adapter-overlay-json-1/src/adapter.ts JSON adapter implementation (detect/parse/namespace wiring).
packages/apidom-parser-adapter-overlay-json-1/README.md Package-level usage documentation for JSON adapter.
packages/apidom-parser-adapter-overlay-json-1/package.json Package metadata, build/test scripts, and dependencies for JSON adapter.
packages/apidom-parser-adapter-overlay-json-1/config/webpack/traits.config.js Shared webpack traits for browser builds.
packages/apidom-parser-adapter-overlay-json-1/config/webpack/browser.config.js Browser (UMD) build configuration for JSON adapter.
packages/apidom-parser-adapter-overlay-json-1/config/api-extractor/api-extractor.json API Extractor config for JSON adapter typings.
packages/apidom-parser-adapter-overlay-json-1/.npmrc Package npm config defaults.
packages/apidom-parser-adapter-overlay-json-1/.mocharc.json Mocha configuration for JSON adapter tests.
packages/apidom-parser-adapter-overlay-json-1/.gitignore Ignores build artifacts for JSON adapter package.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@char0n char0n merged commit 49824ff into main Mar 21, 2026
8 checks passed
@char0n char0n deleted the char0n/overlay-parser-adapters branch March 21, 2026 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants