Options

devshellModule

Devshell module with automatically configured hooks, just import and you're good to go. (readonly)

Type:

attribute set

Declared in:

• module.nix

finalFiles

Aggregated derivation containing all managed files. (readonly)

Type:

package

Declared in:

• module.nix

hooks

Configuration of the hooks.

Type:

attribute set of (submodule)

Default value:

{ }

Declared in:

• module.nix

hooks.<name>.data

The input data for the chosen generator.

Type:

anything

Declared in:

• module.nix

hooks.<name>.generator

Which engine to use for content generation.

Type:

one of "nix", "string", "derivation", "gotmpl", "jinja", "template"

Default value:

"nix"

Declared in:

• module.nix

hooks.<name>.hook

Hook-specific options.

Type:

submodule

Default value:

{ }

Declared in:

• module.nix

hooks.<name>.hook.extra

Additional bash commands to execute after file operation.

Type:

string

Default value:

""

Declared in:

• module.nix

hooks.<name>.hook.gitignore

Whether to add the output path to .gitignore.

Type:

boolean

Default value:

true

Declared in:

• module.nix

hooks.<name>.hook.mode

How the file should be managed (link or copy).

Type:

one of "link", "copy"

Default value:

"link"

Declared in:

• module.nix

hooks.<name>.opts

Generator-specific options.

Type:

attribute set

Default value:

{ }

Declared in:

• module.nix

hooks.<name>.output

The relative path where the generated file should be placed.

Type:

string

Declared in:

• module.nix

packages

Packages for updating the hooks without a devshell. (readonly)

Type:

attribute set of package

Example value:

{
  "soonix:update" = "<derivation>";
}

Declared in:

• module.nix

shellHook

Generated shell hook script (as a string) for managing all files. (readonly)

Type:

string

Declared in:

• module.nix

shellHookFile

Generated shell hook script for managing all files. (readonly)

Type:

package

Declared in:

• module.nix