[PR #14792] [MERGED] Spec for shell integration marks #30254

Open
opened 2026-01-31 09:39:37 +00:00 by claunia · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/microsoft/terminal/pull/14792
Author: @zadjii-msft
Created: 2/5/2023
Status: ✅ Merged
Merged: 7/20/2023
Merged by: @zadjii-msft

Base: main ← Head: dev/migrie/s/11000-marks


📝 Commits (8)

  • 11f930f The whole spec
  • 63aaa40 Apply suggestions from code review
  • 2197c26 Merge branch 'main' into dev/migrie/s/11000-marks
  • 3a9bd8c notes from review
  • a0933c9 spel
  • 0c06729 Merge remote-tracking branch 'origin/main' into dev/migrie/s/11000-marks
  • a2328d7 notes on edge cases
  • b8be9d4 last nits

📊 Changes

3 files changed (+499 additions, -0 deletions)

View changed files

➕ doc/specs/#11000 - Marks/Shell-Integration-Marks.md (+499 -0)
➕ doc/specs/#11000 - Marks/ftcs-diagram.png (+0 -0)
➕ doc/specs/#11000 - Marks/vscode-shell-integration-gutter-mark.png (+0 -0)

📄 Description

Summary of the Pull Request

Abstract

"Shell integration" refers to a broad category of ways by which a commandline
shell can drive richer integration with the terminal. This spec in particular is
most concerned with "marks" and other semantic markup of the buffer.

Marks are a new buffer-side feature that allow the commandline application or
user to add a bit of metadata to a range of text. This can be used for marking a
region of text as a prompt, marking a command as succeeded or failed, quickly
marking errors in the output. These marks can then be exposed to the user as
pips on the scrollbar, or as icons in the margins. Additionally, the user can
quickly scroll between different marks, to allow easy navigation between
important information in the buffer.

Marks in the Windows Terminal are a combination of functionality from a variety
of different terminal emulators. "Marks" attmepts to unify these different, but
related pieces of functionality.

Detailed Description of the Pull Request / Additional comments

*** read the spec ***

In all seriousness, I've already implemented a pile of this. This is just putting the finishing touches of formalizing it.

PR Checklist

  • This is a spec for #11000 and everything linked to that.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/microsoft/terminal/pull/14792 **Author:** [@zadjii-msft](https://github.com/zadjii-msft) **Created:** 2/5/2023 **Status:** ✅ Merged **Merged:** 7/20/2023 **Merged by:** [@zadjii-msft](https://github.com/zadjii-msft) **Base:** `main` ← **Head:** `dev/migrie/s/11000-marks` --- ### 📝 Commits (8) - [`11f930f`](https://github.com/microsoft/terminal/commit/11f930f7a5d5c293822dd9f25fbd21d58b01ad85) The whole spec - [`63aaa40`](https://github.com/microsoft/terminal/commit/63aaa40b6324ce88deb10f29b9b9b6096fda7bbf) Apply suggestions from code review - [`2197c26`](https://github.com/microsoft/terminal/commit/2197c262195d03e9cf88acd39441c990744a7eb5) Merge branch 'main' into dev/migrie/s/11000-marks - [`3a9bd8c`](https://github.com/microsoft/terminal/commit/3a9bd8c507bc9b71c55cf16dd9a80fb43a59b976) notes from review - [`a0933c9`](https://github.com/microsoft/terminal/commit/a0933c993ff13497bd2a9da142c6e41a53ed3a99) spel - [`0c06729`](https://github.com/microsoft/terminal/commit/0c06729afc270f95ca9426540fe585e71f48af68) Merge remote-tracking branch 'origin/main' into dev/migrie/s/11000-marks - [`a2328d7`](https://github.com/microsoft/terminal/commit/a2328d7f5469c5ca9638b0fdeb531ee1ee4e3bb4) notes on edge cases - [`b8be9d4`](https://github.com/microsoft/terminal/commit/b8be9d4c2c07df094e79c9503f0f322a6ea83e34) last nits ### 📊 Changes **3 files changed** (+499 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `doc/specs/#11000 - Marks/Shell-Integration-Marks.md` (+499 -0) ➕ `doc/specs/#11000 - Marks/ftcs-diagram.png` (+0 -0) ➕ `doc/specs/#11000 - Marks/vscode-shell-integration-gutter-mark.png` (+0 -0) </details> ### 📄 Description ## Summary of the Pull Request > ## Abstract > > _"Shell integration" refers to a broad category of ways by which a commandline > shell can drive richer integration with the terminal. This spec in particular is > most concerned with "marks" and other semantic markup of the buffer._ > > Marks are a new buffer-side feature that allow the commandline application or > user to add a bit of metadata to a range of text. This can be used for marking a > region of text as a prompt, marking a command as succeeded or failed, quickly > marking errors in the output. These marks can then be exposed to the user as > pips on the scrollbar, or as icons in the margins. Additionally, the user can > quickly scroll between different marks, to allow easy navigation between > important information in the buffer. > > Marks in the Windows Terminal are a combination of functionality from a variety > of different terminal emulators. "Marks" attmepts to unify these different, but > related pieces of functionality. ## Detailed Description of the Pull Request / Additional comments _\*<sup>\*</sup><sub>\*</sub> read the spec <sub>\*</sub><sup>\*</sup>\*_ In all seriousness, I've already implemented a pile of this. This is just putting the finishing touches of formalizing it. ## PR Checklist - [ ] This is a spec for #11000 and everything linked to that. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-31 09:39:37 +00:00
Sign in to join this conversation.
No Label pull-request
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#30254