Skip to content

Fix VS Code Marketplace README links#1105

Merged
aallan merged 1 commit into
mainfrom
codex/fix-vscode-marketplace-links
Jul 17, 2026
Merged

Fix VS Code Marketplace README links#1105
aallan merged 1 commit into
mainfrom
codex/fix-vscode-marketplace-links

Conversation

@aallan

@aallan aallan commented Jul 17, 2026

Copy link
Copy Markdown
Owner

Summary

  • replace the VS Code extension README's repository-relative LSP documentation links with stable absolute GitHub URLs
  • remove Marketplace hyperlinks that cannot resolve until the extension has completed its first publication

Why

vsce rewrites repository-relative links while packaging. Because the extension lives below the repository root, the two ../../LSP_SERVER.md links became malformed HEAD/../../ URLs in the packaged README and returned HTTP 404. The README also linked to the extension's Marketplace page before that page existed, producing two more 404s.

This removes known-bad metadata from the VSIX before retrying the Marketplace upload. Broken ordinary links are not documented by Microsoft as a definitive cause of the opaque "suspicious content" rejection, so this is a focused corrective step rather than a claim that the scanner's root cause is proven.

Validation

  • npm ci
  • npm run check
  • npm run package:list
  • npm run package -- --out /tmp/vera-language-0.2.0-readme-fix.vsix
  • inspected extension/readme.md inside the resulting VSIX
  • confirmed the replacement LSP documentation URL returns HTTP 200
  • confirmed the VSIX remains 11 files / 99.74 KB with no node_modules

Summary by CodeRabbit

  • Documentation
    • Updated the VS Code extension README with a direct link to the Vera language server setup guide.
    • Simplified installation instructions by retaining the command-line installation option.
    • Refreshed the links section with the Vera language website and GitHub repository.
    • Retained the TextMate bundle link for continued access.

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 629bcd52-d216-4306-a8f6-caf0e6144361

📥 Commits

Reviewing files that changed from the base of the PR and between 4e4aa8b and 69f54fd.

📒 Files selected for processing (1)
  • editors/vscode/README.md
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

  • aallan/vera-bench (manual)

📝 Walkthrough

Walkthrough

The VS Code README now links directly to the GitHub LSP server documentation, removes standalone Marketplace links, and adds Vera website and repository links while retaining the TextMate bundle reference.

Changes

VS Code README updates

Layer / File(s) Summary
Direct LSP documentation links
editors/vscode/README.md
Features and requirements sections now use the direct GitHub URL for LSP server documentation.
Installation and resource link guidance
editors/vscode/README.md
Removes standalone Marketplace links and adds Vera website and GitHub repository links. The TextMate bundle link remains.
Estimated code review effort: 1 (Trivial) ~2 minutes

Possibly related PRs

  • aallan/vera#365: Earlier Vera VS Code extension documentation changes overlap with these README updates.
  • aallan/vera#1102: Modifies the same README’s LSP setup and installation guidance.

Suggested labels: docs

🚥 Pre-merge checks | ✅ 8
✅ Passed checks (8 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the main README link fixes, including removing Marketplace links and updating VS Code documentation URLs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Changelog Covers Public-Surface Changes ✅ Passed Only editors/vscode/README.md changed; no public-surface code or spec files were touched, so CHANGELOG coverage was not required.
Spec And Implementation Move Together ✅ Passed Only editors/vscode/README.md changed; no files under vera/ or spec/ were modified, so there is no spec–implementation drift to assess.
Diagnostics Carry An Error Code ✅ Passed The diff only changes editors/vscode/README.md; no diagnostic definitions or codes were added or edited.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/fix-vscode-marketplace-links

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

@codecov

codecov Bot commented Jul 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.72%. Comparing base (4e4aa8b) to head (69f54fd).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1105   +/-   ##
=======================================
  Coverage   93.72%   93.72%           
=======================================
  Files          96       96           
  Lines       32708    32708           
  Branches      456      456           
=======================================
  Hits        30654    30654           
  Misses       2041     2041           
  Partials       13       13           
Flag Coverage Δ
javascript 78.41% <ø> (ø)
python 95.48% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@aallan

aallan commented Jul 17, 2026

Copy link
Copy Markdown
Owner Author

Review — complete and correct, ready to merge (README-only)

Codex's diagnosis is right: the VS Code Marketplace does not support relative links in READMEs and rejects them, and this README had two relative ../../LSP_SERVER.md links. This PR is the correct, focused fix.

Completeness audit (the thing that matters on a third attempt)

I enumerated every link/image target in the final README, not just the diff:

  • https://veralang.dev/ — absolute ✓
  • https://github.com/aallan/vera/blob/main/LSP_SERVER.md (×2) — absolute ✓ (the fixed links)
  • https://github.com/aallan/vera — absolute ✓
  • https://github.com/aallan/vera/tree/main/editors/textmate — absolute ✓
  • #requirements — in-page anchor ✓

No relative links, no http://, no images, no raw HTML remain. (The only <...> occurrences are Vera generic-type syntax like `@Array<String>` inside backtick code spans, not tags.) The two fixed targets both exist on main (LSP_SERVER.md at the repo root, editors/textmate/), so they resolve.

Removing the two marketplace.visualstudio.com/items?itemName=veralang.vera-language self-links is also correct — those pointed at the extension's own Marketplace page, which is a 404 until the extension is actually published.

Risk

README-only; the packaged bundle, dependencies, and manifest are unchanged, so this can't regress the extension itself.

Caveat (same as before, and worth stating on attempt three)

"Suspicious content" is an opaque verdict — the re-upload is the only real confirmation. Relative links are a documented Marketplace rejection cause, so this is a strong, well-founded fix. But if it still rejects after this, I'd stop guessing and use the "contact support" path the rejection message offers to get the specific trigger, rather than iterate blind.

Good to merge and re-submit.

@aallan
aallan merged commit d8692e8 into main Jul 17, 2026
29 checks passed
@aallan
aallan deleted the codex/fix-vscode-marketplace-links branch July 17, 2026 18:06
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.

1 participant