make the zhs autocompletion more dynamic

Signed-off-by: Zen <[email protected]>

Author: desultory

completion/_ugrd

@@ -1,36 +1,22 @@
 #compdef ugrd
 
-_arguments \
-    '--build-logging[Enable additional build logging.]' \
-    '--no-build-logging[Disable additional build logging.]' \
-    '-c[Config file location.]:config file:_files' \
-    '--config[Config file location.]:config file:_files' \
-    '--kernel-version[Set the kernel version.]:kernel version:_files -W /lib/modules -/' \
-    '--kver[Set the kernel version.]:kernel version:_files -W /lib/modules -/' \
-    '--clean[Enable build directory cleaning.]' \
-    '--no-clean[Disable build directory cleaning.]' \
-    '--validate[Enable config validation.]' \
-    '--no-validate[Disable config validation.]' \
-    '--hostonly[Enable hostonly mode, required for automatic kmod detection.]' \
-    '--no-hostonly[Disable hostonly mode.]' \
-    '--lspci[Use lspci to auto-detect kmods]' \
-    '--no-lspci[Do not use lspci to auto-detect kmods]' \
-    '--lsmod[Use lsmod to auto-detect kmods]' \
-    '--no-lsmod[Do not use lsmod to auto-detect kmods]' \
-    '--firmware[Include firmware files found with modinfo.]' \
-    '--no-firmware[Exclude firmware files.]' \
-    '--autodetect-root[Autodetect the root partition.]' \
-    '--no-autodetect-root[Do not autodetect the root partition.]' \
-    '--autodetect-root-luks[Autodetect LUKS volumes under the root partition.]' \
-    '--no-autodetect-root-luks[Do not autodetect root LUKS volumes.]' \
-    '--print-config[Print the final config dict.]' \
-    '-d[Debug mode.]' \
-    '--debug[Debug mode.]' \
-    '--help[Show help information.]' \
-    '-h[Show help information.]' \
-    '-dd[Verbose debug mode.]' \
-    '--verbose[Verbose debug mode.]' \
-    '--log-file[Specify a log file.]' \
-    '--log-level[Specify log level.]' \
-    '-v[Show version information.]' \
-    '--version[Show version information.]'
+# Read over each line of the output of ug --dump_args
+# split the line after the first space
+# the first part is the option, the second part is the description
+base_args=()
+while read -r line; do
+	option=$(echo $line | cut -d' ' -f1)
+	description=$(echo $line | cut -d' ' -f2-)
+	base_args+=("${option}[$description]")
+done <<< "$(ugrd --dump_args)"
+
+args=("-c[Config file location.]:config file:_files"
+	"--config[Config file location.]:config file:_files"
+	"--kernel-version[Set the kernel version.]:kernel version:_files -W /lib/modules -/"
+	"--kver[Set the kernel version.]:kernel version:_files -W /lib/modules -/"
+	"--log-file[Specify a log file.]"
+	"--log-level[Specify log level.]")
+
+args+=($base_args[@])
+
+_arguments "${args[@]}"

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ugrd"
-version = "1.3.4"
+version = "1.3.5"
 authors = [
   { name="Desultory", email="[email protected]" },
 ]
@@ -18,7 +18,7 @@ classifiers = [
 ]
 
 dependencies = [
-    "zenlib >= 2.0.4",
+    "zenlib >= 2.1.0",
     "pycpio >= 1.0.0"
 ]
 

readme.md

@@ -30,16 +30,17 @@ The original goal of this project was to create an initramfs suitable for decryp
   - Allows for late insertion of a smartcard
   - Can fail back to plain password entry
 * Auto-detection and validation of the root mount using `/proc/mounts`
-* Auto-detection and validation of LUKS root mounts.
-* Auto-detection and validation of the btrfs subvolume used for the root mount, if present.
-* Dynamic BTRFS subvolume selection at boot time using `subvol_selector`.
+* Auto-detection and validation of LUKS root mounts
+* Auto-detection and validation of the btrfs subvolume used for the root mount, if present
+* Dynamic BTRFS subvolume selection at boot time using `subvol_selector`
 * Auto-detection of kernel modules using `lspci` and `lsmod`
 * Reading the `root` and `rootflags` parameters from the kernel commandline
   - Falls back to host mount config if cmdline mount parameters fail
 * Key entry over serial
 * Automatic CPIO generation (PyCPIO)
-  - Device nodes are created within the CPIO only, so true root privileges are not required.
-  - Hardlinks are automatically created for files with matching SHA256 hashes.
+  - Device nodes are created within the CPIO only, so true root privileges are not required
+  - Hardlinks are automatically created for files with matching SHA256 hashes
+* ZSH and BASH autocompletion for the ugrd command
 * Similar usage/arguments as Dracut
 
 ### Operating system support

src/ugrd/main.py

@@ -15,18 +15,18 @@ def main():
                  {'flags': ['--no-validate'], 'action': 'store_false', 'help': 'Disable config validation.', 'dest': 'validate'},
                  {'flags': ['--hostonly'], 'action': 'store_true', 'help': 'Enable hostonly mode, required for automatic kmod detection.'},
                  {'flags': ['--no-hostonly'], 'action': 'store_false', 'help': 'Disable hostonly mode.', 'dest': 'hostonly'},
-                 {'flags': ['--lspci'], 'action': 'store_true', 'help': 'Use lspci to auto-detect kmods', 'dest': 'kmod_autodetect_lspci'},
-                 {'flags': ['--no-lspci'], 'action': 'store_false', 'help': 'Do not use lspci to auto-detect kmods', 'dest': 'kmod_autodetect_lspci'},
-                 {'flags': ['--lsmod'], 'action': 'store_true', 'help': 'Use lsmod to auto-detect kmods', 'dest': 'kmod_autodetect_lsmod'},
-                 {'flags': ['--no-lsmod'], 'action': 'store_false', 'help': 'Do not use lsmod to auto-detect kmods', 'dest': 'kmod_autodetect_lsmod'},
+                 {'flags': ['--lspci'], 'action': 'store_true', 'help': 'Use lspci to auto-detect kmods.', 'dest': 'kmod_autodetect_lspci'},
+                 {'flags': ['--no-lspci'], 'action': 'store_false', 'help': 'Do not use lspci to auto-detect kmods.', 'dest': 'kmod_autodetect_lspci'},
+                 {'flags': ['--lsmod'], 'action': 'store_true', 'help': 'Use lsmod to auto-detect kmods.', 'dest': 'kmod_autodetect_lsmod'},
+                 {'flags': ['--no-lsmod'], 'action': 'store_false', 'help': 'Do not use lsmod to auto-detect kmods.', 'dest': 'kmod_autodetect_lsmod'},
                  {'flags': ['--firmware'], 'action': 'store_true', 'help': 'Include firmware files found with modinfo.', 'dest': 'kmod_pull_firmware'},
                  {'flags': ['--no-firmware'], 'action': 'store_false', 'help': 'Exclude firmware files.', 'dest': 'kmod_pull_firmware'},
                  {'flags': ['--autodetect-root'], 'action': 'store_true', 'help': 'Autodetect the root partition.'},
                  {'flags': ['--no-autodetect-root'], 'action': 'store_false', 'help': 'Do not autodetect the root partition.', 'dest': 'autodetect_root'},
                  {'flags': ['--autodetect-root-luks'], 'action': 'store_true', 'help': 'Autodetect LUKS volumes under the root partition.'},
                  {'flags': ['--no-autodetect-root-luks'], 'action': 'store_false', 'help': 'Do not autodetect root LUKS volumes.', 'dest': 'autodetect_root_luks'},
                  {'flags': ['--print-config'], 'action': 'store_true', 'help': 'Print the final config dict.'},
-                 {'flags': ['out_file'], 'action': 'store', 'help': 'Output file location', 'nargs': '?'}]
+                 {'flags': ['out_file'], 'action': 'store', 'help': 'Output file location.', 'nargs': '?'}]
 
     args, logger = get_args_n_logger(package=__package__, description='MicrogRAM disk initramfs generator', arguments=arguments, drop_default=True)
     kwargs = get_kwargs_from_args(args, logger=logger)