Document how we obtain the name of the cabal config file.

haskell-actions · Jan 13, 2024 · fcc14da · fcc14da
1 parent b1dc5f1
commit fcc14da
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/lib/setup-haskell.js b/lib/setup-haskell.js
diff --git a/src/setup-haskell.ts b/src/setup-haskell.ts
@@ -16,6 +16,15 @@ async function cabalConfig(): Promise<string> {
     silent: true,
     listeners: {stdout: append, stderr: append}
   });
+  // The last line of the cabal help text is printing the config file, e.g.:
+  //
+  // > You can edit the cabal configuration file to set defaults:
+  // >   <<HOME>>/.cabal/config
+  //
+  // So trimming the last line will give us the name of the config file.
+  //
+  // Needless to say this is very brittle, but we secure this by a test
+  // in Cabal's testsuite.
   return out.toString().trim().split('\n').slice(-1)[0].trim();
 }