@regressionproof/snapshotter 0.3.1 → 0.3.3

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.3.3](https://github.com/sprucelabsai-community/regressionproof/compare/v0.3.2...v0.3.3) (2026-01-13)
+
+**Note:** Version bump only for package @regressionproof/snapshotter
+
+
+
+
+
+## [0.3.2](https://github.com/sprucelabsai-community/regressionproof/compare/v0.3.1...v0.3.2) (2026-01-13)
+
+**Note:** Version bump only for package @regressionproof/snapshotter
+
+
+
+
+
 ## [0.3.1](https://github.com/sprucelabsai-community/regressionproof/compare/v0.3.0...v0.3.1) (2026-01-13)
 
 **Note:** Version bump only for package @regressionproof/snapshotter

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regressionproof/snapshotter",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "publishConfig": {
     "access": "public"
   },
@@ -49,6 +49,7 @@
     "@sprucelabs/esm-postbuild": "^9.0.13",
     "@sprucelabs/jest-json-reporter": "^10.0.19",
     "@sprucelabs/resolve-path-aliases": "^4.0.13",
+    "@sprucelabs/spruce-skill-utils": "^34.0.3",
     "@sprucelabs/test": "^11.1.0",
     "@sprucelabs/test-utils": "^7.2.3",
     "@types/node": "^25.0.6",
@@ -84,5 +85,11 @@
       "^#spruce/(.*)$": "<rootDir>/build/.spruce/$1"
     }
   },
-  "gitHead": "192ac0ba411c3b6b41e3b24f58ec7748f5386d22"
+  "dependencies": {
+    "@sprucelabs/error": "^8.1.2",
+    "@sprucelabs/schema": "^33.1.3",
+    "@sprucelabs/spruce-core-schemas": "^42.1.3",
+    "@sprucelabs/spruce-skill-utils": "^34.0.3"
+  },
+  "gitHead": "bd2c5801a5d27ec36938d59dbfff50b32a390b87"
 }

package/src/.spruce/errors/errors.types.ts

@@ -0,0 +1,52 @@
+import { default as SchemaEntity } from '@sprucelabs/schema'
+import * as SpruceSchema from '@sprucelabs/schema'
+
+
+
+
+
+export declare namespace SpruceErrors.RegressionproofSnapshotter {
+
+	
+	export interface ExecCommandFailed {
+		
+			/** . The command that was attempted */
+			'command': string
+			
+			'stdout'?: string | undefined | null
+			
+			'stderr'?: string | undefined | null
+	}
+
+	export interface ExecCommandFailedSchema extends SpruceSchema.Schema {
+		id: 'execCommandFailed',
+		namespace: 'RegressionproofSnapshotter',
+		name: 'Exec command failed',
+		    fields: {
+		            /** . The command that was attempted */
+		            'command': {
+		                type: 'text',
+		                isRequired: true,
+		                hint: 'The command that was attempted',
+		                options: undefined
+		            },
+		            /** . */
+		            'stdout': {
+		                type: 'text',
+		                options: undefined
+		            },
+		            /** . */
+		            'stderr': {
+		                type: 'text',
+		                options: undefined
+		            },
+		    }
+	}
+
+	export type ExecCommandFailedEntity = SchemaEntity<SpruceErrors.RegressionproofSnapshotter.ExecCommandFailedSchema>
+
+}
+
+
+
+

package/src/.spruce/errors/options.types.ts

@@ -0,0 +1,10 @@
+import { SpruceErrors } from "#spruce/errors/errors.types"
+import { ErrorOptions as ISpruceErrorOptions} from "@sprucelabs/error"
+
+export interface ExecCommandFailedErrorOptions extends SpruceErrors.RegressionproofSnapshotter.ExecCommandFailed, ISpruceErrorOptions {
+	code: 'EXEC_COMMAND_FAILED'
+}
+
+type ErrorOptions =  | ExecCommandFailedErrorOptions 
+
+export default ErrorOptions

package/src/.spruce/errors/regressionproofSnapshotter/execCommandFailed.schema.ts

@@ -0,0 +1,33 @@
+import { SchemaRegistry } from '@sprucelabs/schema'
+import { SpruceErrors } from '../errors.types'
+
+
+
+const execCommandFailedSchema: SpruceErrors.RegressionproofSnapshotter.ExecCommandFailedSchema  = {
+	id: 'execCommandFailed',
+	namespace: 'RegressionproofSnapshotter',
+	name: 'Exec command failed',
+	    fields: {
+	            /** . The command that was attempted */
+	            'command': {
+	                type: 'text',
+	                isRequired: true,
+	                hint: 'The command that was attempted',
+	                options: undefined
+	            },
+	            /** . */
+	            'stdout': {
+	                type: 'text',
+	                options: undefined
+	            },
+	            /** . */
+	            'stderr': {
+	                type: 'text',
+	                options: undefined
+	            },
+	    }
+}
+
+SchemaRegistry.getInstance().trackSchema(execCommandFailedSchema)
+
+export default execCommandFailedSchema

package/src/.spruce/schemas/fields/fieldClassMap.ts

@@ -0,0 +1,6 @@
+import { fieldClassMap } from '@sprucelabs/schema'
+
+
+
+
+export default fieldClassMap

package/src/.spruce/schemas/fields/fields.types.ts

@@ -0,0 +1 @@
+export { FieldDefinitions, FieldDefinitionMap, FieldValueTypeGeneratorMap, FieldMap } from '@sprucelabs/schema'

package/src/.spruce/settings.json

@@ -6,7 +6,9 @@
     "skill"
   ],
   "installed": [
-    "test"
+    "test",
+    "schema",
+    "error"
   ],
   "writer": {
     "skipped": [

package/src/errors/SpruceError.ts

@@ -0,0 +1,29 @@
+import BaseSpruceError from '@sprucelabs/error'
+import ErrorOptions from '#spruce/errors/options.types'
+
+export default class SpruceError extends BaseSpruceError<ErrorOptions> {
+    /** an easy to understand version of the errors */
+    public friendlyMessage(): string {
+        const { options } = this
+        let message
+        switch (options?.code) {
+            case 'EXEC_COMMAND_FAILED':
+                message = `The command "${options.command}" failed to execute.
+                
+Stdout:
+${options.stdout ?? '<no stdout>'}
+
+Stderr:
+${options.stderr ?? '<no stderr>'}`
+                break
+            default:
+                message = super.friendlyMessage()
+        }
+
+        const fullMessage = options.friendlyMessage
+            ? options.friendlyMessage
+            : message
+
+        return fullMessage
+    }
+}

package/src/errors/execCommandFailed.builder.ts

@@ -0,0 +1,19 @@
+import { buildErrorSchema } from '@sprucelabs/schema'
+
+export default buildErrorSchema({
+    id: 'execCommandFailed',
+    name: 'Exec command failed',
+    fields: {
+        command: {
+            type: 'text',
+            isRequired: true,
+            hint: 'The command that was attempted',
+        },
+        stdout: {
+            type: 'text',
+        },
+        stderr: {
+            type: 'text',
+        },
+    },
+})

package/src/git.ts

@@ -2,47 +2,74 @@ import { exec } from 'child_process'
 import { existsSync } from 'fs'
 import path from 'path'
 import { promisify } from 'util'
+import { Log } from '@sprucelabs/spruce-skill-utils'
+import SpruceError from './errors/SpruceError.js'
 import { RemoteOptions } from './snapshotter.types.js'
 
 const execAsync = promisify(exec)
 
-export async function gitCommit(mirrorPath: string): Promise<boolean> {
+export async function gitCommit(
+    mirrorPath: string,
+    log?: Log
+): Promise<boolean> {
     const gitDir = path.join(mirrorPath, '.git')
 
     if (!existsSync(gitDir)) {
-        await execAsync(`git -C "${mirrorPath}" init`)
+        await execOrThrow(`git -C "${mirrorPath}" init`, log)
     }
 
-    await execAsync(`git -C "${mirrorPath}" add -A`)
+    await execOrThrow(`git -C "${mirrorPath}" add -A`, log)
 
-    const { stdout } = await execAsync(
+    const { stdout } = await execOrThrow(
         `git -C "${mirrorPath}" status --porcelain`
     )
     if (!stdout.trim()) {
+        log?.info('No changes detected for commit', mirrorPath)
         return false
     }
 
     const message = `Snapshot ${new Date().toISOString()}`
-    await execAsync(`git -C "${mirrorPath}" commit -m "${message}"`)
+    await execOrThrow(`git -C "${mirrorPath}" commit -m "${message}"`, log)
     return true
 }
 
 export async function gitPush(
     mirrorPath: string,
-    remote: RemoteOptions
+    remote: RemoteOptions,
+    log?: Log
 ): Promise<void> {
     const authedUrl = remote.url.replace('://', `://${remote.token}@`)
 
     try {
-        await execAsync(`git -C "${mirrorPath}" remote get-url origin`)
-        await execAsync(
+        await execOrThrow(`git -C "${mirrorPath}" remote get-url origin`, log)
+        await execOrThrow(
             `git -C "${mirrorPath}" remote set-url origin "${authedUrl}"`
         )
     } catch {
-        await execAsync(
+        await execOrThrow(
             `git -C "${mirrorPath}" remote add origin "${authedUrl}"`
         )
     }
 
-    await execAsync(`git -C "${mirrorPath}" push -u origin HEAD`)
+    await execOrThrow(`git -C "${mirrorPath}" push -u origin HEAD`, log)
+}
+
+async function execOrThrow(
+    command: string,
+    log?: Log
+): Promise<{ stdout: string; stderr: string }> {
+    try {
+        return await execAsync(command)
+    } catch (err) {
+        const error = err as Error & { stdout?: string; stderr?: string }
+        const stdout = error.stdout ?? ''
+        const stderr = error.stderr ?? ''
+        log?.error('Command failed', command, stderr)
+        throw new SpruceError({
+            code: 'EXEC_COMMAND_FAILED',
+            command,
+            stdout,
+            stderr,
+        })
+    }
 }

package/src/snapshot.ts

@@ -1,27 +1,51 @@
 import { mkdirSync, writeFileSync } from 'fs'
 import path from 'path'
+import { buildLog } from '@sprucelabs/spruce-skill-utils'
 import { gitCommit, gitPush } from './git.js'
 import { SnapshotOptions } from './snapshotter.types.js'
 import { syncFiles } from './sync.js'
 
-export async function snapshot(options: SnapshotOptions): Promise<boolean> {
-    const sourcePath = options.sourcePath ?? process.cwd()
-    const { mirrorPath, testResults, remote } = options
+class Snapshotter {
+    private log = buildLog('Snapshotter')
+
+    public async snapshot(options: SnapshotOptions): Promise<boolean> {
+        const sourcePath = options.sourcePath ?? process.cwd()
+        const { mirrorPath, testResults, remote } = options
+
+        this.log.info('Starting snapshot', sourcePath, mirrorPath)
+
+        try {
+            await syncFiles(sourcePath, mirrorPath)
+            this.log.info('Files synced', mirrorPath)
 
-    await syncFiles(sourcePath, mirrorPath)
+            const snapshotterDir = path.join(mirrorPath, '.snapshotter')
+            mkdirSync(snapshotterDir, { recursive: true })
+            writeFileSync(
+                path.join(snapshotterDir, 'testResults.json'),
+                JSON.stringify(testResults, null, 2)
+            )
+            this.log.info('Test results saved', snapshotterDir)
 
-    const snapshotterDir = path.join(mirrorPath, '.snapshotter')
-    mkdirSync(snapshotterDir, { recursive: true })
-    writeFileSync(
-        path.join(snapshotterDir, 'testResults.json'),
-        JSON.stringify(testResults, null, 2)
-    )
+            const committed = await gitCommit(mirrorPath, this.log)
 
-    const committed = await gitCommit(mirrorPath)
+            if (!committed) {
+                this.log.info('No changes to commit', mirrorPath)
+                return false
+            }
 
-    if (committed) {
-        await gitPush(mirrorPath, remote)
+            this.log.info('Commit created, pushing', remote.url)
+            await gitPush(mirrorPath, remote, this.log)
+            this.log.info('Push completed', remote.url)
+
+            return true
+        } catch (err) {
+            const message = err instanceof Error ? err.message : String(err)
+            this.log.error('Snapshot failed', message)
+            throw err
+        }
     }
+}
 
-    return committed
+export async function snapshot(options: SnapshotOptions): Promise<boolean> {
+    return new Snapshotter().snapshot(options)
 }