Merge remote-tracking branch 'origin/main' into feat/cli-types-python

Author: ChiragAgg5k

src/SDK/Language/CLI.php

@@ -1122,6 +1122,11 @@ public function getFiles(): array
                 'destination'   => 'internal/cmd/initscaffold_test.go',
                 'template'      => 'cli/internal/cmd/initscaffold_test.go',
             ],
+            [
+                'scope'         => 'copy',
+                'destination'   => 'internal/cmd/initsite_test.go',
+                'template'      => 'cli/internal/cmd/initsite_test.go',
+            ],
             [
                 'scope'         => 'default',
                 'destination'   => 'internal/cmd/initfunction.go',
@@ -1589,6 +1594,11 @@ public function getFiles(): array
                 'destination'   => 'internal/typegen/casing_test.go',
                 'template'      => 'cli/internal/typegen/casing_test.go',
             ],
+            [
+                'scope'         => 'copy',
+                'destination'   => 'internal/typegen/enum_style.go',
+                'template'      => 'cli/internal/typegen/enum_style.go',
+            ],
             [
                 'scope'         => 'copy',
                 'destination'   => 'internal/typegen/language.go',
@@ -1627,6 +1637,16 @@ public function getFiles(): array
                 'destination'   => 'internal/typegen/testdata/ts.strict.appwrite.d.ts',
                 'template'      => 'cli/internal/typegen/testdata/ts.strict.appwrite.d.ts',
             ],
+            [
+                'scope'         => 'copy',
+                'destination'   => 'internal/typegen/testdata/ts.const.appwrite.d.ts',
+                'template'      => 'cli/internal/typegen/testdata/ts.const.appwrite.d.ts',
+            ],
+            [
+                'scope'         => 'copy',
+                'destination'   => 'internal/typegen/testdata/ts.const.appwrite.ts',
+                'template'      => 'cli/internal/typegen/testdata/ts.const.appwrite.ts',
+            ],
             [
                 'scope'         => 'copy',
                 'destination'   => 'internal/typegen/testdata/js.loose.appwrite-types.js',
@@ -1852,6 +1872,11 @@ public function getFiles(): array
                 'destination'   => 'internal/generator/testdata/server.types.ts',
                 'template'      => 'cli/internal/generator/testdata/server.types.ts',
             ],
+            [
+                'scope'         => 'copy',
+                'destination'   => 'internal/generator/testdata/server.const.types.ts',
+                'template'      => 'cli/internal/generator/testdata/server.const.types.ts',
+            ],
             [
                 'scope'         => 'copy',
                 'destination'   => 'internal/generator/testdata/server.index.ts',

templates/cli/internal/app/install.go.twig

@@ -7,6 +7,7 @@ import (
 	"runtime"
 	"strings"
 
+	"github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName | caseDash }}/internal/config"
 	"github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName | caseDash }}/internal/update"
 )
 
@@ -165,7 +166,7 @@ func UpdateChecker() *update.Checker {
 		return nil
 	}
 
-	home, err := os.UserHomeDir()
+	directory, err := config.GlobalDirectory(ExecutableName)
 	if err != nil {
 		return nil
 	}
@@ -174,7 +175,7 @@ func UpdateChecker() *update.Checker {
 		RegistryURL:           NPMRegistryURL,
 		PrereleaseRegistryURL: NPMPrereleaseRegistryURL,
 		// Beside the preferences, which is already the directory this CLI owns.
-		CachePath: filepath.Join(home, "."+ExecutableName, "update-check.json"),
+		CachePath: filepath.Join(directory, "update-check.json"),
 		Current:   Version,
 	}
 }

templates/cli/internal/cmd/completion_test.go

@@ -23,6 +23,7 @@ func setHome(t *testing.T) string {
 	home := t.TempDir()
 	t.Setenv("HOME", home)
 	t.Setenv("USERPROFILE", home)
+	t.Setenv("XDG_CONFIG_HOME", "")
 
 	return home
 }

templates/cli/internal/cmd/fanout_test.go

@@ -118,6 +118,7 @@ func TestAllSubcommandsNeverPrompt(t *testing.T) {
 			home := t.TempDir()
 			t.Setenv("HOME", home)
 			t.Setenv("USERPROFILE", home)
+			t.Setenv("XDG_CONFIG_HOME", "")
 			inDirectory(t, t.TempDir())
 
 			root := NewRootCommand()

templates/cli/internal/cmd/generate.go

@@ -13,6 +13,7 @@ import (
 	"github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName | caseDash }}/internal/generator"
 	"github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName | caseDash }}/internal/jsonx"
 	"github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName | caseDash }}/internal/output"
+	"github.com/{{ sdk.gitUserName }}/{{ sdk.gitRepoName | caseDash }}/internal/typegen"
 	"github.com/spf13/cobra"
 )
 
@@ -26,6 +27,7 @@ func newGenerateCommand() *cobra.Command {
 		serverSide      string
 		importSource    string
 		importExtension string
+		enumStyle       string
 	)
 
 	command := &cobra.Command{
@@ -39,7 +41,7 @@ func newGenerateCommand() *cobra.Command {
 				extension = &importExtension
 			}
 
-			return runGenerate(command, outputDirectory, language, serverSide, importSource, extension)
+			return runGenerate(command, outputDirectory, language, serverSide, importSource, extension, enumStyle)
 		},
 	}
 
@@ -60,6 +62,8 @@ func newGenerateCommand() *cobra.Command {
 	command.Flags().StringVar(&importExtension, "import-extension", "",
 		`Override import file extension in generated files (.js for ESM, empty string for CJS). `+
 			`Auto-detected from package.json "type" field if not provided.`)
+	command.Flags().StringVar(&enumStyle, "enum-style", string(typegen.EnumStyleEnum),
+		"How enums are declared in types.ts ("+typegen.EnumStyleChoices()+"); const emits an `as const` object and a union type")
 
 	return command
 }
@@ -121,6 +125,7 @@ func runGenerate(
 	command *cobra.Command,
 	outputDirectory, language, serverSide, importSource string,
 	importExtension *string,
+	rawEnumStyle string,
 ) error {
 	working, err := os.Getwd()
 	if err != nil {
@@ -142,6 +147,11 @@ func runGenerate(
 		return fmt.Errorf("invalid --server value: %s", serverSide)
 	}
 
+	enumStyle, err := typegen.ParseEnumStyle(rawEnumStyle)
+	if err != nil {
+		return err
+	}
+
 	created, name, err := resolveGenerator(command, language, working)
 	if err != nil {
 		return err
@@ -158,6 +168,7 @@ func runGenerate(
 		ImportSource:    importSource,
 		ImportExtension: importExtension,
 		ServerSide:      serverSide,
+		EnumStyle:       enumStyle,
 	})
 	if err != nil {
 		return fmt.Errorf("failed to generate SDK: %w", err)

templates/cli/internal/cmd/generate_test.go

@@ -44,6 +44,7 @@ func TestGenerateEndpointFallsBackToTheDefault(t *testing.T) {
 	home := t.TempDir()
 	t.Setenv("HOME", home)
 	t.Setenv("USERPROFILE", home)
+	t.Setenv("XDG_CONFIG_HOME", "")
 
 	if got := resolveGenerateEndpoint(""); got != config.DefaultEndpoint {
 		t.Errorf("endpoint = %q, want %q", got, config.DefaultEndpoint)

templates/cli/internal/cmd/initscaffold.go

@@ -10,7 +10,6 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
-	"runtime"
 	"strings"
 )
 
@@ -19,25 +18,6 @@ import (
 // All three fetch starter code with git and copy a subtree into the project,
 // so the clone, the error translation and the recursive copy live here once.
 
-// runGit runs a git invocation with its output captured.
-//
-// Output is captured rather than streamed: a sparse checkout prints progress
-// that means nothing to someone running `init function`, and the text is only
-// wanted when it fails.
-func runGit(directory string, script string) error {
-	var command *exec.Cmd
-
-	switch {
-	case runtime.GOOS == "windows":
-		// cmd rather than PowerShell, which has no `&&`.
-		command = exec.Command("cmd", "/c", script)
-	default:
-		command = exec.Command("sh", "-c", script)
-	}
-
-	return executeGit(command, directory)
-}
-
 // runGitCommand invokes Git without a shell. Use it when arguments contain
 // values received from an API or remote repository, so ref names and paths are
 // passed literally rather than interpreted as shell syntax.
@@ -101,7 +81,8 @@ func gitError(message string) error {
 		return fmt.Errorf("%s \n\nSuggestion: Try updating your git to the "+
 			"latest version, then trying to run this command again", message)
 	case strings.Contains(message, "is not recognized as an internal or external command,"),
-		strings.Contains(message, "command not found"):
+		strings.Contains(message, "command not found"),
+		strings.Contains(message, "executable file not found"):
 		return fmt.Errorf("%s \n\nSuggestion: It appears that git is not "+
 			"installed, try installing git then trying to run this command again", message)
 	}

templates/cli/internal/cmd/initscaffold_test.go

@@ -161,3 +161,13 @@ func TestParseSkillFrontmatterWithoutABlock(t *testing.T) {
 		t.Errorf("got (%q, %q), want two empty strings", name, description)
 	}
 }
+
+func TestRunGitCommandSuggestsInstallingGitWhenItIsMissing(t *testing.T) {
+	t.Setenv("PATH", t.TempDir())
+
+	err := runGitCommand(t.TempDir(), "--version")
+
+	if err == nil || !strings.Contains(err.Error(), "git is not installed") {
+		t.Errorf("err = %v, want the missing-git suggestion", err)
+	}
+}

templates/cli/internal/cmd/initsite.go

@@ -313,10 +313,6 @@ func siteEntryRequiresBuildCommand(entry SiteEntry) bool {
 }
 
 // downloadSiteTemplate fetches the framework's starter into the site directory.
-//
-// The clone is built by hand rather than with `git clone` because the template
-// lives at a tag in a subdirectory of a shared repository: a sparse checkout of
-// one directory at one tag is cheaper than cloning the whole thing.
 func downloadSiteTemplate(
 	out interface{ Write([]byte) (int, error) },
 	template *siteTemplate,
@@ -330,7 +326,7 @@ func downloadSiteTemplate(
 		return fmt.Errorf("No starter template found for framework %s", framework)
 	}
 
-	root := template.Frameworks[0].ProviderRootDirectory
+	root := strings.Trim(strings.TrimPrefix(template.Frameworks[0].ProviderRootDirectory, "./"), "/")
 
 	if err := os.MkdirAll(siteFolder, 0o777); err != nil {
 		return err
@@ -340,48 +336,38 @@ func downloadSiteTemplate(
 	}
 	defer os.RemoveAll(templatesDir)
 
-	repo := fmt.Sprintf("https://github.com/%s/%s",
+	repository := fmt.Sprintf("https://github.com/%s/%s",
 		template.ProviderOwner, template.ProviderRepositoryID)
 
-	setup := []string{
-		"git init",
-		"git remote add origin " + repo,
-		"git config --global init.defaultBranch main",
-	}
-
-	if root != "./" {
-		sparse := strings.TrimPrefix(root, "./")
-		setup = append(setup,
-			"git config core.sparseCheckout true",
-			fmt.Sprintf("echo %q >> .git/info/sparse-checkout", sparse),
-			"git config --add remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'",
-			"git config remote.origin.tagopt --no-tags",
-		)
-	}
-
 	output.Log(out, "Fetching site code ...")
 
-	// The tag is resolved remotely and the LAST match taken, which is how a
-	// version like "0.1.*" picks its newest release.
-	setup = append(setup,
-		fmt.Sprintf("git fetch --depth=1 origin refs/tags/$(git ls-remote --tags "+
-			"origin %q | tail -n 1 | awk -F '/' '{print $3}')", template.ProviderVersion),
-		"git checkout FETCH_HEAD",
-	)
+	tag, err := resolveGitTag(templatesDir, repository, template.ProviderVersion)
+	if err != nil {
+		return err
+	}
 
-	if err := runGit(templatesDir, strings.Join(setup, "\n")); err != nil {
+	cloneArguments := []string{"clone", "--single-branch", "--depth", "1"}
+	if tag != "" {
+		cloneArguments = append(cloneArguments, "--branch", tag)
+	}
+	if root != "" {
+		cloneArguments = append(cloneArguments, "--sparse")
+	}
+	cloneArguments = append(cloneArguments, repository, ".")
+	if err := runGitCommand(templatesDir, cloneArguments...); err != nil {
 		return err
 	}
+	if root != "" {
+		if err := runGitCommand(templatesDir, "sparse-checkout", "add", root); err != nil {
+			return err
+		}
+	}
 
 	if err := os.RemoveAll(filepath.Join(templatesDir, ".git")); err != nil {
 		return err
 	}
 
-	source := templatesDir
-	if root != "./" {
-		source = filepath.Join(templatesDir, root)
-	}
-	if err := copyTree(source, siteDir); err != nil {
+	if err := copyTree(filepath.Join(templatesDir, filepath.FromSlash(root)), siteDir); err != nil {
 		return err
 	}