[Repo Assist] docs: use \$\{workspaceFolder} instead of deprecated \$\{workspaceRoot} in executablePath example#102
Draft
github-actions[bot] wants to merge 1 commit intomasterfrom
Conversation
…n executablePath example
The README showed ${workspaceRoot} as the example for configuring a
workspace-relative executablePath. This variable is deprecated in VS Code
(since v1.10); ${workspaceFolder} is the current name and should be used
in documentation. The extension code already supports both forms.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
35 tasks
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.
🤖 This PR was created by Repo Assist, an automated AI assistant.
Summary
The README showed
\$\{workspaceRoot}as the primary example for a workspace-relativephpcbf.executablePath. This variable was deprecated in VS Code v1.10 in favour of\$\{workspaceFolder}. Since the docs are the first thing users read when configuring the extension, they should demonstrate the current, recommended syntax.What Changed
README.mdline 29:\$\{workspaceRoot}/vendor/bin/phpcbf→\$\{workspaceFolder}/vendor/bin/phpcbfThe extension code (
extension.js) already handles both\$\{workspaceFolder}and\$\{workspaceRoot}for backwards compatibility, so this is a documentation-only fix with no behaviour change.Why This Matters
Users setting up the extension for the first time may copy the example verbatim. Showing the deprecated
\$\{workspaceRoot}form risks confusion (VS Code's own IntelliSense will show\$\{workspaceFolder}in settings, which won't match the docs).Test Status
Documentation-only change — no code changed, all 7 unit tests pass unchanged.
npm run test:unit: 7/7 pass ✅