Script examples & scripting docs, Open VSX deployment, and broader test coverage#18
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
MelbourneDeveloper
added a commit
that referenced
this pull request
Jun 7, 2026
…st coverage (#18) <!-- agent-pmo:74cf183 --> ## TLDR Adds the `scriptexamples` body of work — runnable scripting examples + rewritten scripting docs, broader F# Core/LSP/DotHttp + VS Code test coverage, and an **Open VSX deployment channel** (plus Dependabot) so the per-platform VSIXs ship to the VS Code forks alongside the Marketplace. ## Details **Deployment / CI (`.github/`)** - `release.yml`: new **`publish-openvsx`** job mirroring `publish-marketplace`. Downloads every `vsix-*` artifact and publishes **one VSIX per platform** to the Open VSX Registry (Cursor / Windsurf / VSCodium / Gitpod / Eclipse Theia) via version-pinned `npx ovsx@1.0.0 publish`. Fully independent of the Marketplace/Release/Homebrew/Scoop jobs (`!cancelled() && package-vsix != skipped`), so a missing token only stalls Open VSX. Token is passed **only** through the `OVSX_PAT` env (never on argv); the job runs least-privilege (`contents: read`, `actions: read`) and prints an actionable error (with the `ovsx create-namespace` hint) when the secret is absent. Implements `[SWR-VSIX-PUBLISH]`, `[SWR-SEC-TOKEN-PRIVILEGE]`. - New `.github/dependabot.yml`: 5 ecosystems (github-actions, npm ×2, nuget, cargo), each grouped `patterns: ["*"]` into one combined PR per run to keep pinned action SHAs + deps fresh. Implements `[SWR-SEC-ACTION-PINNING]`. - `ci.yml`: minor gate additions. **Scripting examples & docs** - New `examples/scripts/`, `examples/scripting-ctx/`, `examples/jsonplaceholder/` — runnable scripting samples (the branch's namesake). - Rewritten `website/src/docs/*` scripting pages (F#/C#/JS/Python scripting, assertions, nap/naplist files, OpenAPI import, quick-start) + new installation/onboarding screenshots. **Core / LSP / converter + tests** - `src/Napper.Core`, `src/Napper.Lsp`, `src/DotHttp` source changes with matching test additions in `Napper.Core.Tests` (26 files), `DotHttp.Tests` (13), `Napper.Lsp.Tests` (6). - VS Code extension (`src/Napper.VsCode`, 43 files): new `cliResolver` unit tests (+132 lines), `stryker.conf.json` mutation config, watcher/provider updates. 54 files added, 124 modified, 4 renamed. ## How Do The Automated Tests Prove It Works? - **Open VSX workflow** is statically validated: `actionlint .github/workflows/release.yml` → exit 0 with **zero findings on the new `publish-openvsx` job**; the job's `Require Open VSX credential` step fails fast and visibly if `OPEN_VSX_PAT` is unset rather than emitting an opaque registry auth error. The per-platform VSIXs it publishes are the same artifacts the existing `package-vsix` job already content-verifies (`bin/<platform>/napper`, `shipwright.json` present, no foreign-platform binaries). - **Manifest contract**: `npx @nimblesite/shipwright-validate-manifest --schema schemas/shipwright.schema.json src/Napper.VsCode/shipwright.json` → `valid`; CI's version-contract gate asserts `napper --version` == `napper <ver>` and `--version --json` matches the schema, and `aot-smoke` drives a real `initialize` handshake through the NativeAOT `napper lsp` binary. - **Core/converter/LSP behaviour**: the added assertions in `Napper.Core.Tests`, `DotHttp.Tests`, and `Napper.Lsp.Tests` exercise the changed parsing/scripting/LSP paths; the VS Code `cliResolver` unit tests cover the resolve/retry policy and are included in the StrykerJS mutation gate. - **Dependabot config** parses as valid YAML (`version: 2`, 5 ecosystems). ## Breaking Changes None. All changes are additive: new examples, docs, and tests, plus a new **opt-in** Open VSX publish channel that no-ops (with a clear error) until `OPEN_VSX_PAT` is configured. No existing CLI/extension behaviour or public contract changes. ---------
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.
TLDR
Adds the
scriptexamplesbody of work — runnable scripting examples + rewritten scripting docs, broader F# Core/LSP/DotHttp + VS Code test coverage, and an Open VSX deployment channel (plus Dependabot) so the per-platform VSIXs ship to the VS Code forks alongside the Marketplace.Details
Deployment / CI (
.github/)release.yml: newpublish-openvsxjob mirroringpublish-marketplace. Downloads everyvsix-*artifact and publishes one VSIX per platform to the Open VSX Registry (Cursor / Windsurf / VSCodium / Gitpod / Eclipse Theia) via version-pinnednpx ovsx@1.0.0 publish. Fully independent of the Marketplace/Release/Homebrew/Scoop jobs (!cancelled() && package-vsix != skipped), so a missing token only stalls Open VSX. Token is passed only through theOVSX_PATenv (never on argv); the job runs least-privilege (contents: read,actions: read) and prints an actionable error (with theovsx create-namespacehint) when the secret is absent. Implements[SWR-VSIX-PUBLISH],[SWR-SEC-TOKEN-PRIVILEGE]..github/dependabot.yml: 5 ecosystems (github-actions, npm ×2, nuget, cargo), each groupedpatterns: ["*"]into one combined PR per run to keep pinned action SHAs + deps fresh. Implements[SWR-SEC-ACTION-PINNING].ci.yml: minor gate additions.Scripting examples & docs
examples/scripts/,examples/scripting-ctx/,examples/jsonplaceholder/— runnable scripting samples (the branch's namesake).website/src/docs/*scripting pages (F#/C#/JS/Python scripting, assertions, nap/naplist files, OpenAPI import, quick-start) + new installation/onboarding screenshots.Core / LSP / converter + tests
src/Napper.Core,src/Napper.Lsp,src/DotHttpsource changes with matching test additions inNapper.Core.Tests(26 files),DotHttp.Tests(13),Napper.Lsp.Tests(6).src/Napper.VsCode, 43 files): newcliResolverunit tests (+132 lines),stryker.conf.jsonmutation config, watcher/provider updates.54 files added, 124 modified, 4 renamed.
How Do The Automated Tests Prove It Works?
actionlint .github/workflows/release.yml→ exit 0 with zero findings on the newpublish-openvsxjob; the job'sRequire Open VSX credentialstep fails fast and visibly ifOPEN_VSX_PATis unset rather than emitting an opaque registry auth error. The per-platform VSIXs it publishes are the same artifacts the existingpackage-vsixjob already content-verifies (bin/<platform>/napper,shipwright.jsonpresent, no foreign-platform binaries).npx @nimblesite/shipwright-validate-manifest --schema schemas/shipwright.schema.json src/Napper.VsCode/shipwright.json→valid; CI's version-contract gate assertsnapper --version==napper <ver>and--version --jsonmatches the schema, andaot-smokedrives a realinitializehandshake through the NativeAOTnapper lspbinary.Napper.Core.Tests,DotHttp.Tests, andNapper.Lsp.Testsexercise the changed parsing/scripting/LSP paths; the VS CodecliResolverunit tests cover the resolve/retry policy and are included in the StrykerJS mutation gate.version: 2, 5 ecosystems).Breaking Changes
None. All changes are additive: new examples, docs, and tests, plus a new opt-in Open VSX publish channel that no-ops (with a clear error) until
OPEN_VSX_PATis configured. No existing CLI/extension behaviour or public contract changes.