Setting the file. One moment. Raw file
references/codetour-schema.json
JSON·115 lines·4 KB
"Specifies the title of the code tour."
10 },
11 "description": {
12 "type": "string",
13 "description": "Specifies an optional description for the code tour."
14 },
15 "ref": {
16 "type": "string",
17 "description": "Indicates the git ref (branch/commit/tag) that this tour associate with."
18 },
19 "isPrimary": {
20 "type": "boolean",
21 "description": "Specifies whether the tour represents the primary tour for this codebase."
22 },
23 "nextTour": {
24 "type": "string",
25 "description": "Specifies the title of the tour that is meant to follow this tour."
26 },
27 "stepMarker": {
28 "type": "string",
29 "description": "Specifies the marker that indicates a line of code represents a step for this tour."
30 },
31 "when": {
32 "type": "string",
33 "description": "Specifies the condition (JavaScript expression) that must be met before this tour is shown."
34 },
35 "steps": {
36 "type": "array",
37 "description": "Specifies the list of steps that are included in the code tour.",
38 "default": [],
39 "items": {
40 "type": "object",
41 "required": ["description"],
42 "properties": {
43 "title": {
44 "type": "string",
45 "description": "An optional title for the step."
46 },
47 "description": {
48 "type": "string",
49 "description": "Description of the step. Supports markdown."
50 },
51 "file": {
52 "type": "string",
53 "description": "File path (relative to the workspace root) that the step is associated with."
54 },
55 "directory": {
56 "type": "string",
57 "description": "Directory path (relative to the workspace root) that the step is associated with."
58 },
59 "uri": {
60 "type": "string",
61 "description": "Absolute URI (https://...) associated with the step. Use for PRs, issues, docs, ADRs."
62 },
63 "line": {
64 "type": "number",
65 "description": "Line number (1-based) that the step is associated with."
66 },
67 "pattern": {
68 "type": "string",
69 "description": "Regex to associate the step with a line by content instead of line number. Useful when line numbers shift frequently."
70 },
71 "selection": {
72 "type": "object",
73 "required": ["start", "end"],
74 "description": "Text selection range associated with the step. Use when a block of code (not a single line) is the point.",
75 "properties": {
76 "start": {
77 "type": "object",
78 "required": ["line", "character"],
79 "properties": {
80 "line": { "type": "number", "description": "Line number (1-based) where the selection starts." },
81 "character": { "type": "number", "description": "Column number (1-based) where the selection starts." }
82 }
83 },
84 "end": {
85 "type": "object",
86 "required": ["line", "character"],
87 "properties": {
88 "line": { "type": "number", "description": "Line number (1-based) where the selection ends." },
89 "character": { "type": "number", "description": "Column number (1-based) where the selection ends." }
90 }
91 }
92 }
93 },
94 "view": {
95 "type": "string",
96 "description": "VS Code view ID to auto-focus when navigating to this step (e.g. 'terminal', 'explorer', 'problems', 'scm')."
97 },
98 "commands": {
99 "type": "array",
100 "description": "VS Code command URIs to execute when this step is navigated to.",
101 "default": [],
102 "items": { "type": "string" },
103 "examples": [
104 ["editor.action.goToDeclaration"],
105 ["workbench.action.terminal.focus"],
106 ["editor.action.showHover"],
107 ["references-view.findReferences"],
108 ["workbench.action.tasks.runTask"]
109 ]
110 }
111 }
112 }
113 }
114 }
115}