mirror of
https://github.com/NixOS/nixpkgs.git
synced 2026-10-03 21:40:12 +00:00
2b115ef0cc
This completes https://github.com/NixOS/nixpkgs/issues/425583. Rather than putting `nixfmt` everywhere, I opted to teach people to use `treefmt` instead. This is more correct, as we have formatting rules for non-nix files, and also may invoke `nixfmt` with non-default options.
43 lines
2.0 KiB
Markdown
43 lines
2.0 KiB
Markdown
# 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 extension's marketplace 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}
|
|
|
|
* When adding a new extension, place its definition in a `default.nix` file in a directory with the extension's ID (e.g. `publisher.extension-name/default.nix`) and refer to it in `./default.nix`, e.g. `publisher.extension-name = callPackage ./publisher.extension-name { };`.
|
|
|
|
* Use `nix-shell --run treefmt` to format the VSCode extensions.
|
|
|
|
* Respect `alphabetical order` whenever adding extensions. If out of order, please kindly open a PR re-establishing the order.
|
|
|
|
* Avoid [unnecessary](https://nix.dev/guides/best-practices.html#with-scopes) use of `with`, particularly `nested with`.
|
|
|
|
* Use `hash` instead of `sha256`.
|
|
|
|
* 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.
|
|
- verify `license` in upstream.
|
|
|
|
* Commit messages:
|
|
- Naming convention for:
|
|
- Adding a new extension:
|
|
|
|
> vscode-extensions.publisher.extension-name: init at 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 its own commit.
|