Add example to the vscode setting "initTemplatesUrls" (#5754)

From user feedback, it's not easy to figure out how to use the setting "initTemplatesUrls". The doc in changelog and intellisense in json is not that visible. So add example to the vscode setting page for "initTemplatesUrls" so that user can understand how to configure it easily.
microsoft · Jan 28, 2025 · 8e7dd77 · 8e7dd77
1 parent 67d284c
commit 8e7dd77
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/.chronus/changes/refine-config-description-2025-0-26-14-13-27.md b/.chronus/changes/refine-config-description-2025-0-26-14-13-27.md
@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - typespec-vscode
+---
+
+Add example to the vscode setting "initTemplatesUrls"
diff --git a/packages/typespec-vscode/package.json b/packages/typespec-vscode/package.json
@@ -77,7 +77,7 @@
           "typespec.initTemplatesUrls": {
             "type": "array",
             "default": [],
-            "description": "List of URLs to fetch templates from when creating a new project.",
+            "description": "List of URLs to fetch templates from when creating a new project.\n\nExample:\n\"typespec.initTemplatesUrls\": [{\n\"name\": \"displayName\",\n\"url\": \"https://urlToTheFileContainsTemplates\"\n}],",
             "scope": "machine-overridable",
             "items": {
               "type": "object",