Merged
Conversation
There was a problem hiding this comment.
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-1and@speclynx/apidom-parser-adapter-overlay-yaml-1packages (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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.