VS Code Snippets

[dviererbe]

While working on the Packaging Guide I often found myself typing boilerplate code (reStructuredText formats) over and over again. I also had to constantly look up what the exact name of glossary entries are.

Therefore I created VS Code snippets. Feel free to use them or even expand them. If you want we can even include them in the repository:

.vscode/sphinx.code-snippets:

{
	"Sphinx manpage": {
		"scope": "restructuredtext",
		"prefix": "manpage",
		"body": ":manpage:`$1`"
	},
	"Sphinx Document": {
		"scope": "restructuredtext",
		"prefix": "doc",
		"body": ":doc:`$1`"
	},
	"Sphinx Reference": {
		"scope": "restructuredtext",
		"prefix": "ref",
		"body": ":ref:`$1`"
	},
	"Sphinx Role": {
		"scope": "restructuredtext",
		"prefix": "role",
		"body": ":$1:`$2`"
	},
	"Sphinx term": {
		"scope": "restructuredtext",
		"prefix": "term",
		"body": ":term:`$1`"
	},
	"Sphinx file": {
		"scope": "restructuredtext",
		"prefix": "file",
		"body": ":file:`$1`"
	},
	"Sphinx command": {
		"scope": "restructuredtext",
		"prefix": ["command", "cmd"],
		"body": ":command:`$1`"
	},
	"Sphinx code": {
		"scope": "restructuredtext",
		"prefix": "code",
		"body": [
			".. code:: ${1:bash}",
			"",
			"    $2",
			"",		
		]
	},
	"Sphinx note": {
		"scope": "restructuredtext",
		"prefix": "note",
		"body": [
			".. note::",
			"",
			"    $1",
			"",		
		]
	},
	"Sphinx tip": {
		"scope": "restructuredtext",
		"prefix": "tip",
		"body": [
			".. tip::",
			"",
			"    $1",
			"",		
		]
	},
	"Sphinx important": {
		"scope": "restructuredtext",
		"prefix": "important",
		"body": [
			".. important::",
			"",
			"    $1",
			"",		
		]
	},
	"Sphinx caution": {
		"scope": "restructuredtext",
		"prefix": "caution",
		"body": [
			".. caution::",
			"",
			"    $1",
			"",		
		]
	},
	"Sphinx Heading 1": {
		"scope": "restructuredtext",
		"prefix": "h1",
		"body": [
			"${1:Heading 1}",
			"${1/./=/g}",
			""
		]
	},
	"Sphinx Heading 2": {
		"scope": "restructuredtext",
		"prefix": "h2",
		"body": [
			"${1:Heading 2}",
			"${1/./-/g}",
			""
		]
	},
	"Sphinx Heading 3": {
		"scope": "restructuredtext",
		"prefix": "h3",
		"body": [
			"${1:Heading 3}",
			"${1/./~/g}",
			""
		]
	},
	"Sphinx Heading 4": {
		"scope": "restructuredtext",
		"prefix": "h4",
		"body": [
			"${1:Heading 4}",
			"${1/./^/g}",
			""
		]
	},
	"Sphinx Heading 5": {
		"scope": "restructuredtext",
		"prefix": "h5",
		"body": [
			"${1:Heading 5}",
			"${1/././g}",
			""
		]
	},
	"Sphinx Tabs": {
		"scope": "restructuredtext",
		"prefix": "tabs",
		"body": [
			".. tab-set::",
			"",
			"    .. tab-item:: Label1",
			"        :sync: key1",
			"",
			"        Content",
			""
		]
	},
}

.vscode/glossary.code-snippets:

{
	"Term Archive": {
		"scope": "restructuredtext",
		"prefix": "archive",
		"body": ":term:`Ubuntu Archive`"
	},
	"Term Debian": {
		"scope": "restructuredtext",
		"prefix": "debian",
		"body": ":term:`Debian`"
	},
	"Term Launchpad": {
		"scope": "restructuredtext",
		"prefix": ["lp", "launchpad"],
		"body": ":term:`Launchpad`"
	},
	"Term Main": {
		"scope": "restructuredtext",
		"prefix": "main",
		"body": ":term:`Main`"
	},
	"Term Maintainer": {
		"scope": "restructuredtext",
		"prefix": "maintainer",
		"body": ":term:`Maintainer`"
	},
	"Term MIR": {
		"scope": "restructuredtext",
		"prefix": "mir",
		"body": ":term:`Main Inclusion Review`"
	},
	"Term Multiverse": {
		"scope": "restructuredtext",
		"prefix": "multiverse",
		"body": ":term:`Multiverse`"
	},
	"Term Open Source Software": {
		"scope": "restructuredtext",
		"prefix": "oss",
		"body": ":term:`Open Source Software`"
	},
	"Term Operating System": {
		"scope": "restructuredtext",
		"prefix": "os",
		"body": ":term:`Operating System`"
	},
	"Term orig tarball": {
		"scope": "restructuredtext",
		"prefix": "orig",
		"body": ":term:`orig tarball`"
	},
	"Term Package": {
		"scope": "restructuredtext",
		"prefix": "package",
		"body": ":term:`Package`"
	},
	"Term PPA": {
		"scope": "restructuredtext",
		"prefix": "ppa",
		"body": ":term:`Personal Package Archive`"
	},
	"Term Restricted": {
		"scope": "restructuredtext",
		"prefix": "restricted",
		"body": ":term:`Restricted`"
	},
	"Term Stable Release Update": {
		"scope": "restructuredtext",
		"prefix": "sru",
		"body": ":term:`Stable Release Update`"
	},
	"Term Ubuntu": {
		"scope": "restructuredtext",
		"prefix": "ubuntu",
		"body": ":term:`Ubuntu`"
	},
	"Term Ubuntu Delta": {
		"scope": "restructuredtext",
		"prefix": "delta",
		"body": ":term:`Ubuntu Delta`"
	},
	"Term Universe": {
		"scope": "restructuredtext",
		"prefix": "universe",
		"body": ":term:`Universe`"
	},
}

[dviererbe]

As a reference; here is the snippet documentation: https://code.visualstudio.com/docs/editor/userdefinedsnippets