TS SDK Setup

waspc/cli/exe/Main.hs

@@ -32,6 +32,7 @@ import qualified Wasp.Cli.Command.Start.Db as Command.Start.Db
 import Wasp.Cli.Command.Studio (studio)
 import qualified Wasp.Cli.Command.Telemetry as Telemetry
 import Wasp.Cli.Command.Test (test)
+import Wasp.Cli.Command.TsConfigSetup (tsConfigSetup)
 import Wasp.Cli.Command.Uninstall (uninstall)
 import Wasp.Cli.Command.WaspLS (runWaspLS)
 import Wasp.Cli.Message (cliSendMessage)
@@ -51,6 +52,7 @@ main = withUtf8 . (`E.catch` handleInternalErrors) $ do
         ["start"] -> Command.Call.Start
         ["start", "db"] -> Command.Call.StartDb
         ["clean"] -> Command.Call.Clean
+        ["ts-setup"] -> Command.Call.TsSetup
         ["compile"] -> Command.Call.Compile
         ("db" : dbArgs) -> Command.Call.Db dbArgs
         ["uninstall"] -> Command.Call.Uninstall
@@ -102,6 +104,7 @@ main = withUtf8 . (`E.catch` handleInternalErrors) $ do
     Command.Call.Start -> runCommand start
     Command.Call.StartDb -> runCommand Command.Start.Db.start
     Command.Call.Clean -> runCommand clean
+    Command.Call.TsSetup -> runCommand tsConfigSetup
     Command.Call.Compile -> runCommand compile
     Command.Call.Db dbArgs -> dbCli dbArgs
     Command.Call.Version -> printVersion

waspc/cli/src/Wasp/Cli/Command/Call.hs

@@ -7,6 +7,7 @@ data Call
   | StartDb
   | Clean
   | Uninstall
+  | TsSetup
   | Compile
   | Db Arguments -- db args
   | Build

waspc/cli/src/Wasp/Cli/Command/Common.hs

@@ -5,8 +5,8 @@ module Wasp.Cli.Command.Common
   )
 where
 
-import Control.Monad.Except
 import qualified Control.Monad.Except as E
+import Control.Monad.IO.Class (liftIO)
 import StrongPath (Abs, Dir, Path')
 import qualified StrongPath as SP
 import StrongPath.Operations

waspc/cli/src/Wasp/Cli/Command/CreateNewProject/StarterTemplates/Templating.hs

@@ -9,6 +9,7 @@ import qualified Data.Text as T
 import StrongPath (Abs, Dir, File, Path')
 import Wasp.Cli.Command.CreateNewProject.Common (defaultWaspVersionBounds)
 import Wasp.Cli.Command.CreateNewProject.ProjectDescription (NewProjectAppName, NewProjectName)
+import Wasp.NodePackageFFI (InstallablePackage (WaspConfigPackage), getPackageInstallationPath)
 import Wasp.Project.Analyze (WaspFile (..), findWaspFile)
 import Wasp.Project.Common (WaspProjectDir)
 import Wasp.Project.ExternalConfig.PackageJson (findPackageJsonFile)
@@ -43,8 +44,16 @@ replaceTemplatePlaceholdersInPackageJsonFile appName projectName projectDir =
     Just absPackageJsonFile -> replaceTemplatePlaceholdersInFileOnDisk appName projectName absPackageJsonFile
 
 replaceTemplatePlaceholdersInFileOnDisk :: NewProjectAppName -> NewProjectName -> Path' Abs (File f) -> IO ()
-replaceTemplatePlaceholdersInFileOnDisk appName projectName =
-  updateFileContentWith (replacePlaceholders waspTemplateReplacements)
+replaceTemplatePlaceholdersInFileOnDisk appName projectName file = do
+  waspConfigPackagePath <- getPackageInstallationPath WaspConfigPackage
+  let waspTemplateReplacements =
+        [ ("__waspConfigPath__", waspConfigPackagePath),
+          ("__waspAppName__", show appName),
+          ("__waspProjectName__", show projectName),
+          ("__waspVersion__", defaultWaspVersionBounds)
+        ]
+  -- TODO: We do this in all files, but not all files have all placeholders
+  updateFileContentWith (replacePlaceholders waspTemplateReplacements) file
   where
     updateFileContentWith :: (Text -> Text) -> Path' Abs (File f) -> IO ()
     updateFileContentWith updateFn absFilePath = IOUtil.readFileStrict absFilePath >>= IOUtil.writeFileFromText absFilePath . updateFn
@@ -53,9 +62,3 @@ replaceTemplatePlaceholdersInFileOnDisk appName projectName =
     replacePlaceholders replacements content = foldl' replacePlaceholder content replacements
       where
         replacePlaceholder content' (placeholder, value) = T.replace (T.pack placeholder) (T.pack value) content'
-
-    waspTemplateReplacements =
-      [ ("__waspAppName__", show appName),
-        ("__waspProjectName__", show projectName),
-        ("__waspVersion__", defaultWaspVersionBounds)
-      ]

waspc/cli/src/Wasp/Cli/Command/TsConfigSetup.hs

@@ -0,0 +1,28 @@
+module Wasp.Cli.Command.TsConfigSetup (tsConfigSetup) where
+
+import Control.Concurrent (newChan)
+import Control.Monad.IO.Class (liftIO)
+import Wasp.Cli.Command (Command, require)
+import Wasp.Cli.Command.Require (InWaspProject (InWaspProject))
+import Wasp.Generator.NpmInstall (installProjectNpmDependencies)
+
+-- | Prepares the project for using Wasp's TypeScript SDK.
+tsConfigSetup :: Command ()
+tsConfigSetup = do
+  InWaspProject waspProjectDir <- require
+  messageChan <- liftIO newChan
+  -- TODO: Both of these should be eaiser when Miho finishes the package.json
+  -- and tsconfig.json validation:
+  -- - Edit package.json to contain the SDK package
+  -- - Adapt TSconfigs to fit with the TS SDK project structure
+  liftIO $
+    -- NOTE: We're only installing the user's package.json dependencies here
+    -- This is to provide proper IDE support for users working with the TS SDK
+    -- (it needs the `wasp-config` package).
+    -- Calling this function here shouldn't break anything for later
+    -- installations.
+    -- TODO: What about doing this during Wasp start? Can we make Wasp start
+    -- pick up whether the user wants to use the TS SDK automatically?
+    installProjectNpmDependencies messageChan waspProjectDir >>= \case
+      Left e -> putStrLn $ "npm install failed: " ++ show e
+      Right _ -> return ()

waspc/data/Cli/templates/basic/package.json

@@ -5,6 +5,7 @@
     "react": "^18.2.0"
   },
   "devDependencies": {
+    "wasp-config": "file:__waspConfigPath__",
     "typescript": "^5.1.0",
     "vite": "^4.3.9",
     "@types/react": "^18.0.37",

waspc/packages/wasp-config/.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+dist/
+.env
+.vscode/

waspc/packages/wasp-config/.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": true
+}

waspc/packages/wasp-config/eslint.config.js

@@ -0,0 +1,26 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default [
+  pluginJs.configs.recommended,
+  ...tseslint.configs.strict,
+  // Todo: explore typed-linting: https://typescript-eslint.io/getting-started/typed-linting
+  {
+    languageOptions: {
+      globals: globals.node,
+    },
+  },
+  // global ignore
+  {
+    ignores: ["node_modules/", "dist/"],
+  },
+  {
+    rules: {
+      "@typescript-eslint/no-unused-vars": "warn",
+      "@typescript-eslint/no-empty-function": "warn",
+      "no-empty": "warn",
+      "no-constant-condition": "warn",
+    },
+  },
+];

waspc/packages/wasp-config/nodemon.json

@@ -0,0 +1,6 @@
+{
+    "watch": [
+        "./src/**/*.ts"
+    ],
+    "exec": "tsc || exit 1"
+}