feat(validator-speclynx): expose parse result via toolbox

[char0n]

Summary by CodeRabbit

• New Features

  • Plugins now have direct access to parseResult via the toolbox, enabling retrieval of full ApiDOM parse results alongside diagnostics and dependencies.

• Documentation

  • Updated plugin docs and examples to document the new toolbox.parseResult property.

• Tests

  • Added a test plugin and an integration test to verify parseResult is available to plugins.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Exposes a new parseResult property on the SpecLynx plugin toolbox, updates docs and examples to document it, adds a test plugin that checks parseResult presence, and adds an integration test asserting plugins can access parseResult.

Changes

Cohort / File(s)	Summary
Toolbox implementation packages/jentic-openapi-validator-speclynx/src/jentic/apitools/openapi/validator/backends/speclynx/resources/speclynx.mjs	Added parseResult to the toolbox object provided to plugins (property added to returned toolbox).
Docs & examples packages/jentic-openapi-validator-speclynx/README.md, packages/jentic-openapi-validator-speclynx/src/jentic/apitools/openapi/validator/backends/speclynx/__init__.py, .../resources/plugins/example-plugin.mjs.sample, .../resources/plugins/openapi-document.mjs, tests/fixtures/plugins/version-validator.mjs	JSDoc/docstring/example updates to document toolbox.parseResult (descriptions adjusted; destructuring examples updated).
Tests & fixtures packages/jentic-openapi-validator-speclynx/tests/fixtures/plugins/parseresult-check.mjs, packages/jentic-openapi-validator-speclynx/tests/test_speclynx_validate.py	New test fixture plugin verifies toolbox.parseResult availability; new integration test(s) assert plugin receives parseResult and emits expected diagnostic(s).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• fix(validator-speclynx): fix generation of diagnostic paths #193: Modifies SpecLynx plugin toolbox and diagnostics/traversal—closely related to toolbox changes here.
• chore(deps): update SpecLynx ApiDOM to v2.5.1 #197: Changes parser/diagnostic handling in the SpecLynx backend; overlaps with exposing parser results to plugins.
• feat(validator-speclynx): simplify plugins signature #208: Also adjusts the plugin toolbox API surface; likely related to adding parseResult.

Suggested reviewers

• frantuma
• frankkilcommins

Poem

🐰 A tiny hop, a little test,
parseResult tucked in the chest,
Plugins peek and give a cheer,
Diagnostics whisper, "We are here!"
Hooray — the rabbit danced, no jest.

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: exposing the parse result through the toolbox object across multiple plugin-related files.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into main

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch char0n/validator-speclynx-parse-result

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

This PR exposes the full ApiDOM parseResult to SpecLynx validation plugins via the plugin toolbox, and updates plugin documentation/examples accordingly.

Changes:

• Add parseResult to the plugin toolbox created by the SpecLynx validator runtime.
• Update built-in/sample plugin documentation and test fixtures to describe the new toolbox field.
• Update package README and Python backend docstring to document parseResult availability for plugin authors.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/jentic-openapi-validator-speclynx/tests/fixtures/plugins/version-validator.mjs	Updates fixture plugin docs to mention parseResult in toolbox.
packages/jentic-openapi-validator-speclynx/src/jentic/apitools/openapi/validator/backends/speclynx/resources/speclynx.mjs	Passes parseResult through the toolbox to plugins.
packages/jentic-openapi-validator-speclynx/src/jentic/apitools/openapi/validator/backends/speclynx/resources/plugins/openapi-document.mjs	Updates plugin header docs to mention parseResult.
packages/jentic-openapi-validator-speclynx/src/jentic/apitools/openapi/validator/backends/speclynx/resources/plugins/example-plugin.mjs.sample	Updates sample plugin docs to include parseResult in toolbox contract.
packages/jentic-openapi-validator-speclynx/src/jentic/apitools/openapi/validator/backends/speclynx/init.py	Updates Python backend docstring describing plugin toolbox fields.
packages/jentic-openapi-validator-speclynx/README.md	Updates public docs/example to show parseResult in plugin toolbox.

---

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