f34ce41345
GitOrigin-RevId: b73c2221a46c13557b1b3be9c2070cc42cf01eb3 |
||
---|---|---|
.. | ||
_maintainers | ||
asciidoctor.asciidoctor-vscode | ||
azdavis.millet | ||
b4dm4n.vscode-nixpkgs-fmt | ||
betterthantomorrow.calva | ||
charliermarsh.ruff | ||
chenglou92.rescript-vscode | ||
contextmapper.context-mapper-vscode-extension | ||
equinusocio.vsc-material-theme | ||
eugleo.magic-racket | ||
foxundermoon.shell-format | ||
hashicorp.terraform | ||
jackmacwindows.craftos-pc | ||
jebbs.plantuml | ||
kamadorueda.alejandra | ||
ms-dotnettools.csdevkit | ||
ms-dotnettools.csharp | ||
ms-python.python | ||
ms-python.vscode-pylance | ||
ms-toolsai.jupyter | ||
ms-vscode-remote.remote-ssh | ||
ms-vscode.cpptools | ||
ms-vsliveshare.vsliveshare | ||
myriad-dreamin.tinymist | ||
nvarner.typst-lsp | ||
reditorsupport.r | ||
rust-lang.rust-analyzer | ||
sourcery.sourcery | ||
sumneko.lua | ||
tekumara.typos-vscode | ||
timonwong.shellcheck | ||
vadimcn.vscode-lldb | ||
WakaTime.vscode-wakatime | ||
default.nix | ||
language-packs.nix | ||
mktplcExtRefToFetchArgs.nix | ||
README.md | ||
update_installed_exts.sh | ||
updateSettings.nix | ||
updateSettingsTest.nix | ||
vscode-utils.nix | ||
vscodeEnv.nix | ||
vscodeEnvTest.nix | ||
vscodeExts2nix.nix | ||
vscodeWithConfiguration.nix |
Visual Studio Code Extensions
Conventions for adding new extensions
-
Extensions are named in the lowercase version of the extension's unique identifier. Which is found on the marketplace extension page, and is the name under which the extension is installed by VSCode under
~/.vscode
. Extension location should be: ${lib.strings.toLower mktplcRef.publisher}.${lib.string.toLower mktplcRef.name} -
Move extension to a discrete directory whenever the extension needs extra parameters/packages (at top of the file) or other files (such as patches, update script, components). Global index file parameters/packages should be utilities shared by many extensions. Extension specific parameters/packages should not be in the global index page.
-
Currently
nixfmt-rfc-style
formatter is being used to format the VSCode extensions. -
Respect
alphabetical order
whenever adding extensions. On disorder, please, kindly open a PR re-establishing the order. -
Avoid unnecessary use of
with
, particularlynested with
. -
Use
hash
instead ofsha256
. -
On
meta
field:- add a
changelog
. description
should mention it is a Visual Studio Code extension.downloadPage
is the VSCode marketplace URL.homepage
is the source-code URL.maintainers
:- optionally consider adding yourself as a maintainer to be notified of updates, breakages and help with upkeep.
- recommended format is:
- a
non-nested with
, such as:with lib.maintainers; [ your-username ];
. - maintainers are listed in alphabetical order.
- a
- verify
license
in upstream.
- add a
-
On commit messages:
- Naming convention for:
-
Adding a new extension:
vscode-extensions.publisher.extension-name: init 1.2.3
Release: https://github.com/owner/project/releases/tag/1.2.3
-
Updating an extension:
vscode-extensions.publisher.extension-name: 1.2.3 -> 2.3.4
Release: https://github.com/owner/project/releases/tag/2.3.4
-
- Multiple extensions can be added in a single PR, but each extension requires it's own commit.
- Naming convention for: