Add stan setting to output static analysis report (#384)

Author: shivaraj-bh

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 - Enhancements
   - Support `meta.description` in flake apps. Requires newer version of flake-parts.
+  - `settings` module:
+    - #384: Add `stan`
 
 ## 0.5.0 (Jun 24, 2024)
 

doc/settings.md

@@ -70,3 +70,13 @@ Newer versions of [nixpkgs] provide `buildFromSdist` to build your package from
 > If you encounter issues with `buildFromSdist` you can disable it by setting `settings.<name>.buildFromSdist` to `true`.
 
 [nixpkgs]: https://nixos.asia/en/nixpkgs
+
+### `stan`
+
+Run **ST**atic **AN**alysis on the package using [stan] and generate an HTML report. The report is created in the `/nix/store` path alongside your package outputs.
+
+> [!note] stan configuration  
+> This setting looks for a `.stan.toml` file in the root of the package source. See a sample [.stan.toml] configuration for reference.
+
+[stan]: https://github.com/kowainik/stan
+[.stan.toml]: https://github.com/kowainik/stan/blob/main/.stan.toml

nix/modules/project/settings/all.nix

@@ -1,4 +1,4 @@
-{ name, pkgs, lib, config, log, ... }:
+{ name, pkgs, self, lib, config, log, ... }:
 let
   inherit (lib) types;
   inherit (import ./lib.nix {
@@ -347,6 +347,32 @@ in
         });
     };
 
+    stan = {
+      type = types.bool;
+      description = ''
+        Modifies the Haskell package to generate a static analysis report using <https://github.com/kowainik/stan>.
+      '';
+      impl = enable: drv:
+        let
+          inherit (pkgs.haskell.lib.compose) appendConfigureFlags addBuildTool;
+        in
+        if enable then
+          lib.pipe drv [
+            (appendConfigureFlags [ "--ghc-options=-fwrite-ide-info" "--ghc-options=-hiedir=.hie" ])
+            (addBuildTool self.stan)
+            (drv:
+              drv.overrideAttrs (old: {
+                postInstall = (old.postInstall or "") + ''
+                  echo "Generating stan.html"
+                  cd $out
+                  stan report --hiedir $OLDPWD --config-file $OLDPWD/.stan.toml
+                  echo "Finished generating stan.html"
+                '';
+              }))
+          ]
+        else drv;
+    };
+
     # When none of the above settings is suitable:
     custom = {
       type = types.functionTo types.package;

test/simple/flake.nix

@@ -51,6 +51,8 @@
               jailbreak = true;
               cabalFlags.blah = true;
             };
+            # Test STatic ANalysis report generation
+            haskell-flake-test.stan = true;
           };
           devShell = {
             tools = hp: {