Skip to content

Conversation

@david-ly
Copy link

@david-ly david-ly commented May 12, 2025

Updated the settings.json code block according to the current schema

  • Refactored actions array elems to include declared ids referenced in the added keybindings array to define shortcut keystrokes (& added keys for select{Command|Output} actions)
  • Cleaned up indentation (tab size: 2 spaces) for consistency with the other code sections

@learn-build-service-prod
Copy link

Learn Build status updates of commit be3bb47:

✅ Validation status: passed

File Status Preview URL Details
TerminalDocs/tutorials/shell-integration.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@david-ly
Copy link
Author

@microsoft-github-policy-service agree

@learn-build-service-prod
Copy link

Learn Build status updates of commit 40786b1:

✅ Validation status: passed

File Status Preview URL Details
TerminalDocs/tutorials/shell-integration.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link

@suswan99 suswan99 left a comment

Choose a reason for hiding this comment

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

looks great! 💯

{ "keys": "ctrl+down", "command": { "action": "scrollToMark", "direction": "next" }, },

// Add the ability to select a whole command (or its output)
{ "command": { "action": "selectOutput", "direction": "prev" }, },
Copy link
Contributor

Choose a reason for hiding this comment

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

so, this one's actually our bad! These commands definitely do exist if bound, they just aren't in the actions list by default.

Copy link
Author

Choose a reason for hiding this comment

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

Gotcha I mis-assumed since my editor was complaining about them being invalid values, I've added them back into the docs. Is it worth making a PR to add them into the schema json or is there a reason they've been left out in the meantime?

@learn-build-service-prod
Copy link

Learn Build status updates of commit 06f49f0:

✅ Validation status: passed

File Status Preview URL Details
TerminalDocs/tutorials/shell-integration.md ✅Succeeded View

For more details, please refer to the build report.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 4214a0f:

✅ Validation status: passed

File Status Preview URL Details
TerminalDocs/tutorials/shell-integration.md ✅Succeeded View

For more details, please refer to the build report.

…s#860)

Based on the current schema (and messing with my own personal WT
`settings.json`), it looks like declaring an `id` bound to defined
`actions` & then referencing this id in `keybindings` is preferred
over using the `keys` prop within elements of the `actions` array.

`select{Command|Output}` were also emitting errors since they are
not officially defined in the schema but they are valid actions as
clarified by @DHowett & verified in my usage--added `keys` to docs
@learn-build-service-prod
Copy link

Learn Build status updates of commit ced6aef:

✅ Validation status: passed

File Status Preview URL Details
TerminalDocs/tutorials/shell-integration.md ✅Succeeded View

For more details, please refer to the build report.

@learn-build-service-prod
Copy link

Learn Build status updates of commit 4788417:

✅ Validation status: passed

File Status Preview URL Details
TerminalDocs/tutorials/shell-integration.md ✅Succeeded View

For more details, please refer to the build report.

@david-ly david-ly changed the title fix(docs): update shell integration settings.json codeblock Update settings.json code block for shell integration (#860) Jul 16, 2025
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.

5 participants