use state config object in sst.config.ts

Author: jamesgibbons92

cmd/sst/main.go

@@ -837,14 +837,6 @@ var root = &cli.Command{
 						Long:  "Only run it for the given component.",
 					},
 				},
-				{
-					Name: "purge",
-					Type: "bool",
-					Description: cli.Description{
-						Short: "Fully remove the stage state",
-						Long:  "Remove state file and passphrase associated with the stage. Warning: This is irreversible, the state encryption key and all state versions will be unrecoverable.",
-					},
-				},
 			},
 			Run: CmdRemove,
 		},

cmd/sst/remove.go

@@ -47,7 +47,6 @@ func CmdRemove(c *cli.Cli) error {
 	err = p.Run(c.Context, &project.StackInput{
 		Command:    "remove",
 		Target:     target,
-		Purge:      c.Bool("purge"),
 		ServerPort: s.Port,
 		Verbose:    c.Bool("verbose"),
 	})

pkg/project/project.go

@@ -27,6 +27,10 @@ import (
 	"github.com/sst/sst/v3/pkg/runtime/worker"
 )
 
+type AppState struct {
+	PurgeOnRemove bool `json:"purgeOnRemove"`
+}
+
 type App struct {
 	Name      string                 `json:"name"`
 	Stage     string                 `json:"stage"`
@@ -36,6 +40,7 @@ type App struct {
 	Version   string                 `json:"version"`
 	Protect   bool                   `json:"protect"`
 	Watch     []string               `json:"watch"`
+	State     *AppState              `json:"state"`
 	// Deprecated: Backend is now Home
 	Backend string `json:"backend"`
 	// Deprecated: RemovalPolicy is now Removal

pkg/project/run.go

@@ -675,7 +675,7 @@ loop:
 
 	if input.Command == "remove" && len(complete.Resources) == 0 {
 		provider.Cleanup(p.home, p.app.Name, p.app.Stage)
-		if input.Purge {
+		if p.app.State != nil && p.app.State.PurgeOnRemove {
 			provider.Purge(p.home, p.app.Name, p.app.Stage)
 		}
 	}

pkg/project/stack.go

@@ -23,7 +23,6 @@ type StackInput struct {
 	Dev        bool
 	Verbose    bool
 	Continue   bool
-	Purge      bool
 	SkipHash   string
 	PolicyPath string
 }

platform/src/config.ts

@@ -286,6 +286,55 @@ export interface App {
    * The paths are relative to the project root.
    */
   watch?: string[];
+
+  /**
+   * Configure how your app's state is managed.
+   *
+   * The state keeps track of all your resources, secrets, and the encryption key. By default,
+   * this data is preserved via versioning even after `sst remove` so you can recover it if needed.
+   *
+   * @example
+   *
+   * For example, to fully remove the state file and encryption key:
+   *
+   * ```ts
+   * {
+   *   state: {
+   *     purgeOnRemove: input.stage !== "production"
+   *   }
+   * }
+   * ```
+   */
+  state?: {
+    /**
+     * If set to `true`, running `sst remove` will fully remove all state associated
+     * with the stage once all resources have been successfully removed.
+     *
+     * This removes the state files, secrets and the encryption passphrase.
+     *
+     * :::caution
+     * This is irreversible. Once the state encryption key is deleted, secrets and all state versions will be
+     * unrecoverable.
+     * :::
+     *
+     * :::tip
+     * Only enable this for ephemeral or development stages.
+     * :::
+     *
+     * @default false
+     *
+     * @example
+     *
+     * ```ts
+     * {
+     *   state: {
+     *     purgeOnRemove: true
+     *   }
+     * }
+     * ```
+     */
+    purgeOnRemove?: boolean;
+  };
 }
 
 export interface AppInput {