Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
deemp committed Jan 19, 2024
1 parent 70ecdd2 commit ffa33c6
Showing 1 changed file with 90 additions and 15 deletions.
105 changes: 90 additions & 15 deletions docs/src/modules_schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Add commands to the environment.
**Type**:

```console
list of (submodule)
list of ((package or string convertible to it) or (list with two elements of types: [ string (package or string convertible to it) ]) or (flatOptions))
```

**Default value**:
Expand Down Expand Up @@ -37,15 +37,42 @@ list of (submodule)

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

### `commands.*.package`
### `commands.*`

A config for a command when the `commands` option is a list.

**Type**:

```console
(package or string convertible to it) or (list with two elements of types: [ string (package or string convertible to it) ]) or (flatOptions)
```

**Example value**:

```nix
[
{
category = "scripts";
package = "black";
}
[ "[package] print hello" "hello" ]
"nodePackages.yarn"
]
```

**Declared in**:

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

### `commands.*.package (flatOptions)`

Used to bring in a specific package. This package will be added to the
environment.

**Type**:

```console
null or (package or string convertible to it)
null or (package or string convertible to it) or package
```

**Default value**:
Expand All @@ -56,12 +83,12 @@ null

**Declared in**:

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

### `commands.*.category`
### `commands.*.category (flatOptions)`

Set a free text category under which this command is grouped
and shown in the help menu.
Sets a free text category under which this command is grouped
and shown in the devshell menu.

**Type**:

Expand All @@ -77,9 +104,9 @@ string

**Declared in**:

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

### `commands.*.command`
### `commands.*.command (flatOptions)`

If defined, it will add a script with the name of the command, and the
content of this value.
Expand Down Expand Up @@ -110,9 +137,33 @@ null

**Declared in**:

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

### `commands.*.expose (flatOptions)`

### `commands.*.help`
When `true`, the `command (flatOptions)`
or the `package (flatOptions)` will be added to the environment.

Otherwise, they will not be added to the environment, but will be printed
in the devshell menu.

**Type**:

```console
boolean
```

**Default value**:

```nix
true
```

**Declared in**:

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

### `commands.*.help (flatOptions)`

Describes what the command does in one line of text.

Expand All @@ -130,11 +181,15 @@ null

**Declared in**:

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

### `commands.*.name (flatOptions)`

Name of this command.

### `commands.*.name`
Defaults to a `package (flatOptions)` name or pname if present.

Name of this command. Defaults to attribute name in commands.
The value of this option is required for a `command (flatOptions)`.

**Type**:

Expand All @@ -150,7 +205,27 @@ null

**Declared in**:

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

### `commands.*.prefix (flatOptions)`

Prefix of the command name in the devshell menu.

**Type**:

```console
string
```

**Default value**:

```nix
""
```

**Declared in**:

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

### `devshell.packages`

Expand Down

0 comments on commit ffa33c6

Please sign in to comment.