technofab/soonix
1
0
Fork 0
mirror of https://gitlab.com/TECHNOFAB/soonix.git synced 2025-12-11 22:00:05 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add initial docs base

Browse source
This commit is contained in:
technofab 2025-08-27 11:22:26 +02:00
parent af1494f3c6
commit ed75ed6695
No known key found for this signature in database
8 changed files with 124 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

26
lib/module.nix
View file

@ -24,24 +24,24 @@ in {
output = mkOption {
type = types.str;
description = "The relative path where the generated file should be placed";
description = "The relative path where the generated file should be placed.";
};
generator = mkOption {
type = types.enum ["nix" "string" "derivation" "gotmpl" "jinja" "template"];
description = "Which engine to use for content generation";
description = "Which engine to use for content generation.";
default = "nix";
};
data = mkOption {
type = types.anything;
description = "The input data for the chosen generator";
description = "The input data for the chosen generator.";
};
opts = mkOption {
type = types.attrs;
default = {};
description = "Generator-specific options";
description = "Generator-specific options.";
};
hook = mkOption {
@ -50,31 +50,31 @@ in {
mode = mkOption {
type = types.enum ["link" "copy"];
default = "link";
description = "How the file should be managed (link or copy)";
description = "How the file should be managed (link or copy).";
};
gitignore = mkOption {
type = types.bool;
default = true;
description = "Whether to add the output path to .gitignore";
description = "Whether to add the output path to .gitignore.";
};
extra = mkOption {
type = types.str;
default = "";
description = "Additional bash commands to execute after file operation";
description = "Additional bash commands to execute after file operation.";
};
};
};
default = {};
description = "Hook-specific options for file management";
description = "Hook-specific options.";
};
generatedDerivation = mkOption {
type = types.package;
internal = true;
readOnly = true;
description = "The generated derivation for this file";
description = "The generated derivation for this file.";
};
};
@ -87,24 +87,24 @@ in {
};
}));
default = {};
description = "Configuration hooks for file generation and management";
description = "Configuration of the hooks.";
};
shellHook = mkOption {
type = types.str;
readOnly = true;
description = "Generated shell hook script for managing all files";
description = "Generated shell hook script (as a string) for managing all files (readonly).";
};
shellHookFile = mkOption {
type = types.package;
readOnly = true;
description = "Generated shell hook script for managing all files";
description = "Generated shell hook script for managing all files (readonly).";
};
finalFiles = mkOption {
type = types.package;
readOnly = true;
description = "Aggregated derivation containing all managed files";
description = "Aggregated derivation containing all managed files (readonly).";
};
};