From c3e80dc6746e3a3a514841780ed1a8466fb01f4b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=B1=B1=E5=90=B9=E8=89=B2=E5=BE=A1=E5=AE=88?=
 <85992002+KazariEX@users.noreply.github.com>
Date: Sat, 21 Dec 2024 04:38:58 +0800
Subject: [PATCH] feat(vscode): add examples to inlay hints configuration
 (#5068)

---
 extensions/vscode/README.md    | 24 ++++++++----------------
 extensions/vscode/package.json | 14 ++++++--------
 2 files changed, 14 insertions(+), 24 deletions(-)

diff --git a/extensions/vscode/README.md b/extensions/vscode/README.md
index 0271f714fe..de033d4b85 100644
--- a/extensions/vscode/README.md
+++ b/extensions/vscode/README.md
@@ -257,22 +257,16 @@ Finally you need to make VS Code recognize your new extension and automatically
 
 ## Commands
 
-<!-- commands -->
-
-| Command                        | Title                                                  |
-| ------------------------------ | ------------------------------------------------------ |
-| `vue.action.restartServer`     | Vue: Restart Vue and TS servers                        |
-| `vue.action.doctor`            | Vue: Doctor                                            |
-| `vue.action.writeVirtualFiles` | Vue (Debug): Write Virtual Files                       |
-| `vue.action.splitEditors`      | Vue: Split &lt;script&gt;, <template>, <style> Editors |
-| `vue.findAllFileReferences`    | Vue: Find File References via Vue Language Server      |
-
-<!-- commands -->
+| Command                        | Title                                                   |
+| ------------------------------ | ------------------------------------------------------- |
+| `vue.action.restartServer`     | Vue: Restart Vue and TS servers                         |
+| `vue.action.doctor`            | Vue: Doctor                                             |
+| `vue.action.writeVirtualFiles` | Vue (Debug): Write Virtual Files                        |
+| `vue.action.splitEditors`      | Vue: Split `<script>`, `<template>`, `<style>` Editors  |
+| `vue.findAllFileReferences`    | Vue: Find File References via Vue Language Server       |
 
 ## Configs
 
-<!-- configs -->
-
 | Key                                   | Description                                                                                                                                                        | Type             | Default                             |
 | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | ----------------------------------- |
 | `vue.trace.server`                    | Traces the communication between VS Code and the language server.                                                                                                  | `string`         | `"off"`                             |
@@ -292,7 +286,7 @@ Finally you need to make VS Code recognize your new extension and automatically
 | `vue.complete.casing.props`           | Preferred attr name case.                                                                                                                                          | `string`         | `"autoKebab"`                       |
 | `vue.complete.defineAssignment`       | Auto add `const props = ` before `defineProps` when selecting the completion item `props`. (also `emit` and `slots`)                                               | `boolean`        | `true`                              |
 | `vue.autoInsert.dotValue`             | Auto-complete Ref value with `.value`.                                                                                                                             | `boolean`        | `false`                             |
-| `vue.autoInsert.bracketSpacing`       | Auto add space between double curly brackets: {{&vert;}} -&gt; {{ | }}                                                                                             | `boolean`        | `true`                              |
+| `vue.autoInsert.bracketSpacing`       | Auto add space between double curly brackets: <code>{{&vert;}}</code> -> <code>{{ &vert; }}</code>                                                                 | `boolean`        | `true`                              |
 | `vue.inlayHints.destructuredProps`    | Show inlay hints for destructured props.                                                                                                                           | `boolean`        | `false`                             |
 | `vue.inlayHints.missingProps`         | Show inlay hints for missing required props.                                                                                                                       | `boolean`        | `false`                             |
 | `vue.inlayHints.inlineHandlerLeading` | Show inlay hints for event argument in inline handlers.                                                                                                            | `boolean`        | `false`                             |
@@ -302,5 +296,3 @@ Finally you need to make VS Code recognize your new extension and automatically
 | `vue.format.style.initialIndent`      |                                                                                                                                                                    | `boolean`        | `false`                             |
 | `vue.format.script.initialIndent`     |                                                                                                                                                                    | `boolean`        | `false`                             |
 | `vue.format.wrapAttributes`           |                                                                                                                                                                    | `string`         | `"auto"`                            |
-
-<!-- configs -->
diff --git a/extensions/vscode/package.json b/extensions/vscode/package.json
index 510653134d..02176e0cf4 100644
--- a/extensions/vscode/package.json
+++ b/extensions/vscode/package.json
@@ -402,27 +402,27 @@
 				"vue.inlayHints.destructuredProps": {
 					"type": "boolean",
 					"default": false,
-					"description": "Show inlay hints for destructured props."
+					"markdownDescription": "Show inlay hints for destructured props:\n\n```ts\nwatch(() => /* props. */foo, () => { ... });\n```"
 				},
 				"vue.inlayHints.missingProps": {
 					"type": "boolean",
 					"default": false,
-					"description": "Show inlay hints for missing required props."
+					"markdownDescription": "Show inlay hints for missing required props:\n\n```html\n<Comp />\n<!-- ^ foo! -->\n```"
 				},
 				"vue.inlayHints.inlineHandlerLeading": {
 					"type": "boolean",
 					"default": false,
-					"description": "Show inlay hints for event argument in inline handlers."
+					"markdownDescription": "Show inlay hints for event argument in inline handlers:\n\n```html\n<Comp @foo=\"/* $event => */console.log($event)\" />\n```"
 				},
 				"vue.inlayHints.optionsWrapper": {
 					"type": "boolean",
 					"default": false,
-					"description": "Show inlay hints for component options wrapper for type support."
+					"markdownDescription": "Show inlay hints for component options wrapper for type support:\n\n```vue\n<script lang=\"ts\">\nexport default /* (await import('vue')).defineComponent( */{}/* ) */;\n</script>\n```"
 				},
 				"vue.inlayHints.vBindShorthand": {
 					"type": "boolean",
 					"default": false,
-					"description": "Show inlay hints for v-bind shorthand."
+					"markdownDescription": "Show inlay hints for v-bind shorthand:\n\n```html\n<Comp :foo />\n     <!-- ^ =\"foo\" -->\n```"
 				},
 				"vue.format.template.initialIndent": {
 					"type": "boolean",
@@ -559,8 +559,7 @@
 		"pack:next": "pnpm run build && vsce package",
 		"release": "pnpm run build:minify && vsce publish",
 		"release:next": "pnpm run build && vsce publish --pre-release",
-		"size": "pnpm run build:minify -- --metafile && esbuild-visualizer --metadata ./meta.json && open ./stats.html",
-		"postinstall": "vscode-ext-gen --scope vue"
+		"size": "pnpm run build:minify -- --metafile && esbuild-visualizer --metadata ./meta.json && open ./stats.html"
 	},
 	"devDependencies": {
 		"@types/semver": "^7.5.3",
@@ -574,7 +573,6 @@
 		"esbuild-visualizer": "latest",
 		"reactive-vscode": "^0.2.9",
 		"semver": "^7.5.4",
-		"vscode-ext-gen": "^0.5.0",
 		"vscode-tmlanguage-snapshot": "latest"
 	}
 }