@regressionproof/snapshotter 0.0.1

package/.nvmrc

@@ -0,0 +1 @@
+lts/*

package/.vscode/launch.json

@@ -0,0 +1,58 @@
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"type": "node",
+			"request": "attach",
+			"name": "attach.tests",
+			"port": 5200,
+			"restart": true,
+			"timeout": 10000
+		},
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "test.file",
+			"runtimeExecutable": "node",
+			"runtimeArgs": [
+				"--inspect-brk",
+				"--trace-warnings",
+				"${workspaceFolder}/node_modules/.bin/jest",
+				"${fileBasenameNoExtension}",
+				"--detectOpenHandles"
+			],
+			"cwd": "${workspaceFolder}",
+			"console": "integratedTerminal",
+			"internalConsoleOptions": "neverOpen"
+		},
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "test.all",
+			"runtimeExecutable": "node",
+			"runtimeArgs": [
+				"--inspect-brk",
+				"--trace-warnings",
+				"${workspaceFolder}/node_modules/.bin/jest"
+			],
+			"cwd": "${workspaceFolder}",
+			"console": "integratedTerminal",
+			"internalConsoleOptions": "neverOpen"
+		},
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "boot",
+			"runtimeExecutable": "yarn",
+			"runtimeArgs": [
+				"run",
+				"--inspect-brk",
+				"--trace-warnings",
+				"boot"
+			],
+			"cwd": "${workspaceFolder}",
+			"console": "integratedTerminal",
+			"internalConsoleOptions": "neverOpen"
+		}
+	]
+}

package/.vscode/settings.json

@@ -0,0 +1,67 @@
+{
+	"debug.node.autoAttach": "on",
+	"git.ignoreLimitWarning": true,
+	"javascript.validate.enable": false,
+	"files.watcherExclude": {
+		"**/.git/objects/**": true,
+		"**/.git/subtree-cache/**": true,
+		"**/build/**": true,
+		"**/node_modules/**": true,
+	},
+	"search.exclude": {
+		"**/build/**": true,
+		"**/node_modules/**": true,
+		"**/.next/**": true
+	},
+	"editor.maxTokenizationLineLength": 20000000,
+	"[javascript]": {
+		"editor.formatOnSave": false
+	},
+	"[javascriptreact]": {
+		"editor.formatOnSave": false
+	},
+	"[typescript]": {
+		"editor.formatOnSave": false
+	},
+	"[typescriptreact]": {
+		"editor.formatOnSave": false
+	},
+	"[handlebars]": {
+		"editor.formatOnSave": false
+	},
+	"typescript.tsdk": "node_modules/typescript/lib",
+	"cSpell.ignorePaths": [
+		"**/package-lock.json",
+		"**/node_modules/**",
+		"**/build/**",
+		"**/vscode-extension/**",
+		"**/.git/objects/**",
+		".vscode",
+		".spruce"
+	],
+	"cSpell.words": [
+		"arkit",
+		"autogenerated",
+		"scrollable",
+		"serializable"
+	],
+	"debug.javascript.unmapMissingSources": true,
+	"javascript.preferences.importModuleSpecifier": "relative",
+	"typescript.preferences.importModuleSpecifier": "relative",
+	"eslint.useFlatConfig": true,
+	"eslint.enable": true,
+	"eslint.validate": [
+		"javascript",
+		"javascriptreact",
+		"typescript",
+		"typescriptreact"
+	],
+	"eslint.workingDirectories": [
+		"./"
+	],
+	"typescript.validate.enable": true,
+	"editor.formatOnSave": false,
+	"editor.codeActionsOnSave": {
+		"source.fixAll.eslint": "always"
+	}
+}

package/.vscode/tasks.json

@@ -0,0 +1,112 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "npm",
+            "script": "watch.build.dev",
+            "group": "build",
+            "label": "watch.build.dev & problem.watcher",
+            "isBackground": true,
+            "runOptions": {
+                "runOn": "folderOpen"
+            },
+            "promptOnClose": false,
+            "presentation": {
+                "focus": false,
+                "reveal": "never"
+            },
+            "problemMatcher": {
+                "base": "$tsc-watch",
+                "applyTo": "allDocuments"
+            }
+        },
+        {
+            "label": "test.file",
+            "command": "spruce",
+            "args": [
+                "test",
+                "--inspect",
+                "5200",
+                "--pattern",
+                "${fileBasenameNoExtension}",
+                "--watchMode",
+                "standard"
+            ],
+            "promptOnClose": false,
+            "group": {
+                "kind": "test",
+                "isDefault": true
+            },
+            "presentation": {
+                "reveal": "always",
+                "panel": "dedicated",
+            },
+            "problemMatcher": []
+        },
+        {
+            "label": "test.reporter",
+            "command": "spruce",
+            "args": [
+                "test",
+                "--shouldHoldAtStart",
+                "true",
+                "--watchMode",
+                "smart"
+            ],
+            "promptOnClose": false,
+            "group": "test",
+            "runOptions": {
+                "runOn": "folderOpen"
+            },
+            "presentation": {
+                "panel": "shared",
+                "focus": true,
+                "reveal": "always"
+            }
+        },
+        {
+            "label": "spruce",
+            "type": "shell",
+            "command": "spruce ${input:spruceCommand}",
+            "problemMatcher": [],
+            "presentation": {
+                "reveal": "always",
+                "focus": true,
+                "panel": "new",
+                "clear": false
+            }
+        },
+        {
+            "label": "shell",
+            "type": "shell",
+            "command": "${input:command} ${input:optionsCommand}",
+            "problemMatcher": [],
+            "presentation": {
+                "reveal": "always",
+                "focus": true,
+                "panel": "new",
+                "clear": false
+            }
+        }
+    ],
+    "inputs": [
+        {
+            "id": "spruceCommand",
+            "description": "spruce command",
+            "default": "create.test",
+            "type": "promptString"
+        },
+        {
+            "id": "command",
+            "description": "command",
+            "default": "yarn",
+            "type": "promptString"
+        },
+        {
+            "id": "optionsCommand",
+            "description": "optionsCommand",
+            "default": "add",
+            "type": "promptString"
+        }
+    ]
+}

package/eslint.config.mjs

@@ -0,0 +1,3 @@
+import eslintConfigSpruce from 'eslint-config-spruce'
+
+export default eslintConfigSpruce

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@regressionproof/snapshotter",
+  "version": "0.0.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "module": "./build/esm/index.js",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./build/esm/index.d.ts",
+        "default": "./build/esm/index.js"
+      },
+      "require": {
+        "types": "./build/index.d.ts",
+        "default": "./build/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "build.ci": "yarn run build.tsc && yarn run build.resolve-paths && yarn run lint",
+    "build.dev": "yarn run build.tsc --sourceMap ; yarn run resolve-paths.lint",
+    "build.copy-files": "mkdir -p build && rsync -avzq --exclude='*.ts' ./src/ ./build/",
+    "build.resolve-paths": "resolve-path-aliases --target build --patterns '**/*.js,**/*.d.ts'",
+    "build.tsc": "yarn run build.copy-files && tsc",
+    "build.dist": "tsc --project tsconfig.dist.json && yarn build.resolve-paths && mv build esm && yarn build.esm-postbuild && yarn build.tsc && yarn build.resolve-paths && mv esm build/",
+    "build.esm-postbuild": "esm-postbuild --target esm --patterns '**/*.js'",
+    "clean": "yarn run clean.build",
+    "clean.all": "yarn run clean.dependencies && yarn run clean.build",
+    "clean.build": "rm -rf build/",
+    "clean.dependencies": "rm -rf node_modules/ package-lock.json yarn.lock",
+    "fix.lint": "eslint --fix --cache '**/*.ts'",
+    "lint": "eslint --cache '**/*.ts'",
+    "lint.tsc": "tsc -p . --noEmit",
+    "post.watch.build": "yarn run build.copy-files && yarn run build.resolve-paths",
+    "rebuild": "yarn run clean.all && yarn install && yarn run build.dev",
+    "update.dependencies": "yarn run clean.dependencies && yarn",
+    "resolve-paths.lint": "yarn run build.resolve-paths ; yarn run lint",
+    "test": "jest --passWithNoTests",
+    "test.manual": "node --env-file=.env build/scripts/testManual.js",
+    "watch.build.dev": "tsc-watch --sourceMap --onCompilationComplete 'yarn run post.watch.build'",
+    "watch.rebuild": "yarn run clean.all && yarn install && yarn run watch.build.dev",
+    "watch.tsc": "tsc -w"
+  },
+  "devDependencies": {
+    "@sprucelabs/esm-postbuild": "^9.0.13",
+    "@sprucelabs/jest-json-reporter": "^10.0.19",
+    "@sprucelabs/resolve-path-aliases": "^4.0.13",
+    "@sprucelabs/test": "^11.1.0",
+    "@sprucelabs/test-utils": "^7.2.3",
+    "@types/node": "^25.0.6",
+    "chokidar-cli": "^3.0.0",
+    "eslint": "^9.39.2",
+    "eslint-config-spruce": "^11.2.26",
+    "jest": "^30.2.0",
+    "jest-circus": "^30.2.0",
+    "prettier": "^3.7.4",
+    "ts-node": "^10.9.2",
+    "tsc-watch": "^7.2.0",
+    "typescript": "^5.9.3"
+  },
+  "description": "Take snapshots of your TDD project to be used for LLM training data",
+  "skill": {
+    "namespace": "regressionproof-snapshotter"
+  },
+  "jest": {
+    "testRunner": "jest-circus/runner",
+    "maxWorkers": 4,
+    "testTimeout": 120000,
+    "testEnvironment": "node",
+    "testPathIgnorePatterns": [
+      "<rootDir>/tmp/",
+      "<rootDir>/src/",
+      "<rootDir>/node_modules/",
+      "<rootDir>/build/__tests__/testDirsAndFiles/"
+    ],
+    "testMatch": [
+      "**/__tests__/**/*.test.js?(x)"
+    ],
+    "moduleNameMapper": {
+      "^#spruce/(.*)$": "<rootDir>/build/.spruce/$1"
+    }
+  },
+  "dependencies": {}
+}

package/src/.spruce/settings.json

@@ -0,0 +1,16 @@
+{
+  "scriptUpdater": {
+    "skipped": []
+  },
+  "skipped": [
+    "skill"
+  ],
+  "installed": [
+    "test"
+  ],
+  "writer": {
+    "skipped": [
+      "tsconfig.json"
+    ]
+  }
+}

package/src/git.ts

@@ -0,0 +1,48 @@
+import { exec } from 'child_process'
+import { existsSync } from 'fs'
+import path from 'path'
+import { promisify } from 'util'
+import { RemoteOptions } from './snapshotter.types.js'
+
+const execAsync = promisify(exec)
+
+export async function gitCommit(mirrorPath: string): Promise<boolean> {
+    const gitDir = path.join(mirrorPath, '.git')
+
+    if (!existsSync(gitDir)) {
+        await execAsync(`git -C "${mirrorPath}" init`)
+    }
+
+    await execAsync(`git -C "${mirrorPath}" add -A`)
+
+    const { stdout } = await execAsync(
+        `git -C "${mirrorPath}" status --porcelain`
+    )
+    if (!stdout.trim()) {
+        return false
+    }
+
+    const message = `Snapshot ${new Date().toISOString()}`
+    await execAsync(`git -C "${mirrorPath}" commit -m "${message}"`)
+    return true
+}
+
+export async function gitPush(
+    mirrorPath: string,
+    remote: RemoteOptions
+): Promise<void> {
+    const authedUrl = remote.url.replace('://', `://${remote.token}@`)
+
+    try {
+        await execAsync(`git -C "${mirrorPath}" remote get-url origin`)
+        await execAsync(
+            `git -C "${mirrorPath}" remote set-url origin "${authedUrl}"`
+        )
+    } catch {
+        await execAsync(
+            `git -C "${mirrorPath}" remote add origin "${authedUrl}"`
+        )
+    }
+
+    await execAsync(`git -C "${mirrorPath}" push -u origin HEAD`)
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export { snapshot } from './snapshot.js'
+export * from './snapshotter.types.js'

package/src/scripts/testManual.ts

@@ -0,0 +1,55 @@
+import { snapshot } from '../index'
+
+async function main() {
+    const sourcePath = process.env.SOURCE_PATH
+    const mirrorPath = process.env.MIRROR_PATH
+    const remoteUrl = process.env.REMOTE_URL
+    const remoteToken = process.env.REMOTE_TOKEN
+
+    if (!sourcePath || !mirrorPath || !remoteUrl || !remoteToken) {
+        console.error('Missing required env vars. See .env.example')
+        process.exit(1)
+    }
+
+    console.log('Running snapshot...')
+    console.log('  Source:', sourcePath)
+    console.log('  Mirror:', mirrorPath)
+    console.log('  Remote:', remoteUrl)
+
+    const result = await snapshot({
+        sourcePath,
+        mirrorPath,
+        testResults: {
+            timestamp: new Date().toISOString(),
+            summary: {
+                totalSuites: 1,
+                passedSuites: 1,
+                failedSuites: 0,
+                totalTests: 2,
+                passedTests: 2,
+                failedTests: 0,
+            },
+            suites: [
+                {
+                    path: 'src/__tests__/Example.test.ts',
+                    passed: true,
+                    tests: [
+                        { name: 'should work', passed: true },
+                        { name: 'should also work', passed: true },
+                    ],
+                },
+            ],
+        },
+        remote: {
+            url: remoteUrl,
+            token: remoteToken,
+        },
+    })
+
+    console.log('Snapshot created:', result)
+}
+
+main().catch((err) => {
+    console.error('Error:', err.message)
+    process.exit(1)
+})

package/src/snapshot.ts

@@ -0,0 +1,27 @@
+import { mkdirSync, writeFileSync } from 'fs'
+import path from 'path'
+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
+
+    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)
+    )
+
+    const committed = await gitCommit(mirrorPath)
+
+    if (committed) {
+        await gitPush(mirrorPath, remote)
+    }
+
+    return committed
+}

package/src/snapshotter.types.ts

@@ -0,0 +1,59 @@
+export interface TestResult {
+    /** Name of the individual test */
+    name: string
+    /** Whether this test passed */
+    passed: boolean
+    /** Full error message + callstack (only present if failed) */
+    error?: string
+}
+
+export interface SuiteResult {
+    /** Path to test file, relative to project root */
+    path: string
+    /** Whether all tests in suite passed */
+    passed: boolean
+    /** Array of test results */
+    tests: TestResult[]
+}
+
+export interface TestResultsSummary {
+    /** Total number of test suites (files) */
+    totalSuites: number
+    /** Number of suites with all tests passing */
+    passedSuites: number
+    /** Number of suites with at least one failure */
+    failedSuites: number
+    /** Total number of individual tests */
+    totalTests: number
+    /** Number of passing tests */
+    passedTests: number
+    /** Number of failing tests */
+    failedTests: number
+}
+
+export interface TestResults {
+    /** ISO 8601 timestamp of when test run completed */
+    timestamp: string
+    /** Summary counts */
+    summary: TestResultsSummary
+    /** Array of suite results */
+    suites: SuiteResult[]
+}
+
+export interface RemoteOptions {
+    /** Gitea repo URL to push to */
+    url: string
+    /** Gitea access token for authentication */
+    token: string
+}
+
+export interface SnapshotOptions {
+    /** Source project path to sync from. Defaults to process.cwd() */
+    sourcePath?: string
+    /** Mirror directory path where the isolated git repo lives */
+    mirrorPath: string
+    /** Test results from the completed test run */
+    testResults: TestResults
+    /** Remote Gitea repo to push to */
+    remote: RemoteOptions
+}

package/src/sync.ts

@@ -0,0 +1,35 @@
+import { exec } from 'child_process'
+import { existsSync } from 'fs'
+import path from 'path'
+import { promisify } from 'util'
+
+const execAsync = promisify(exec)
+
+const DEFAULT_EXCLUDES = [
+    'node_modules',
+    'build',
+    '*.env*',
+    '*.pem',
+    '*.key',
+    '*.p12',
+    '*.pfx',
+    '*credentials*',
+    '*secret*',
+    '*.local',
+]
+
+export async function syncFiles(
+    sourcePath: string,
+    mirrorPath: string
+): Promise<void> {
+    const hasGitIgnore = existsSync(path.join(sourcePath, '.gitignore'))
+    const excludes = DEFAULT_EXCLUDES.map((e) => `--exclude='${e}'`).join(' ')
+
+    if (hasGitIgnore) {
+        const cmd = `cd "${sourcePath}" && git ls-files --cached --others --exclude-standard -z | rsync -av --files-from=- --from0 ${excludes} . "${mirrorPath}/"`
+        await execAsync(cmd)
+    } else {
+        const cmd = `rsync -av --delete ${excludes} "${sourcePath}/" "${mirrorPath}/"`
+        await execAsync(cmd)
+    }
+}

package/tsconfig.dist.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "module": "ES2020",
+    "target": "ES6",
+    "lib": ["ES2020", "DOM"],
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "declaration": true,
+    "noImplicitAny": true,
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitReturns": true,
+    "strict": true,
+    "noUnusedLocals": true,
+    "resolveJsonModule": true,
+    "sourceMap": false,
+    "outDir": "./build",
+    "baseUrl": "src",
+    "experimentalDecorators": true,
+    "paths": {
+      "#spruce/*": [".spruce/*"]
+    }
+  },
+  "include": ["./src/*.ts", "./src/**/*.ts"],
+  "exclude": ["**/node_modules/*", "build/*", "esm/*"]
+}

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "skipLibCheck": true,
+    "module": "CommonJS",
+    "esModuleInterop": true,
+    "target": "ES2020",
+    "lib": ["DOM", "ES2022"],
+    "declaration": true,
+    "noImplicitAny": true,
+    "allowJs": true,
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitReturns": true,
+    "strict": true,
+    "noUnusedLocals": true,
+    "resolveJsonModule": true,
+    "moduleResolution": "node",
+    "sourceMap": false,
+    "outDir": "build",
+    "baseUrl": "src",
+    "experimentalDecorators": true,
+    "paths": {
+      "#spruce/*": [".spruce/*"]
+    }
+  },
+  "include": ["./src/*.ts", "./src/**/*.ts", "./src/.spruce/**/*"],
+  "exclude": ["build", "esm"]
+}