Add local template option

Author: cprecioso

waspc/cli/exe/Main.hs

@@ -17,7 +17,7 @@ import Wasp.Cli.Command.BuildStart (buildStart)
 import qualified Wasp.Cli.Command.Call as Command.Call
 import Wasp.Cli.Command.Clean (clean)
 import Wasp.Cli.Command.Compile (compile)
-import Wasp.Cli.Command.CreateNewProject (createNewProject)
+import Wasp.Cli.Command.CreateNewProject (createNewCustomProject, createNewProject)
 import qualified Wasp.Cli.Command.CreateNewProject.AI as Command.CreateNewProject.AI
 import Wasp.Cli.Command.CreateNewProject.AvailableTemplates (availableStarterTemplates)
 import Wasp.Cli.Command.Db (runCommandThatRequiresDbRunning)
@@ -51,6 +51,7 @@ main = withUtf8 . (`E.catch` handleInternalErrors) $ do
   let commandCall = case args of
         ("new" : newArgs) -> Command.Call.New newArgs
         ("new:ai" : newAiArgs) -> Command.Call.NewAi newAiArgs
+        ("new:custom" : newCustomArgs) -> Command.Call.NewCustom newCustomArgs
         ["start"] -> Command.Call.Start
         ("start" : "db" : startDbArgs) -> Command.Call.StartDb startDbArgs
         ["clean"] -> Command.Call.Clean
@@ -89,6 +90,7 @@ main = withUtf8 . (`E.catch` handleInternalErrors) $ do
 
   case commandCall of
     Command.Call.New newArgs -> runCommand $ createNewProject newArgs
+    Command.Call.NewCustom newCustomArgs -> runCommand $ createNewCustomProject newCustomArgs
     Command.Call.NewAi newAiArgs -> case newAiArgs of
       ["--stdout", projectName, appDescription, projectConfigJson] ->
         runCommand $

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

@@ -3,6 +3,7 @@ module Wasp.Cli.Command.Call where
 data Call
   = New Arguments
   | NewAi Arguments
+  | NewCustom Arguments
   | Start
   | StartDb Arguments
   | Clean

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

@@ -1,5 +1,6 @@
 module Wasp.Cli.Command.CreateNewProject
   ( createNewProject,
+    createNewCustomProject,
   )
 where
 
@@ -9,11 +10,12 @@ import qualified StrongPath as SP
 import Wasp.Cli.Command (Command)
 import Wasp.Cli.Command.Call (Arguments)
 import qualified Wasp.Cli.Command.CreateNewProject.AI as AI
-import Wasp.Cli.Command.CreateNewProject.ArgumentsParser (newProjectArgsParser)
+import Wasp.Cli.Command.CreateNewProject.ArgumentsParser (newCustomProjectArgsParser, newProjectArgsParser)
 import Wasp.Cli.Command.CreateNewProject.AvailableTemplates (availableStarterTemplates)
 import qualified Wasp.Cli.Command.CreateNewProject.Common as Common
 import Wasp.Cli.Command.CreateNewProject.ProjectDescription
   ( NewProjectDescription (..),
+    obtainNewCustomProjectDescription,
     obtainNewProjectDescription,
   )
 import Wasp.Cli.Command.CreateNewProject.StarterTemplates
@@ -22,6 +24,7 @@ import Wasp.Cli.Command.CreateNewProject.StarterTemplates
   )
 import Wasp.Cli.Command.CreateNewProject.StarterTemplates.Bundled (createProjectOnDiskFromBundledTemplate)
 import Wasp.Cli.Command.CreateNewProject.StarterTemplates.GhReleaseArchive (createProjectOnDiskFromGhReleaseArchiveTemplate)
+import Wasp.Cli.Command.CreateNewProject.StarterTemplates.Local (createProjectOnDiskFromLocalTemplate)
 import Wasp.Cli.Command.Message (cliSendMessageC)
 import Wasp.Cli.Util.Parser (parseArguments)
 import qualified Wasp.Message as Msg
@@ -39,6 +42,19 @@ createNewProject args = do
   createProjectOnDisk newProjectDescription
   liftIO $ printGettingStartedInstructionsForProject newProjectDescription
 
+-- | It receives all of the arguments that were passed to the `wasp new:custom` command.
+createNewCustomProject :: Arguments -> Command ()
+createNewCustomProject args = do
+  newCustomProjectArgs <-
+    parseArguments "wasp new:custom" newCustomProjectArgsParser args
+      & either Common.throwProjectCreationError return
+
+  newCustomProjectDescription <-
+    obtainNewCustomProjectDescription newCustomProjectArgs
+
+  createProjectOnDisk newCustomProjectDescription
+  liftIO $ printGettingStartedInstructionsForProject newCustomProjectDescription
+
 createProjectOnDisk :: NewProjectDescription -> Command ()
 createProjectOnDisk
   NewProjectDescription
@@ -53,6 +69,8 @@ createProjectOnDisk
         createProjectOnDiskFromGhReleaseArchiveTemplate absWaspProjectDir projectName appName ghRepoRef archiveName' archivePath'
       BundledStarterTemplate {bundledPath = bundledPath'} ->
         liftIO $ createProjectOnDiskFromBundledTemplate absWaspProjectDir projectName appName bundledPath'
+      LocalStarterTemplate {localPath = localPath'} ->
+        liftIO $ createProjectOnDiskFromLocalTemplate absWaspProjectDir projectName appName localPath'
       AiGeneratedStarterTemplate ->
         AI.createNewProjectInteractiveOnDisk absWaspProjectDir appName
 

waspc/cli/src/Wasp/Cli/Command/CreateNewProject/ArgumentsParser.hs

@@ -1,10 +1,13 @@
 module Wasp.Cli.Command.CreateNewProject.ArgumentsParser
   ( NewProjectArgs (..),
     newProjectArgsParser,
+    NewCustomProjectArgs (..),
+    newCustomProjectArgsParser,
   )
 where
 
 import qualified Options.Applicative as Opt
+import Wasp.Cli.Util.PathArgument (DirPathArgument, dirPathReader)
 
 data NewProjectArgs = NewProjectArgs
   { _projectName :: Maybe String,
@@ -27,3 +30,25 @@ newProjectArgsParser =
           <> Opt.short 't'
           <> Opt.metavar "TEMPLATE_NAME"
           <> Opt.help "Template to use for the new project"
+
+data NewCustomProjectArgs = NewCustomProjectArgs
+  { _customProjectName :: Maybe String,
+    _customTemplatePath :: DirPathArgument
+  }
+
+newCustomProjectArgsParser :: Opt.Parser NewCustomProjectArgs
+newCustomProjectArgsParser =
+  NewCustomProjectArgs
+    <$> Opt.optional projectNameParser
+    <*> templateNameParser
+  where
+    projectNameParser :: Opt.Parser String
+    projectNameParser = Opt.strArgument $ Opt.metavar "PROJECT_NAME"
+
+    templateNameParser :: Opt.Parser DirPathArgument
+    templateNameParser =
+      Opt.option dirPathReader $
+        Opt.long "path"
+          <> Opt.short 'p'
+          <> Opt.metavar "TEMPLATE_PATH"
+          <> Opt.help "Path to the local directory to use as a starter template"

waspc/cli/src/Wasp/Cli/Command/CreateNewProject/ProjectDescription.hs

@@ -1,5 +1,6 @@
 module Wasp.Cli.Command.CreateNewProject.ProjectDescription
   ( obtainNewProjectDescription,
+    obtainNewCustomProjectDescription,
     NewProjectDescription (..),
     NewProjectName (..),
     NewProjectAppName (..),
@@ -8,26 +9,31 @@ module Wasp.Cli.Command.CreateNewProject.ProjectDescription
   )
 where
 
+import Control.Monad (unless)
 import Control.Monad.IO.Class (liftIO)
 import Data.List (intercalate)
 import Data.List.NonEmpty (fromList)
 import Data.Maybe (isNothing)
 import Path.IO (doesDirExist)
-import StrongPath (Abs, Dir, Path')
+import StrongPath (Abs, Dir, Path', fromAbsDir)
 import StrongPath.Path (toPathAbsDir)
+import System.Directory (doesDirectoryExist)
 import Wasp.Analyzer.Parser (isValidWaspIdentifier)
 import Wasp.Cli.Command (Command)
 import Wasp.Cli.Command.CreateNewProject.ArgumentsParser
-  ( NewProjectArgs (..),
+  ( NewCustomProjectArgs (..),
+    NewProjectArgs (..),
   )
 import Wasp.Cli.Command.CreateNewProject.AvailableTemplates (defaultStarterTemplate)
 import Wasp.Cli.Command.CreateNewProject.Common (throwProjectCreationError)
 import Wasp.Cli.Command.CreateNewProject.StarterTemplates
-  ( StarterTemplate,
+  ( StarterTemplate (LocalStarterTemplate, localPath),
     findTemplateByString,
   )
 import Wasp.Cli.FileSystem (getAbsPathToDirInCwd)
 import qualified Wasp.Cli.Interactive as Interactive
+import Wasp.Cli.Util.PathArgument (DirPathArgument)
+import qualified Wasp.Cli.Util.PathArgument as PathArgument
 import Wasp.Project.Common (WaspProjectDir)
 import Wasp.Util (indent, kebabToCamelCase, whenM)
 
@@ -81,6 +87,16 @@ obtainNewProjectDescription NewProjectArgs {_projectName = projectNameArg, _temp
   absWaspProjectDir <- obtainAvailableProjectDirPath projectName
   return $ mkNewProjectDescription projectName appName absWaspProjectDir template
 
+obtainNewCustomProjectDescription :: NewCustomProjectArgs -> Command NewProjectDescription
+obtainNewCustomProjectDescription NewCustomProjectArgs {_customProjectName = projectNameArg, _customTemplatePath = templatePathArg} = do
+  projectName <- maybe askForName return projectNameArg
+  appName <-
+    either throwProjectCreationError pure $
+      parseWaspProjectNameIntoAppName projectName
+  template <- findCustomTemplateOrThrow templatePathArg
+  absWaspProjectDir <- obtainAvailableProjectDirPath projectName
+  return $ mkNewProjectDescription projectName appName absWaspProjectDir template
+
 askForName :: Command String
 askForName =
   liftIO $ Interactive.askForRequiredInput "Enter the project name (e.g. my-project)"
@@ -114,6 +130,18 @@ findTemplateOrThrow availableTemplates templateName = case findTemplateByString
         <> intercalate ", " (map show availableTemplates)
         <> "."
 
+findCustomTemplateOrThrow :: DirPathArgument -> Command StarterTemplate
+findCustomTemplateOrThrow templatePathArg = do
+  absTemplatePath <- liftIO $ PathArgument.getDirPath templatePathArg
+  templateExists <- liftIO $ doesDirectoryExist $ fromAbsDir absTemplatePath
+
+  unless templateExists $ do
+    throwProjectCreationError $
+      "The provided template path does not exist or is not a directory: "
+        ++ show templatePathArg
+
+  return $ LocalStarterTemplate {localPath = absTemplatePath}
+
 obtainAvailableProjectDirPath :: String -> Command (Path' Abs (Dir WaspProjectDir))
 obtainAvailableProjectDirPath projectName = do
   absWaspProjectDir <- getAbsPathToNewProjectDirInCwd projectName

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

@@ -11,7 +11,7 @@ where
 
 import Data.Foldable (find)
 import Data.Text (Text)
-import StrongPath (Dir', File', Path, Path', Rel, Rel', System, reldir, (</>))
+import StrongPath (Abs, Dir', File', Path, Path', Rel, Rel', System, reldir, (</>))
 import qualified StrongPath as SP
 import qualified Wasp.Cli.GithubRepo as GhRepo
 import qualified Wasp.Cli.Interactive as Interactive
@@ -36,6 +36,8 @@ data StarterTemplate
       { bundledPath :: Path' Rel' Dir',
         metadata :: !TemplateMetadata
       }
+  | -- | Template from disk, that the user has locally extracted.
+    LocalStarterTemplate {localPath :: !(Path' Abs Dir')}
   | -- | Template that will be dynamically generated by Wasp AI based on user's input.
     AiGeneratedStarterTemplate
 
@@ -49,13 +51,15 @@ data TemplateMetadata = TemplateMetadata
 instance Show StarterTemplate where
   show (GhRepoReleaseArchiveTemplate {metadata = metadata'}) = _name metadata'
   show (BundledStarterTemplate {metadata = metadata'}) = _name metadata'
+  show (LocalStarterTemplate _) = "custom"
   show AiGeneratedStarterTemplate = "ai-generated"
 
 instance Interactive.IsOption StarterTemplate where
   showOption = show
 
   showOptionDescription (GhRepoReleaseArchiveTemplate {metadata = metadata'}) = Just $ _description metadata'
   showOptionDescription (BundledStarterTemplate {metadata = metadata'}) = Just $ _description metadata'
+  showOptionDescription (LocalStarterTemplate _) = Just "A custom starter template from a local path."
   showOptionDescription AiGeneratedStarterTemplate =
     Just "🤖 Describe an app in a couple of sentences and have Wasp AI generate initial code for you. (experimental)"
 
@@ -68,6 +72,7 @@ getTemplateStartingInstructions :: String -> StarterTemplate -> String
 getTemplateStartingInstructions projectDirName = \case
   GhRepoReleaseArchiveTemplate {metadata = metadata'} -> _buildStartingInstructions metadata' projectDirName
   BundledStarterTemplate {metadata = metadata'} -> _buildStartingInstructions metadata' projectDirName
+  LocalStarterTemplate _ -> "Check the starter's documentation for guidance on how to start your app."
   AiGeneratedStarterTemplate ->
     unlines
       [ styleText $ "To run your new app, do:",

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

@@ -0,0 +1,17 @@
+module Wasp.Cli.Command.CreateNewProject.StarterTemplates.Local
+  ( createProjectOnDiskFromLocalTemplate,
+  )
+where
+
+import Path.IO (copyDirRecur)
+import StrongPath (Abs, Dir, Dir', Path')
+import StrongPath.Path (toPathAbsDir)
+import Wasp.Cli.Command.CreateNewProject.ProjectDescription (NewProjectAppName, NewProjectName)
+import Wasp.Cli.Command.CreateNewProject.StarterTemplates.Templating (replaceTemplatePlaceholdersInTemplateFiles)
+import Wasp.Project (WaspProjectDir)
+
+createProjectOnDiskFromLocalTemplate ::
+  Path' Abs (Dir WaspProjectDir) -> NewProjectName -> NewProjectAppName -> Path' Abs Dir' -> IO ()
+createProjectOnDiskFromLocalTemplate absWaspProjectDir projectName appName templatePath = do
+  copyDirRecur (toPathAbsDir templatePath) (toPathAbsDir absWaspProjectDir)
+  replaceTemplatePlaceholdersInTemplateFiles appName projectName absWaspProjectDir

waspc/waspc.cabal

@@ -591,6 +591,7 @@ library cli-lib
     Wasp.Cli.Command.CreateNewProject.StarterTemplates
     Wasp.Cli.Command.CreateNewProject.StarterTemplates.Bundled
     Wasp.Cli.Command.CreateNewProject.StarterTemplates.GhReleaseArchive
+    Wasp.Cli.Command.CreateNewProject.StarterTemplates.Local
     Wasp.Cli.Command.CreateNewProject.StarterTemplates.Templating
     Wasp.Cli.Command.Db
     Wasp.Cli.Command.Db.Migrate