Skip to content

Add VSCode enhancements #15455

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.

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

Merged
merged 1 commit into from
Jul 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .vscode/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# .vscode

This directory contains files to make authoring Pulumi docs changes easier in VSCode:

* `markdown.code-snippets` contains VSCode snippets for the more common shortcodes used in the Pulumi Hugo site.
* `settings.json` contains project-wide VSCode settings that should be followed by all users:
* Formatting Markdown file on save is disabled because our current Markdown standards are not followed by the Format on Save command. We intend to ensure our rules are portable between Format on Save, our linting, and our implicit standards in our existing docs in the future, but until then we need to disable Format on Save in order to prevent incorrect formatting (per our standards).
44 changes: 44 additions & 0 deletions .vscode/markdown.code-snippets
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
// Place your snippets for markdown here. Each snippet is defined under a snippet name and has a prefix, body and
// description. The prefix is what is used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. Placeholders with the
// same ids are connected.
// Example:
// "Print to console": {
// "prefix": "log",
// "body": [
// "console.log('$1');",
// "$2"
// ],
// "description": "Log output to console"
// }
"chooser": {
"prefix": "chooser",
"body": [
"{% chooser language \"typescript,python,go,csharp,java,yaml\" / %}}",
"{{% choosable language typescript %}}",
"{{% /choosable %}}",
"{{% choosable language python %}}",
"{{% /choosable %}}",
"{{% choosable language go %}}",
"{{% /choosable %}}",
"{{% choosable language csharp %}}",
"{{% /choosable %}}",
"{{% choosable language java %}}",
"{{% /choosable %}}",
"{{% choosable language yaml %}}",
"{{% /choosable %}}",
"{{% /chooser %}}"
],
"description": "Language chooser for code samples"
},
"notes": {
"prefix": "notes",
"body": [
"{{% notes type=\"info\" %}}",
"TODO",
"{{% /notes % }}",
],
"description": "Notes callout field. Type can be any of the following: info, warning, tip"
}
}
Loading