treewide: update mainProgram docs
This commit is contained in:
parent
5b3975cc66
commit
61c0ecea5b
|
@ -70,7 +70,7 @@ A list of the maintainers of this Nix expression. Maintainers are defined in [`n
|
||||||
|
|
||||||
### `mainProgram` {#var-meta-mainProgram}
|
### `mainProgram` {#var-meta-mainProgram}
|
||||||
|
|
||||||
The name of the main binary for the package. This affects the binary `nix run` executes and falls back to the name of the package. Example: `"rg"`
|
The name of the main binary for the package. This affects the binary `nix run` executes. Example: `"rg"`
|
||||||
|
|
||||||
### `priority` {#var-meta-priority}
|
### `priority` {#var-meta-priority}
|
||||||
|
|
||||||
|
|
|
@ -132,10 +132,9 @@ rec {
|
||||||
{ shortName = licstr; }
|
{ shortName = licstr; }
|
||||||
);
|
);
|
||||||
|
|
||||||
/* Get the path to the main program of a derivation with either
|
/* Get the path to the main program of a package based on meta.mainProgram
|
||||||
meta.mainProgram or pname or name
|
|
||||||
|
|
||||||
Type: getExe :: derivation -> string
|
Type: getExe :: package -> string
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
getExe pkgs.hello
|
getExe pkgs.hello
|
||||||
|
|
|
@ -1,5 +1,4 @@
|
||||||
# Use this file to add `meta.mainProgram` to packages in `nodePackages`, that don't provide an
|
# Use this file to add `meta.mainProgram` to packages in `nodePackages`.
|
||||||
# executable that matches that packages name, so that they'll work with `nix run`.
|
|
||||||
{
|
{
|
||||||
# Packages that provide multiple executables where one is clearly the `mainProgram`.
|
# Packages that provide multiple executables where one is clearly the `mainProgram`.
|
||||||
"@antfu/ni" = "ni";
|
"@antfu/ni" = "ni";
|
||||||
|
@ -11,7 +10,7 @@
|
||||||
vue-cli = "vue";
|
vue-cli = "vue";
|
||||||
"@withgraphite/graphite-cli" = "gt";
|
"@withgraphite/graphite-cli" = "gt";
|
||||||
|
|
||||||
# Packages that provide a single executable whose name differs from the package's `name`.
|
# Packages that provide a single executable.
|
||||||
"@angular/cli" = "ng";
|
"@angular/cli" = "ng";
|
||||||
"@antora/cli" = "antora";
|
"@antora/cli" = "antora";
|
||||||
"@astrojs/language-server" = "astro-ls";
|
"@astrojs/language-server" = "astro-ls";
|
||||||
|
|
Loading…
Reference in a new issue