Add examples to inlay hint settings

Fixes #129517
This commit is contained in:
Matt Bierner 2021-07-27 16:07:40 -07:00
parent 515674f65e
commit 9c12aa144b
No known key found for this signature in database
GPG key ID: 099C331567E11888
2 changed files with 20 additions and 20 deletions

View file

@ -283,44 +283,44 @@
"%inlayHints.parameterNames.all%"
],
"default": "none",
"description": "%configuration.inlayHints.parameterNames.enabled%",
"markdownDescription": "%configuration.inlayHints.parameterNames.enabled%",
"scope": "resource"
},
"typescript.inlayHints.parameterNames.suppressWhenArgumentMatchesName": {
"type": "boolean",
"default": true,
"description": "%configuration.inlayHints.parameterNames.suppressWhenArgumentMatchesName%",
"markdownDescription": "%configuration.inlayHints.parameterNames.suppressWhenArgumentMatchesName%",
"scope": "resource"
},
"typescript.inlayHints.parameterTypes.enabled": {
"type": "boolean",
"default": false,
"description": "%configuration.inlayHints.parameterTypes.enabled%",
"markdownDescription": "%configuration.inlayHints.parameterTypes.enabled%",
"scope": "resource"
},
"typescript.inlayHints.variableTypes.enabled": {
"type": "boolean",
"default": false,
"description": "%configuration.inlayHints.variableTypes.enabled%",
"markdownDescription": "%configuration.inlayHints.variableTypes.enabled%",
"scope": "resource"
},
"typescript.inlayHints.propertyDeclarationTypes.enabled": {
"type": "boolean",
"default": false,
"description": "%configuration.inlayHints.propertyDeclarationTypes.enabled%",
"markdownDescription": "%configuration.inlayHints.propertyDeclarationTypes.enabled%",
"scope": "resource"
},
"typescript.inlayHints.functionLikeReturnTypes.enabled": {
"type": "boolean",
"default": false,
"description": "%configuration.inlayHints.functionLikeReturnTypes.enabled%",
"markdownDescription": "%configuration.inlayHints.functionLikeReturnTypes.enabled%",
"scope": "resource"
},
"typescript.inlayHints.enumMemberValues.enabled": {
"type": "boolean",
"default": false,
"description": "%configuration.inlayHints.enumMemberValues.enabled%",
"markdownDescription": "%configuration.inlayHints.enumMemberValues.enabled%",
"scope": "resource"
},
"javascript.inlayHints.parameterNames.enabled": {
@ -336,43 +336,43 @@
"%inlayHints.parameterNames.all%"
],
"default": "none",
"description": "%configuration.inlayHints.parameterNames.enabled%",
"markdownDescription": "%configuration.inlayHints.parameterNames.enabled%",
"scope": "resource"
},
"javascript.inlayHints.parameterNames.suppressWhenArgumentMatchesName": {
"type": "boolean",
"default": true,
"description": "%configuration.inlayHints.parameterNames.suppressWhenArgumentMatchesName%",
"markdownDescription": "%configuration.inlayHints.parameterNames.suppressWhenArgumentMatchesName%",
"scope": "resource"
},
"javascript.inlayHints.parameterTypes.enabled": {
"type": "boolean",
"default": false,
"description": "%configuration.inlayHints.parameterTypes.enabled%",
"markdownDescription": "%configuration.inlayHints.parameterTypes.enabled%",
"scope": "resource"
},
"javascript.inlayHints.variableTypes.enabled": {
"type": "boolean",
"default": false,
"description": "%configuration.inlayHints.variableTypes.enabled%",
"markdownDescription": "%configuration.inlayHints.variableTypes.enabled%",
"scope": "resource"
},
"javascript.inlayHints.propertyDeclarationTypes.enabled": {
"type": "boolean",
"default": false,
"description": "%configuration.inlayHints.propertyDeclarationTypes.enabled%",
"markdownDescription": "%configuration.inlayHints.propertyDeclarationTypes.enabled%",
"scope": "resource"
},
"javascript.inlayHints.functionLikeReturnTypes.enabled": {
"type": "boolean",
"default": false,
"description": "%configuration.inlayHints.functionLikeReturnTypes.enabled%",
"markdownDescription": "%configuration.inlayHints.functionLikeReturnTypes.enabled%",
"scope": "resource"
},
"javascript.inlayHints.enumMemberValues.enabled": {
"type": "boolean",
"default": false,
"description": "%configuration.inlayHints.enumMemberValues.enabled%",
"markdownDescription": "%configuration.inlayHints.enumMemberValues.enabled%",
"scope": "resource"
},
"javascript.suggest.includeCompletionsForImportStatements": {

View file

@ -77,13 +77,13 @@
"inlayHints.parameterNames.none": "Disable parameter name hints.",
"inlayHints.parameterNames.literals": "Enable parameter name hints only for literal arguments.",
"inlayHints.parameterNames.all": "Enable parameter name hints for literal and non-literal arguments.",
"configuration.inlayHints.parameterNames.enabled": "Enable/disable inlay hints for parameter names. Requires using TypeScript 4.4+ in the workspace.",
"configuration.inlayHints.parameterNames.enabled": "Enable/disable inlay hints for parameter names:\n```\n\nparseInt(/* str: */ '123', /* radix: */ 8)\n \n```\nRequires using TypeScript 4.4+ in the workspace.",
"configuration.inlayHints.parameterNames.suppressWhenArgumentMatchesName": "Suppress parameter name hints on arguments whose text is identical to the parameter name.",
"configuration.inlayHints.parameterTypes.enabled": "Enable/disable inlay hints for parameter types. Requires using TypeScript 4.4+ in the workspace.",
"configuration.inlayHints.variableTypes.enabled": "Enable/disable inlay hints for variable types. Requires using TypeScript 4.4+ in the workspace.",
"configuration.inlayHints.propertyDeclarationTypes.enabled": "Enable/disable inlay hints for property declarations. Requires using TypeScript 4.4+ in the workspace.",
"configuration.inlayHints.functionLikeReturnTypes.enabled": "Enable/disable inlay hints for return type for function signatures. Requires using TypeScript 4.4+ in the workspace.",
"configuration.inlayHints.enumMemberValues.enabled": "Enable/disable inlay hints for enum member values. Requires using TypeScript 4.4+ in the workspace.",
"configuration.inlayHints.parameterTypes.enabled": "Enable/disable inlay hints for implicit parameter types:\n```\n\nel.addEventListener('click', e /* :MouseEvent */ => ...)\n \n```\nRequires using TypeScript 4.4+ in the workspace.",
"configuration.inlayHints.variableTypes.enabled": "Enable/disable inlay hints for implicit variable types:\n```\n\nconst foo /* :number */ = Date.now();\n \n```\nRequires using TypeScript 4.4+ in the workspace.",
"configuration.inlayHints.propertyDeclarationTypes.enabled": "Enable/disable inlay hints for implicit types on property declarations:\n```\n\nclass Foo {\n\tprop /* :number */ = Date.now;\n}\n \n```\nRequires using TypeScript 4.4+ in the workspace.",
"configuration.inlayHints.functionLikeReturnTypes.enabled": "Enable/disable inlay hints for implicit return types on function signatures:\n```\n\nfunction foo() /* :number */ {\n\treturn Date.now();\n} \n \n```\nRequires using TypeScript 4.4+ in the workspace.",
"configuration.inlayHints.enumMemberValues.enabled": "Enable/disable inlay hints for enum member values:\n```\n\nenum MyValue {\n\tA /* = 0 */;\n\tB /* = 1 */;\n}\n \n```\nRequires using TypeScript 4.4+ in the workspace.",
"taskDefinition.tsconfig.description": "The tsconfig file that defines the TS build.",
"javascript.suggestionActions.enabled": "Enable/disable suggestion diagnostics for JavaScript files in the editor.",
"typescript.suggestionActions.enabled": "Enable/disable suggestion diagnostics for TypeScript files in the editor.",