docs(reference): clarify platform and workspace behavior for variables#9191
Merged
ntrogh merged 2 commits intomicrosoft:mainfrom Dec 22, 2025
Merged
docs(reference): clarify platform and workspace behavior for variables#9191ntrogh merged 2 commits intomicrosoft:mainfrom
ntrogh merged 2 commits intomicrosoft:mainfrom
Conversation
Contributor
Author
|
@microsoft-github-policy-service agree |
ntrogh
requested changes
Dec 21, 2025
Collaborator
ntrogh
left a comment
ntrogh
left a comment
There was a problem hiding this comment.
@DakotaB75 Thanks for contributing. Left some comments to apply to the PR.
| > [!TIP] | ||
| > Use IntelliSense inside string values for `tasks.json` and `launch.json` to get a full list of predefined variables. | ||
|
|
||
| ## Platform and Workspace Considerations |
Collaborator
There was a problem hiding this comment.
Suggested change
| ## Platform and Workspace Considerations | |
| ## Platform and workspace considerations |
| - On **Windows**, file paths use backslashes (`\`). When composing paths in JSON files such as `tasks.json` or `launch.json`, ensure backslashes are properly escaped (for example: `"${workspaceFolder}\\subdir"`). | ||
| - On **macOS** and **Linux**, file paths use forward slashes (`/`). | ||
|
|
||
| Using `${pathSeparator}` or `${/}` can help make configurations portable across platforms. |
Collaborator
There was a problem hiding this comment.
Suggested change
| Using `${pathSeparator}` or `${/}` can help make configurations portable across platforms. | |
| It's recommended to use `${pathSeparator}` or `${/}` to make configurations portable across platforms. |
|
|
||
| ### Workspace context | ||
|
|
||
| - Variables such as `${workspaceFolder}` and `${workspaceFolderBasename}` resolve to the first root folder of the workspace. |
Collaborator
There was a problem hiding this comment.
Don't use a separate section but include this information in the table of predefined variables above.
Updated section titles and improved clarity of platform-specific behavior and workspace context.
Contributor
Author
|
Thanks for the review! I've applied the requested changes and updated the content accordingly. |
ntrogh
approved these changes
Dec 22, 2025
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
2 participants
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 pull request adds clarification about platform-specific path behavior and workspace context for predefined variables used in VS Code configurations.
The added notes aim to help users better understand how variables resolve across different operating systems and workspace setups, improving portability and reducing configuration issues.