Skip to content

Convert highlight comments to diff format with + prefix #9540

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 6 commits into
base: main
Choose a base branch
from
+1,188 −1,259
Draft

Convert highlight comments to diff format with + prefix #9540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6346e07
Initial plan
Copilot Jan 30, 2026
66c3c1c
Add comment-highlights plugin for Expressive Code
Copilot Jan 30, 2026
64c48e4
Simplify comment-highlights plugin logic
Copilot Jan 30, 2026
7f31e0a
Convert highlight comments to mark syntax
Copilot Jan 30, 2026
958fb5d
Use ins={} diff syntax instead of mark={} for added lines
Copilot Jan 31, 2026
ae38266
Convert to diff language format with + prefix for added lines
Copilot Jan 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 69 additions & 77 deletions ...ontent/docs/docs/getting-started/getting-started-rest/01-setup-basic-syntax.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,16 +92,14 @@ A REST service in TypeSpec is defined using the [`@service`](../../../standard-l

Let's start by defining a simple REST service for a Pet Store:

```tsp title=main.tsp tryit="{"emit": ["@typespec/openapi3"]}"
import "@typespec/http";

using Http;
// highlight-start
@service(#{
title: "Pet Store",
})
@server("https://example.com", "Single server endpoint")
// highlight-end
```diff lang=tsp title=main.tsp tryit="{"emit": ["@typespec/openapi3"]}"
import "@typespec/http";

using Http;
+@service(#{
+ title: "Pet Store",
+})
+@server("https://example.com", "Single server endpoint")
```

In this example:
Expand All @@ -121,16 +119,15 @@ In this example:

Let's create a namespace for our Pet Store service:

```tsp title=main.tsp tryit="{"emit": ["@typespec/openapi3"]}"
import "@typespec/http";

using Http;

@service(#{ title: "Pet Store" })
@server("https://example.com", "Single server endpoint")

// highlight-next-line
namespace PetStore;
```diff lang=tsp title=main.tsp tryit="{"emit": ["@typespec/openapi3"]}"
import "@typespec/http";

using Http;

@service(#{ title: "Pet Store" })
@server("https://example.com", "Single server endpoint")

+namespace PetStore;
```

In this example:
Expand All @@ -150,31 +147,29 @@ In TypeSpec, a [model](../../language-basics/models.md) is a fundamental buildin

Let's define a simple model for a `Pet`:

```tsp title=main.tsp tryit="{"emit": ["@typespec/openapi3"]}"
import "@typespec/http";

using Http;

@service(#{ title: "Pet Store" })
@server("https://example.com", "Single server endpoint")
namespace PetStore;

// highlight-start
model Pet {
id: int32;
name: string;
age: int32;
kind: petType;
}

enum petType {
dog: "dog",
cat: "cat",
fish: "fish",
bird: "bird",
reptile: "reptile",
}
// highlight-end
```diff lang=tsp title=main.tsp tryit="{"emit": ["@typespec/openapi3"]}"
import "@typespec/http";

using Http;

@service(#{ title: "Pet Store" })
@server("https://example.com", "Single server endpoint")
namespace PetStore;

+model Pet {
+ id: int32;
+ name: string;
+ age: int32;
+ kind: petType;
+}
+
+enum petType {
+ dog: "dog",
+ cat: "cat",
+ fish: "fish",
+ bird: "bird",
+ reptile: "reptile",
+}
```

In this example:
Expand All @@ -189,38 +184,35 @@ In this example:

We can add [validation](../../../language-basics/values/#validation) annotations to our model properties to enforce certain constraints:

```tsp title=main.tsp tryit="{"emit": ["@typespec/openapi3"]}"
import "@typespec/http";

using Http;

@service(#{ title: "Pet Store" })
@server("https://example.com", "Single server endpoint")
namespace PetStore;

model Pet {
id: int32;

// highlight-next-line
@minLength(1)
name: string;

// highlight-next-line
@minValue(0)
// highlight-next-line
@maxValue(100)
age: int32;

kind: petType;
}

enum petType {
dog: "dog",
cat: "cat",
fish: "fish",
bird: "bird",
reptile: "reptile",
}
```diff lang=tsp title=main.tsp tryit="{"emit": ["@typespec/openapi3"]}"
import "@typespec/http";

using Http;

@service(#{ title: "Pet Store" })
@server("https://example.com", "Single server endpoint")
namespace PetStore;

model Pet {
id: int32;

+ @minLength(1)
name: string;

+ @minValue(0)
+ @maxValue(100)
age: int32;

kind: petType;
}

enum petType {
dog: "dog",
cat: "cat",
fish: "fish",
bird: "bird",
reptile: "reptile",
}
```

In this example:
Expand Down
Loading