Merge pull request #948 from IntersectMBO/output-ts-to-file-instead-of-stdout

Output typescript declaration to a file instead of standard output

Author: palas

cardano-wasm/app/Main.hs

@@ -2,7 +2,26 @@ module Main where
 
 import Cardano.Wasm.Internal.Api.Info (apiInfo)
 import Cardano.Wasm.Internal.Api.InfoToTypeScript (apiInfoToTypeScriptFile)
-import Cardano.Wasm.Internal.Api.TypeScriptDefs (printTypeScriptFile)
+import Cardano.Wasm.Internal.Api.TypeScriptDefs (writeTypeScriptToDir)
+
+import Options.Applicative
+
+newtype CmdArgs
+  = CmdArgs {outputDir :: String}
+
+parser :: Parser CmdArgs
+parser =
+  CmdArgs
+    <$> strOption
+      ( mconcat
+          [ long "output-dir"
+          , short 'o'
+          , metavar "OUTPUT_DIR"
+          , help "Output directory for the TypeScript declaration files (it must exist)"
+          ]
+      )
 
 main :: IO ()
-main = printTypeScriptFile (apiInfoToTypeScriptFile apiInfo)
+main = do
+  cmdArgs <- execParser (info (parser <**> helper) fullDesc)
+  writeTypeScriptToDir (outputDir cmdArgs) (apiInfoToTypeScriptFile apiInfo)

cardano-wasm/cardano-wasm.cabal

@@ -63,7 +63,9 @@ executable cardano-wasm
     cardano-strict-containers,
     containers,
     exceptions,
+    filepath,
     microlens,
+    optparse-applicative,
     text,
 
   if arch(wasm32)
@@ -80,6 +82,7 @@ test-suite cardano-wasm-golden
   if !arch(wasm32)
     import: project-config
     build-depends:
+      filepath,
       hedgehog >=1.1,
       hedgehog-extras ^>=0.8,
       tasty,

cardano-wasm/lib-wrapper/cardano-api.d.ts

@@ -207,4 +207,3 @@ declare interface CardanoApi {
      */
     restoreTestnetPaymentWalletFromSigningKeyBech32(networkMagic: number, signingKeyBech32: string): Promise<Wallet>;
 }
-

cardano-wasm/src/Cardano/Wasm/Internal/Api/TypeScriptDefs.hs

@@ -16,12 +16,15 @@ module Cardano.Wasm.Internal.Api.TypeScriptDefs where
 import Data.List.NonEmpty qualified as LNE
 import Data.Text.Lazy qualified as TL
 import Data.Text.Lazy.Builder qualified as TLB
+import Data.Text.Lazy.IO qualified as TL
+import System.FilePath ((</>))
 
--- | Prints the TypeScript declaration file to stdout.
-printTypeScriptFile :: TypeScriptFile -> IO ()
-printTypeScriptFile tsFile = do
+-- | Output the TypeScript declaration files to the specified directory.
+writeTypeScriptToDir :: FilePath -> TypeScriptFile -> IO ()
+writeTypeScriptToDir dir tsFile = do
   let content = buildTypeScriptFile tsFile
-  putStrLn $ TL.unpack $ TLB.toLazyText content
+      filePath = dir </> typeScriptFileName tsFile
+  TL.writeFile filePath (TLB.toLazyText content)
 
 -- | Creates a builder for a JavaScript-style multiline comment
 -- with the specified indentation level (in spaces) and each line

cardano-wasm/test/cardano-wasm-golden/Test/Golden/Cardano/Wasm/TypeScript.hs

@@ -1,10 +1,27 @@
 module Test.Golden.Cardano.Wasm.TypeScript where
 
+import Control.Monad (forM_)
+import Control.Monad.IO.Class qualified as H
+import System.FilePath ((</>))
+
 import Hedgehog as H
+import Hedgehog.Extras (workspace)
 import Hedgehog.Extras qualified as H
 
 hprop_cardano_wasm_typescript_declarations_match_generated :: Property
 hprop_cardano_wasm_typescript_declarations_match_generated =
   H.propertyOnce $ do
-    result <- H.execFlex "cardano-wasm" "CARDANO_WASM" []
-    H.diffVsGoldenFile result "lib-wrapper/cardano-api.d.ts"
+    workspace "cardano-wasm-ts-decls" $ \workDir -> do
+      dir <- H.createDirectoryIfMissing (workDir </> "lib-wrapper")
+      _ <- H.execFlex "cardano-wasm" "CARDANO_WASM" ["--output-dir", dir]
+      forFilesInDir dir $ \file -> do
+        H.annotate (dir </> file)
+        H.diffFileVsGoldenFile (dir </> file) ("lib-wrapper" </> file)
+
+forFilesInDir :: (H.MonadTest m, H.MonadIO m) => FilePath -> (FilePath -> m ()) -> m ()
+forFilesInDir dir action = do
+  files <- H.listDirectory dir
+  forM_ files $ \file -> do
+    let fullPath = dir </> file
+    H.assertFileExists fullPath
+    action file