Allow skipping directories during type generation

internal/fs/fs.go

@@ -43,7 +43,22 @@ func IsGitSubmodule(dir string) bool {
 }
 
 func FindDown(dir, filename string) []string {
+	return FindDownWithIgnore(dir, filename, nil)
+}
+
+func FindDownWithIgnore(dir, filename string, ignore []string) []string {
 	var result []string
+	ignored := make([]string, 0, len(ignore))
+	for _, item := range ignore {
+		if item == "" {
+			continue
+		}
+		if filepath.IsAbs(item) {
+			ignored = append(ignored, filepath.Clean(item))
+			continue
+		}
+		ignored = append(ignored, filepath.Clean(filepath.Join(dir, item)))
+	}
 
 	filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
 		if err != nil {
@@ -57,6 +72,11 @@ func FindDown(dir, filename string) []string {
 			if path != dir && IsGitSubmodule(path) {
 				return filepath.SkipDir
 			}
+			for _, ignoredPath := range ignored {
+				if isWithin(ignoredPath, path) {
+					return filepath.SkipDir
+				}
+			}
 		}
 		if !info.IsDir() && info.Name() == filename {
 			result = append(result, path)
@@ -66,3 +86,14 @@ func FindDown(dir, filename string) []string {
 
 	return result
 }
+
+func isWithin(parent, path string) bool {
+	rel, err := filepath.Rel(parent, path)
+	if err != nil {
+		return false
+	}
+	if rel == "." {
+		return true
+	}
+	return rel != ".." && !strings.HasPrefix(rel, ".."+string(filepath.Separator))
+}

internal/fs/fs_test.go

@@ -90,6 +90,20 @@ func TestFindDown(t *testing.T) {
 		assert.Equal(t, []string{filepath.Join(normal, "package.json")}, results)
 	})
 
+	t.Run("skips ignored directories", func(t *testing.T) {
+		dir := t.TempDir()
+		ignored := filepath.Join(dir, "packages", "docs")
+		included := filepath.Join(dir, "packages", "web")
+		os.MkdirAll(ignored, 0755)
+		os.MkdirAll(included, 0755)
+		os.WriteFile(filepath.Join(ignored, "package.json"), []byte("{}"), 0644)
+		includedFile := filepath.Join(included, "package.json")
+		os.WriteFile(includedFile, []byte("{}"), 0644)
+
+		results := fs.FindDownWithIgnore(dir, "package.json", []string{"packages/docs"})
+		assert.Equal(t, []string{includedFile}, results)
+	})
+
 	t.Run("does not skip dirs with .git directory", func(t *testing.T) {
 		dir := t.TempDir()
 

pkg/project/project.go

@@ -36,6 +36,7 @@ type App struct {
 	Version   string                 `json:"version"`
 	Protect   bool                   `json:"protect"`
 	Watch     []string               `json:"watch"`
+	TypeIgnore []string              `json:"typeIgnore"`
 	// Deprecated: Backend is now Home
 	Backend string `json:"backend"`
 	// Deprecated: RemovalPolicy is now Removal

pkg/project/run.go

@@ -634,7 +634,7 @@ loop:
 	complete.Finished = finished
 	complete.Errors = errors
 	complete.ImportDiffs = importDiffs
-	types.Generate(p.PathConfig(), complete.Links)
+	types.Generate(p.PathConfig(), complete.Links, p.App().TypeIgnore)
 	defer bus.Publish(complete)
 
 	if input.Command != "diff" {

pkg/types/python/python.go

@@ -11,8 +11,8 @@ import (
 	"github.com/sst/sst/v3/pkg/project/common"
 )
 
-func Generate(root string, links common.Links) error {
-	projects := fs.FindDown(root, "pyproject.toml")
+func Generate(root string, links common.Links, ignore []string) error {
+	projects := fs.FindDownWithIgnore(root, "pyproject.toml", ignore)
 	files := []io.Writer{}
 	for _, project := range projects {
 		path := filepath.Join(filepath.Dir(project), "sst.pyi")

pkg/types/python/python_test.go

@@ -14,7 +14,7 @@ import (
 func TestGenerate(t *testing.T) {
 	t.Run("no pyproject.toml returns nil", func(t *testing.T) {
 		dir := t.TempDir()
-		err := python.Generate(dir, common.Links{})
+		err := python.Generate(dir, common.Links{}, nil)
 		require.NoError(t, err)
 	})
 
@@ -31,7 +31,7 @@ func TestGenerate(t *testing.T) {
 			},
 		}
 
-		err := python.Generate(dir, links)
+		err := python.Generate(dir, links, nil)
 		require.NoError(t, err)
 
 		content, err := os.ReadFile(filepath.Join(dir, "sst.pyi"))
@@ -60,7 +60,7 @@ func TestGenerate(t *testing.T) {
 			},
 		}
 
-		err := python.Generate(dir, links)
+		err := python.Generate(dir, links, nil)
 		require.NoError(t, err)
 
 		content, err := os.ReadFile(filepath.Join(dir, "sst.pyi"))
@@ -79,11 +79,28 @@ func TestGenerate(t *testing.T) {
 		os.MkdirAll(sub, 0755)
 		os.WriteFile(filepath.Join(sub, "pyproject.toml"), []byte("[project]"), 0644)
 
-		err := python.Generate(dir, common.Links{})
+		err := python.Generate(dir, common.Links{}, nil)
 		require.NoError(t, err)
 
 		assert.FileExists(t, filepath.Join(sub, "sst.pyi"))
 	})
+
+	t.Run("ignores configured directories", func(t *testing.T) {
+		dir := t.TempDir()
+		ignored := filepath.Join(dir, "services", "legacy")
+		included := filepath.Join(dir, "services", "api")
+		os.MkdirAll(ignored, 0755)
+		os.MkdirAll(included, 0755)
+		os.WriteFile(filepath.Join(ignored, "pyproject.toml"), []byte("[project]"), 0644)
+		os.WriteFile(filepath.Join(included, "pyproject.toml"), []byte("[project]"), 0644)
+
+		err := python.Generate(dir, common.Links{}, []string{"services/legacy"})
+		require.NoError(t, err)
+
+		assert.FileExists(t, filepath.Join(included, "sst.pyi"))
+		_, err = os.Stat(filepath.Join(ignored, "sst.pyi"))
+		assert.True(t, os.IsNotExist(err))
+	})
 }
 
 func indexOf(s, substr string) int {

pkg/types/rails/rails.go

@@ -5,7 +5,10 @@ import (
 )
 
 // Generate is stubbed out — Rails support is not yet implemented.
-func Generate(root string, links common.Links) error {
+func Generate(root string, links common.Links, ignore []string) error {
+	_ = root
+	_ = links
+	_ = ignore
 	return nil
 	// projects := fs.FindDown(root, "config.ru")
 	// files := []io.Writer{}

pkg/types/types.go

@@ -10,17 +10,17 @@ import (
 	"github.com/sst/sst/v3/pkg/types/typescript"
 )
 
-type Generator = func(root string, complete common.Links) error
+type Generator = func(root string, complete common.Links, ignore []string) error
 
-func Generate(cfgPath string, complete common.Links) error {
+func Generate(cfgPath string, complete common.Links, ignore []string) error {
 	root := path.ResolveRootDir(cfgPath)
 	// gitroot, err := fs.FindUp(root, ".git")
 	// if err == nil {
 	// 	root = filepath.Dir(gitroot)
 	// }
 	slog.Info("generating types", "root", root)
 	for _, generator := range All {
-		err := generator(root, complete)
+		err := generator(root, complete, ignore)
 		if err != nil {
 			return err
 		}

pkg/types/typescript/typescript.go

@@ -23,7 +23,7 @@ var mapping = map[string]string{
 	"versionMetadataBindings":  "WorkerVersionMetadata",
 }
 
-func Generate(root string, links common.Links) error {
+func Generate(root string, links common.Links, ignore []string) error {
 	cloudflareBindings := map[string]string{}
 	for name, link := range links {
 		for _, include := range link.Include {
@@ -50,7 +50,7 @@ func Generate(root string, links common.Links) error {
 		"export {}",
 	}, "\n"))
 
-	packageJsons := fs.FindDown(root, "package.json")
+	packageJsons := fs.FindDownWithIgnore(root, "package.json", ignore)
 	rootEnv := filepath.Join(root, "sst-env.d.ts")
 	for _, packageJson := range packageJsons {
 		packageJsonFile, err := os.Open(packageJson)

pkg/types/typescript/typescript_test.go

@@ -24,7 +24,7 @@ func setupProject(t *testing.T, deps map[string]string) string {
 func TestGenerate(t *testing.T) {
 	t.Run("no package.json returns nil", func(t *testing.T) {
 		dir := t.TempDir()
-		err := typescript.Generate(dir, common.Links{})
+		err := typescript.Generate(dir, common.Links{}, nil)
 		require.NoError(t, err)
 	})
 
@@ -40,7 +40,7 @@ func TestGenerate(t *testing.T) {
 			},
 		}
 
-		err := typescript.Generate(dir, links)
+		err := typescript.Generate(dir, links, nil)
 		require.NoError(t, err)
 
 		content, err := os.ReadFile(filepath.Join(dir, "sst-env.d.ts"))
@@ -66,7 +66,7 @@ func TestGenerate(t *testing.T) {
 			},
 		}
 
-		err := typescript.Generate(dir, links)
+		err := typescript.Generate(dir, links, nil)
 		require.NoError(t, err)
 
 		content, err := os.ReadFile(filepath.Join(dir, "sst-env.d.ts"))
@@ -91,7 +91,7 @@ func TestGenerate(t *testing.T) {
 			},
 		}
 
-		err := typescript.Generate(dir, links)
+		err := typescript.Generate(dir, links, nil)
 		require.NoError(t, err)
 
 		content, err := os.ReadFile(filepath.Join(dir, "sst-env.d.ts"))
@@ -114,7 +114,7 @@ func TestGenerate(t *testing.T) {
 			},
 		}
 
-		err := typescript.Generate(dir, links)
+		err := typescript.Generate(dir, links, nil)
 		require.NoError(t, err)
 
 		content, err := os.ReadFile(filepath.Join(dir, "sst-env.d.ts"))
@@ -140,7 +140,7 @@ func TestGenerate(t *testing.T) {
 			},
 		}
 
-		err := typescript.Generate(dir, links)
+		err := typescript.Generate(dir, links, nil)
 		require.NoError(t, err)
 
 		content, err := os.ReadFile(filepath.Join(dir, "sst-env.d.ts"))
@@ -160,12 +160,33 @@ func TestGenerate(t *testing.T) {
 		os.MkdirAll(sub, 0755)
 		os.WriteFile(filepath.Join(sub, "package.json"), pkg, 0644)
 
-		err := typescript.Generate(dir, common.Links{})
+		err := typescript.Generate(dir, common.Links{}, nil)
 		require.NoError(t, err)
 
 		assert.FileExists(t, filepath.Join(dir, "sst-env.d.ts"))
 		assert.FileExists(t, filepath.Join(sub, "sst-env.d.ts"))
 	})
+
+	t.Run("ignores configured directories", func(t *testing.T) {
+		dir := t.TempDir()
+		pkg, _ := json.Marshal(map[string]interface{}{"dependencies": map[string]string{}})
+		os.WriteFile(filepath.Join(dir, "package.json"), pkg, 0644)
+
+		ignored := filepath.Join(dir, "packages", "docs")
+		included := filepath.Join(dir, "packages", "web")
+		os.MkdirAll(ignored, 0755)
+		os.MkdirAll(included, 0755)
+		os.WriteFile(filepath.Join(ignored, "package.json"), pkg, 0644)
+		os.WriteFile(filepath.Join(included, "package.json"), pkg, 0644)
+
+		err := typescript.Generate(dir, common.Links{}, []string{"packages/docs"})
+		require.NoError(t, err)
+
+		assert.FileExists(t, filepath.Join(dir, "sst-env.d.ts"))
+		assert.FileExists(t, filepath.Join(included, "sst-env.d.ts"))
+		_, err = os.Stat(filepath.Join(ignored, "sst-env.d.ts"))
+		assert.True(t, os.IsNotExist(err))
+	})
 }
 
 func indexOf(s, substr string) int {

platform/src/config.ts

@@ -286,6 +286,25 @@ export interface App {
    * The paths are relative to the project root.
    */
   watch?: string[];
+
+  /**
+   * Configure which directories should be ignored when generating `sst-env.d.ts`
+   * and `sst.pyi` files.
+   * By default, type files are generated for all JavaScript and Python projects
+   * (except node_modules and hidden directories).
+   *
+   * @example
+   * ```ts
+   * {
+   *   typeIgnore: ["packages/docs", "services/legacy-python"]
+   * }
+   * ```
+   *
+   * This will skip generating type files inside the `packages/docs` and
+   * `services/legacy-python` directories.
+   * The paths are relative to the project root.
+   */
+  typeIgnore?: string[];
 }
 
 export interface AppInput {