Skip to content

JS-1722 [codex] Document VS Code SonarLint master build workflow#6990

Open
francois-mora-sonarsource wants to merge 2 commits intomasterfrom
codex/vscode-sonarlint-master-build-doc
Open

JS-1722 [codex] Document VS Code SonarLint master build workflow#6990
francois-mora-sonarsource wants to merge 2 commits intomasterfrom
codex/vscode-sonarlint-master-build-doc

Conversation

@francois-mora-sonarsource
Copy link
Copy Markdown
Contributor

Summary

  • add a guide for patching a local VS Code SonarLint or SonarQube for IDE install with the latest SonarJS master build
  • explain how to download the plugin jar from the Repox JFrog Web UI instead of using the machine-local mc jf download helper
  • link the new guide from docs/DEV.md

Validation

  • git diff --cached --check -- docs/DEV.md docs/vscode-sonarlint-master-build.md

@hashicorp-vault-sonar-prod hashicorp-vault-sonar-prod Bot changed the title [codex] Document VS Code SonarLint master build workflow JS-1722 [codex] Document VS Code SonarLint master build workflow May 7, 2026
@hashicorp-vault-sonar-prod
Copy link
Copy Markdown

hashicorp-vault-sonar-prod Bot commented May 7, 2026

JS-1722

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

Ruling Report

No changes to ruling expected issues in this PR

@francois-mora-sonarsource francois-mora-sonarsource requested a review from a team May 7, 2026 16:11
@francois-mora-sonarsource francois-mora-sonarsource marked this pull request as ready for review May 7, 2026 16:12
@sonar-review-alpha
Copy link
Copy Markdown
Contributor

sonar-review-alpha Bot commented May 7, 2026

Summary

This PR adds a new developer guide documenting how to patch a local VS Code SonarLint installation to test against the latest SonarJS master build from Repox. The guide covers the complete workflow from locating the extension directory, backing up files, downloading the jar, updating the analyzer, and rebuilding the eslint-bridge payload — with special attention to WSL/remote environments and troubleshooting. A short link is added to docs/DEV.md to point developers to this workflow.

What reviewers should know

Start with the new guide (docs/vscode-sonarlint-master-build.md) — it's a complete, self-contained workflow that developers can follow step-by-step. The most important technical detail is section "Why both sonarjs.jar and eslint-bridge must be updated" — reviewers should verify that this architecture explanation is accurate (the Node bridge uses an extracted eslint-bridge payload, not direct Java classes).

Key things to verify:

  • The bash commands for finding/backing up/extracting files are safe and correct
  • The Repox JFrog Web UI navigation instructions map to the actual repository layout
  • The troubleshooting section covers realistic failure modes (missing bridge, wrong extension path in WSL, stale logs)
  • The restoration/rollback steps are complete and clear

Minor context: The VS Code extension is now branded "SonarQube for IDE" but the package name is still sonarlint-vscode — the guide acknowledges this naming quirk upfront to avoid confusion.


  • Generate Walkthrough
  • Generate Diagram

🗣️ Give feedback

sonar-review-alpha[bot]

This comment was marked as resolved.

Copy link
Copy Markdown
Contributor

@sonar-review-alpha sonar-review-alpha Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! ✅

🗣️ Give feedback

@sonarqube-next
Copy link
Copy Markdown

sonarqube-next Bot commented May 7, 2026

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
0 Dependency risks
No data about Coverage
No data about Duplication

See analysis details on SonarQube

Copy link
Copy Markdown
Contributor

@nathsou nathsou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

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.

2 participants