Add generateOptparseApplicativeCompletions setting

Author: jian-lin

CHANGELOG.md

@@ -9,6 +9,7 @@
   - `settings` module:
     - #384: Add `stan`
     - #419, #421: Add `installIntermediates`, `previousIntermediates` and `separateIntermediatesOutput`
+    - #427: Add `generateOptparseApplicativeCompletions`
 
 ## 0.5.0 (Jun 24, 2024)
 

doc/settings.md

@@ -53,6 +53,12 @@ You can provide custom settings for use in multiple packages (even across multip
 
 haskell-flake provides the following settings on top of those provided by [nixpkgs].
 
+### `generateOptparseApplicativeCompletions`
+
+Generate and install shell completion files for executables.
+The executables need to be using `optparse-applicative` for this to work.
+Note that this feature is automatically disabled when cross-compiling, since it requires executing the binaries in question.
+
 ### `removeReferencesTo`
 
 Remove references to other packages from this Haskell package. This is useful to eliminate unnecessary data dependencies from your Haskell executable so as to reduce its closure size.

nix/modules/project/settings/all.nix

@@ -327,6 +327,16 @@ in
           ]) else null;
     };
 
+    generateOptparseApplicativeCompletions = {
+      type = types.listOf types.str;
+      description = ''
+        Generate and install shell completion files for executables.
+        The executables need to be using `optparse-applicative` for this to work.
+        Note that this feature is automatically disabled when cross-compiling, since it requires executing the binaries in question.
+      '';
+      impl = self.generateOptparseApplicativeCompletions;
+    };
+
     removeReferencesTo = {
       type = types.listOf types.package;
       description = ''