Skip to content

Commit a00e035

Browse files
committed
chore: update docs
1 parent 20ccacf commit a00e035

File tree

1 file changed

+205
-2
lines changed

1 file changed

+205
-2
lines changed

docs/src/modules_schema.md

Lines changed: 205 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,69 @@ Lowest priority: `1`.
269269

270270
- [nix/commands/nestedOptions.nix](https://github.com/numtide/devshell/tree/main/nix/commands/nestedOptions.nix)
271271

272+
### `commands.<name>.*.interpolate (nestedOptions)`
273+
274+
When `true`, shell variables in `help (flatOptions)`
275+
can be interpolated.
276+
277+
Priority of this option when selecting `interpolate (flatOptions)`: `1`.
278+
279+
Lowest priority: `1`.
280+
281+
**Type**:
282+
283+
```console
284+
null or boolean
285+
```
286+
287+
**Default value**:
288+
289+
```nix
290+
null
291+
```
292+
293+
**Example value**:
294+
295+
```nix
296+
true
297+
```
298+
299+
**Declared in**:
300+
301+
- [nix/commands/nestedOptions.nix](https://github.com/numtide/devshell/tree/main/nix/commands/nestedOptions.nix)
302+
303+
### `commands.<name>.*.interpolates (nestedOptions)`
304+
305+
A leaf value is used as `interpolate (flatOptions)`
306+
for `package (flatOptions)` or `command (flatOptions)`
307+
with a matching path in `packages (nestedOptions)` or `commands (nestedOptions)`.
308+
309+
Priority of this option when selecting `interpolate (flatOptions)`: `2`.
310+
311+
Lowest priority: `1`.
312+
313+
**Type**:
314+
315+
```console
316+
(nested (max depth is 100) attribute set of boolean)
317+
```
318+
319+
**Default value**:
320+
321+
```nix
322+
{ }
323+
```
324+
325+
**Example value**:
326+
327+
```nix
328+
true
329+
```
330+
331+
**Declared in**:
332+
333+
- [nix/commands/nestedOptions.nix](https://github.com/numtide/devshell/tree/main/nix/commands/nestedOptions.nix)
334+
272335
### `commands.<name>.*.prefix (nestedOptions)`
273336

274337
Can be used as `prefix (flatOptions)` for all
@@ -462,6 +525,35 @@ null
462525

463526
- [nix/commands/flatOptions.nix](https://github.com/numtide/devshell/tree/main/nix/commands/flatOptions.nix)
464527

528+
### `commands.<name>.*.interpolate (flatOptions)`
529+
530+
When `true` or when `null` and `devshell.menu.interpolate` is `true`, shell variables in `help (flatOptions)`
531+
will be interpolated.
532+
533+
Otherwise, they will not.
534+
535+
**Type**:
536+
537+
```console
538+
null or boolean
539+
```
540+
541+
**Default value**:
542+
543+
```nix
544+
null
545+
```
546+
547+
**Example value**:
548+
549+
```nix
550+
true
551+
```
552+
553+
**Declared in**:
554+
555+
- [nix/commands/flatOptions.nix](https://github.com/numtide/devshell/tree/main/nix/commands/flatOptions.nix)
556+
465557
### `commands.<name>.*.name (flatOptions)`
466558

467559
Name of the command.
@@ -473,7 +565,8 @@ The value of this option is required for `command (flatOptions)`.
473565
**Type**:
474566

475567
```console
476-
null or string
568+
null or string matching [^$
569+
]+
477570
```
478571

479572
**Default value**:
@@ -704,6 +797,35 @@ null
704797

705798
- [nix/commands/flatOptions.nix](https://github.com/numtide/devshell/tree/main/nix/commands/flatOptions.nix)
706799

800+
### `commands.*.interpolate (flatOptions)`
801+
802+
When `true` or when `null` and `devshell.menu.interpolate` is `true`, shell variables in `help (flatOptions)`
803+
will be interpolated.
804+
805+
Otherwise, they will not.
806+
807+
**Type**:
808+
809+
```console
810+
null or boolean
811+
```
812+
813+
**Default value**:
814+
815+
```nix
816+
null
817+
```
818+
819+
**Example value**:
820+
821+
```nix
822+
true
823+
```
824+
825+
**Declared in**:
826+
827+
- [nix/commands/flatOptions.nix](https://github.com/numtide/devshell/tree/main/nix/commands/flatOptions.nix)
828+
707829
### `commands.*.name (flatOptions)`
708830

709831
Name of the command.
@@ -715,7 +837,8 @@ The value of this option is required for `command (flatOptions)`.
715837
**Type**:
716838

717839
```console
718-
null or string
840+
null or string matching [^$
841+
]+
719842
```
720843

721844
**Default value**:
@@ -851,6 +974,86 @@ true
851974

852975
- [modules/devshell.nix](https://github.com/numtide/devshell/tree/main/modules/devshell.nix)
853976

977+
### `devshell.menu`
978+
979+
Controls devshell menu
980+
981+
**Type**:
982+
983+
```console
984+
submodule
985+
```
986+
987+
**Default value**:
988+
989+
```nix
990+
{ }
991+
```
992+
993+
**Example value**:
994+
995+
```nix
996+
{
997+
interpolate = true;
998+
width = 75;
999+
}
1000+
```
1001+
1002+
**Declared in**:
1003+
1004+
- [modules/devshell.nix](https://github.com/numtide/devshell/tree/main/modules/devshell.nix)
1005+
1006+
### `devshell.menu.interpolate`
1007+
1008+
Whether to enable interpolation in the devshell menu.
1009+
**Type**:
1010+
1011+
```console
1012+
boolean
1013+
```
1014+
1015+
**Default value**:
1016+
1017+
```nix
1018+
false
1019+
```
1020+
1021+
**Example value**:
1022+
1023+
```nix
1024+
true
1025+
```
1026+
1027+
**Declared in**:
1028+
1029+
- [modules/devshell.nix](https://github.com/numtide/devshell/tree/main/modules/devshell.nix)
1030+
1031+
### `devshell.menu.width`
1032+
1033+
Width of the devshell message.
1034+
1035+
**Type**:
1036+
1037+
```console
1038+
positive integer or floating point number, meaning >0
1039+
```
1040+
1041+
**Default value**:
1042+
1043+
```nix
1044+
75
1045+
```
1046+
1047+
**Example value**:
1048+
1049+
```nix
1050+
75
1051+
```
1052+
1053+
**Declared in**:
1054+
1055+
- [modules/devshell.nix](https://github.com/numtide/devshell/tree/main/modules/devshell.nix)
1056+
8541057
### `devshell.meta`
8551058

8561059
Metadata, such as 'meta.description'. Can be useful as metadata for downstream tooling.

0 commit comments

Comments
 (0)