This repository was archived by the owner on Feb 25, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6k
Made YAML version of vscode workspace to avoid redundancy #55322
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
66137c4
Made YAML version of vscode workspace to avoid redundancy
gaaclarke 8d674d7
pulled out source map cmd
gaaclarke 7c3b1de
made building `silent`
gaaclarke 56be4bf
refresh
gaaclarke d8e7451
added script for merging
gaaclarke 4c97241
removed stray comment
gaaclarke 6f57bec
added ios build
gaaclarke 8ae217f
added requirements section to readme.md
gaaclarke ca0958a
oops
gaaclarke File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# VSCode Workspace | ||
|
||
This is the tools and the template used for updating //engine.code-workspace. | ||
|
||
VSCode uses a custom version of JSONC for their config files, those config files | ||
don't provide any mechanism for reducing redundancy. Since the engine has a lot | ||
of test targets, without that mechanism it can get very unwieldy. YAML does | ||
however support ways to reduce redundancy, namely anchors. | ||
|
||
## Updating //engine.code-workspace | ||
|
||
```sh | ||
./refresh.sh | ||
``` | ||
|
||
## Backporting //engine.code-workspace | ||
|
||
If something is accidentally introduced into //engine.code-workspace without editing | ||
the YAML file here there are tools that can be used to more easily fix that. | ||
|
||
```sh | ||
./merge.sh | ||
``` | ||
|
||
Since JSON doesn't support anchors some work may be needed to resolve any | ||
conflicts that happen when merging. These aren't necessary to use the VSCode | ||
workspace, just to edit them. | ||
|
||
## Requirements | ||
|
||
The `refresh.sh` and `merge.sh` tools require certain tools to be present on | ||
your PATH. They can be installed on macos with homebrew. | ||
|
||
- `json5` - A variant of JSON that is a superset of the JSON variant that VSCode | ||
uses. It's used to strip away comments and trailing commas. | ||
- `yq` - This is a tool for manipulating yaml files. It can convert back and | ||
forth from YAML to YAML and merge YAML files. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These comments live in the yaml file now.