Skip to content

fix: keep VS Code API types aligned with supported engine - #58

Merged
SamErde merged 1 commit into
mainfrom
samerde-fix-vsix-packaging-compatibility
Oct 1, 2026
Merged

SamErde merged 1 commit into
mainfrom
samerde-fix-vsix-packaging-compatibility

Conversation

@SamErde

@SamErde SamErde commented Oct 1, 2026 •

Copy link
Copy Markdown
Owner

Fixes #57.

engines.vscode: ^1.90.0 remains required and unchanged. It admits compatible later 1.x releases, including the user-tested 1.140.0; it does not assert that all older versions were runtime-tested. The extension compiles against @types/vscode 1.90.0, and the prior sandbox probe exercised its workspace APIs on 1.90.2. Limit API typings to ~1.90.0 and exclude independent minor/major type bumps from Dependabot so tooling cannot silently claim a higher minimum. Document the compatibility policy.

Local verification: npm ci, npm run lint, npm run build, npm test (151 passed, 1 skipped), and VSIX packaging with both locked vsce 3.9.2 and separately installed vsce 4.0.0 pass. npm run test:integration timed out locally at the existing fixture CLI install/event test on a freshly downloaded VS Code 1.140.0; this is not a typecheck or packaging failure. CI must validate the integration test on each supported runner.

Coordination with #56: its current branch explicitly changes @types/vscode to ^1.138.0, so merging this PR alone does not make that stale grouped dependency branch safe. Regenerate/rebase #56 without the VS Code type bump after this lands, and require a green three-platform package + integration check before merging #56.

Summary by CodeRabbit

  • Maintenance
    • Limited editor type definitions to the 1.90 release line; patch updates remain eligible.
    • Updated build and release guidance to clarify version compatibility and when to update the minimum supported version.

Keep 1.90 as the minimum and prevent Dependabot from upgrading API typings independently of the engine.\n\nFixes #57\n\nCo-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-01T17:32:35.618285Z e1d6112 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@SamErde

SamErde commented Oct 1, 2026

Copy link
Copy Markdown
Owner Author

@codex review

@coderabbitai

coderabbitai Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

🧰 Additional context used
📚 Code guidelines (1)
CLAUDE.md — auto-discovered

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 3bb2e3b2-5bc8-4ea2-93a8-1789487aacb1

📥 Commits

Reviewing files that changed from the base of the PR and between 39e94d2 and e1d6112.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (3)
  • .github/dependabot.yml
  • docs/local-build-test-and-release.md
  • package.json

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The @types/vscode development dependency is limited to the 1.90 minor line. Dependabot ignores minor and major updates for the package. The build guide explains the relationship between the VS Code engine minimum, the type range, and testing.

Changes

VS Code types version alignment

Layer / File(s) Summary
Constrain and document the VS Code types range
package.json, .github/dependabot.yml, docs/local-build-test-and-release.md
@types/vscode changes from ^1.90.0 to ~1.90.0. Dependabot ignores minor and major updates for the package. The guide distinguishes the declared engine minimum from later VS Code releases and describes coordinated updates after testing.

Priority: ➖ Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix · Severity of issue fixed: Medium

Merge Risk: ⚪ Minimal · up to e1d61

No concrete compatibility or update-policy issue remains in the reviewed changes, so they are ready to merge subject to normal checks.

Architecture Summary

Architecture risk: 🔵 Low · up to e1d61

The change affects 2 systems.

Changed systems: docs, package.json

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 1 changed file maps to changed impact.
  • observed — package.json (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/local-build-test-and-release.md: Added guidance distinguishing the minimum declared by engines.vscode: ^1.90.0 from later VS Code 1.x releases, keeping @types/vscode on the 1.90 API line while that minimum applies, and updating the engine, types range, and Dependabot ignore rule together after testing a minimum-version change. The text also limits the stated scope of the 1.90.2 workspace API probe.
  • observed — Modified behavior in package.json: The @types/vscode dependency range changes from ^1.90.0 to ~1.90.0.
  • observed — Modified behavior in .github/dependabot.yml: Adds a Dependabot ignore rule for @types/vscode minor and major version updates.
🚥 Pre-merge checks | ✅ 4 | ❓ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive The PR addresses [#57] by retaining the required engines.vscode: ^1.90.0 declaration and narrowing @types/vscode to ~1.90.0. The documentation records the 1.90.2 API probe and the policy for fut… Provide successful CI evidence for the supported three-platform integration and VSIX packaging checks, or otherwise establish whether the timeout is resolved. Provide reviewable lockfile evidence if the dependency graph requires it.
✅ 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 clearly summarizes the main change: keeping the VS Code API type range aligned with the supported VS Code engine range.
Out of Scope Changes check ✅ Passed The changes stay within [#57]. The Dependabot ignore rule coordinates future @types/vscode updates, and the documentation records the engine and type-range compatibility policy. No unrelated impleme…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

The PR addresses [#57] by retaining the required engines.vscode: ^1.90.0 declaration and narrowing @types/vscode to ~1.90.0. The documentation records the 1.90.2 API probe and the policy for future minimum-version changes. The reported npm ci, lint, build, unit tests, and packaging checks passed locally. However, the integration test timed out, and the summary provides no successful supported-matrix CI result. The excluded package-lock.json also cannot be independently checked.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


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

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Chef's kiss.

Reviewed commit: e1d6112c1a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@SamErde
SamErde merged commit 9299de8 into main Oct 1, 2026
8 checks passed
@SamErde
SamErde deleted the samerde-fix-vsix-packaging-compatibility branch October 1, 2026 19:08
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.

Fix VSIX packaging failure from VS Code engine/types mismatch

1 participant