@reshotdev/screenshot 0.0.1-beta.4 → 0.0.1-beta.6

package/README.md

@@ -30,7 +30,7 @@ reshot studio
 
 ## Configuration
 
-Create `docsync.config.json` in your project root:
+Create `reshot.config.json` in your project root:
 
 ```json
 {
@@ -221,7 +221,7 @@ During recording:
 - Press **C** to start/stop a video clip
 - Press **Q** to quit and save
 
-The recorded scenario is appended to `docsync.config.json` automatically.
+The recorded scenario is appended to `reshot.config.json` automatically.
 
 ## Authentication
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reshotdev/screenshot",
-  "version": "0.0.1-beta.4",
+  "version": "0.0.1-beta.6",
   "description": "CI/CD screenshot and video capture CLI",
   "author": "Reshot <hello@reshot.dev>",
   "license": "MIT",
@@ -13,7 +13,14 @@
   "publishConfig": {
     "access": "public"
   },
-  "keywords": ["screenshots", "ci-cd", "documentation", "visual-testing", "automation", "playwright"],
+  "keywords": [
+    "screenshots",
+    "ci-cd",
+    "documentation",
+    "visual-testing",
+    "automation",
+    "playwright"
+  ],
   "bin": {
     "reshot": "./src/index.js"
   },

package/src/commands/auth.js

@@ -145,9 +145,7 @@ async function verifyApiKey(apiBaseUrl, apiKey) {
 async function authCommand() {
   const apiBaseUrl = getApiBaseUrl();
   const explicitPortEnv =
-    process.env.RESHOT_CLI_CALLBACK_PORT ||
-    process.env.DOCSYNC_CLI_CALLBACK_PORT ||
-    "";
+    process.env.RESHOT_CLI_CALLBACK_PORT || "";
   const basePort = parseInt(explicitPortEnv || `${DEFAULT_CALLBACK_PORT}`, 10);
   const hasExplicitPort = Boolean(explicitPortEnv);
 

package/src/commands/ci-setup.js

@@ -37,7 +37,7 @@ jobs:
       - name: Install ffmpeg
         run: sudo apt-get update && sudo apt-get install -y ffmpeg
       
-      # Generate visual assets from docsync.config.json blueprint
+      # Generate visual assets from reshot.config.json blueprint
       # Only runs if features.visuals is enabled for the project
       - name: Run Reshot scenarios
         env:
@@ -205,7 +205,7 @@ async function ciSetupCommand() {
 
   switch (provider) {
     case 'github':
-      workflowPath = path.join(process.cwd(), '.github', 'workflows', 'docsync.yml');
+      workflowPath = path.join(process.cwd(), '.github', 'workflows', 'reshot.yml');
       workflowContent = GITHUB_ACTIONS_WORKFLOW(secretNames);
       break;
     

package/src/commands/drifts.js

@@ -12,7 +12,7 @@
  * - reshot drifts sync <id>     Mark as manually synced (external_host)
  * - reshot drifts approve-all   Approve all pending drifts
  * - reshot drifts reject-all    Reject all pending drifts
- * - reshot drifts validate      Validate journey bindings against visual inventory
+ * - reshot drifts approve-all   Approve all pending drifts
  */
 
 const chalk = require("chalk");
@@ -273,76 +273,16 @@ async function batchDriftAction(apiKey, projectId, action, options = {}) {
   }
 }
 
-/**
- * Validate journey bindings against visual inventory
- */
-async function validateBindings(apiKey, projectId, options = {}) {
-  console.log(chalk.blue("\n🔍 Validating Journey Bindings\n"));
-
-  try {
-    // Fetch visual keys from server
-    const visualKeys = await apiClient.getVisualKeys(projectId, apiKey);
-    console.log(chalk.green(`  ✓ Fetched ${visualKeys.size} visual keys from project`));
-
-    // Read docsync config
-    const docSyncConfig = config.readDocSyncConfig();
-    const docConfig = docSyncConfig.documentation;
-
-    if (!docConfig || !docConfig.root) {
-      console.log(chalk.yellow("  ⚠ No documentation.root configured"));
-      return;
-    }
-
-    // Use the validate-docs module for full validation
-    const validateDocs = require("./validate-docs");
-    const result = await validateDocs.validateDocSync({
-      strict: options.strict,
-      verbose: options.verbose,
-    });
-
-    // Additional server-side validation: check if any journey keys in the project
-    // are not bound to any documentation
-    const mappings = docConfig.mappings || {};
-    const boundKeys = new Set(Object.values(mappings));
-
-    const orphanedVisuals = [];
-    for (const key of visualKeys) {
-      if (!boundKeys.has(key)) {
-        orphanedVisuals.push(key);
-      }
-    }
-
-    if (orphanedVisuals.length > 0) {
-      console.log(chalk.yellow(`\n  ⚠ ${orphanedVisuals.length} visual(s) not bound to documentation:`));
-      if (options.verbose) {
-        orphanedVisuals.slice(0, 10).forEach((key) => {
-          console.log(chalk.gray(`      - ${key}`));
-        });
-        if (orphanedVisuals.length > 10) {
-          console.log(chalk.gray(`      ... and ${orphanedVisuals.length - 10} more`));
-        }
-      }
-    }
-
-    if (!result.valid) {
-      process.exit(1);
-    }
-  } catch (error) {
-    console.error(chalk.red("Error:"), error.message);
-    process.exit(1);
-  }
-}
-
 /**
  * Main drifts command handler
  */
 async function driftsCommand(subcommand, args = [], options = {}) {
   // Read configuration
-  let docSyncConfig;
+  let reshotConfig;
   try {
-    docSyncConfig = config.readDocSyncConfig();
+    reshotConfig = config.readConfigLenient();
   } catch (error) {
-    console.error(chalk.red("Error:"), "docsync.config.json not found. Run `reshot init` first.");
+    console.error(chalk.red("Error:"), "reshot.config.json not found. Run `reshot init` first.");
     process.exit(1);
   }
 
@@ -352,7 +292,7 @@ async function driftsCommand(subcommand, args = [], options = {}) {
   const projectId =
     process.env.RESHOT_PROJECT_ID ||
     settings?.projectId ||
-    docSyncConfig._metadata?.projectId;
+    reshotConfig._metadata?.projectId;
 
   if (!apiKey) {
     console.error(chalk.red("Error:"), "API key not found. Set RESHOT_API_KEY or run `reshot auth`.");
@@ -398,10 +338,6 @@ async function driftsCommand(subcommand, args = [], options = {}) {
       await batchDriftAction(apiKey, projectId, "reject", options);
       break;
 
-    case "validate":
-      await validateBindings(apiKey, projectId, options);
-      break;
-
     default:
       console.error(chalk.red("Error:"), `Unknown subcommand: ${subcommand}`);
       console.log(chalk.gray("\nAvailable subcommands:"));
@@ -413,7 +349,6 @@ async function driftsCommand(subcommand, args = [], options = {}) {
       console.log(chalk.white("  sync        ") + chalk.gray("Mark as manually synced"));
       console.log(chalk.white("  approve-all ") + chalk.gray("Approve all pending drifts"));
       console.log(chalk.white("  reject-all  ") + chalk.gray("Reject all pending drifts"));
-      console.log(chalk.white("  validate    ") + chalk.gray("Validate journey bindings"));
       process.exit(1);
   }
 

package/src/commands/import-tests.js

@@ -250,7 +250,7 @@ async function importTestsCommand(options = {}) {
       {
         type: "confirm",
         name: "confirm",
-        message: "Save these mappings to docsync.config.json?",
+        message: "Save these mappings to reshot.config.json?",
         default: true,
       },
     ]);
@@ -261,36 +261,36 @@ async function importTestsCommand(options = {}) {
     }
   }
 
-  // Update docsync.config.json
-  let docSyncConfig;
+  // Update reshot.config.json
+  let reshotConfig;
   try {
-    // Try to read existing config (use readDocSyncConfig which is less strict)
-    docSyncConfig = config.readDocSyncConfig();
+    // Try to read existing config (use readConfigLenient which is less strict)
+    reshotConfig = config.readConfigLenient();
   } catch {
     // Create new config with minimal required fields
-    docSyncConfig = {
-      $schema: "https://reshot.dev/schemas/docsync-config.json",
+    reshotConfig = {
+      $schema: "https://reshot.dev/schemas/reshot-config.json",
       version: "2.0",
       scenarios: [],
     };
   }
 
   // Add visuals section with trace mappings
-  docSyncConfig.visuals = {
-    ...docSyncConfig.visuals,
+  reshotConfig.visuals = {
+    ...reshotConfig.visuals,
     traceDir: pwConfig.outputDir,
     journeyMappings,
   };
 
   // Ensure scenarios array exists for config.readConfig() compatibility
-  if (!docSyncConfig.scenarios) {
-    docSyncConfig.scenarios = [];
+  if (!reshotConfig.scenarios) {
+    reshotConfig.scenarios = [];
   }
 
-  config.writeConfig(docSyncConfig);
+  config.writeConfig(reshotConfig);
 
   console.log(
-    chalk.green("\n✓ Updated docsync.config.json with journey mappings"),
+    chalk.green("\n✓ Updated reshot.config.json with journey mappings"),
   );
   console.log(chalk.gray("\nNext steps:"));
   console.log(

package/src/commands/ingest.js

@@ -1,5 +1,5 @@
-// ingest.js - Upload traces and documentation for DocSync processing
-// Implements the "Smart Handoff" protocol from the DocSync specification
+// ingest.js - Upload traces and documentation for Reshot processing
+// Implements the "Smart Handoff" protocol from the Reshot specification
 
 const chalk = require("chalk");
 const crypto = require("crypto");
@@ -51,7 +51,7 @@ function parseFrontmatter(content) {
 }
 
 /**
- * Discover documentation files based on docsync.config.json
+ * Discover documentation files based on reshot.config.json
  */
 async function discoverDocumentation(docConfig, projectRoot) {
   const files = [];
@@ -267,14 +267,14 @@ async function commitIngestion(apiKey, projectId, uploadResults, git, cliVersion
  * Main ingest command
  */
 async function ingestCommand(options = {}) {
-  console.log(chalk.blue('\n📥 Reshot DocSync Ingest\n'));
+  console.log(chalk.blue('\n📥 Reshot Reshot Ingest\n'));
   
   // Read configuration
-  let docSyncConfig;
+  let reshotConfig;
   try {
-    docSyncConfig = config.readDocSyncConfig();
+    reshotConfig = config.readConfigLenient();
   } catch (error) {
-    console.error(chalk.red('Error:'), 'docsync.config.json not found. Run `reshot init` first.');
+    console.error(chalk.red('Error:'), 'reshot.config.json not found. Run `reshot init` first.');
     process.exit(1);
   }
   
@@ -283,7 +283,7 @@ async function ingestCommand(options = {}) {
   const apiKey = process.env.RESHOT_API_KEY || settings?.apiKey;
   const projectId = process.env.RESHOT_PROJECT_ID || 
                     settings?.projectId || 
-                    docSyncConfig._metadata?.projectId;
+                    reshotConfig._metadata?.projectId;
   
   if (!apiKey) {
     console.error(chalk.red('Error:'), 'API key not found. Set RESHOT_API_KEY or run `reshot auth`.');
@@ -296,9 +296,9 @@ async function ingestCommand(options = {}) {
   }
   
   // Validate documentation configuration
-  const docConfig = docSyncConfig.documentation;
+  const docConfig = reshotConfig.documentation;
   if (!docConfig) {
-    console.error(chalk.red('Error:'), 'No "documentation" block found in docsync.config.json');
+    console.error(chalk.red('Error:'), 'No "documentation" block found in reshot.config.json');
     process.exit(1);
   }
   

package/src/commands/init.js

@@ -14,123 +14,10 @@ const {
   getConfigDefaults,
 } = require("../lib/standalone-mode");
 
-/**
- * Auto-detect documentation directories
- */
-function detectDocumentationRoot() {
-  const commonPaths = [
-    "docs",
-    "documentation",
-    "content",
-    "doc",
-    "guides",
-    ".vitepress/content",
-    ".docusaurus/docs",
-  ];
-
-  for (const dir of commonPaths) {
-    const fullPath = path.join(process.cwd(), dir);
-    if (fs.existsSync(fullPath) && fs.statSync(fullPath).isDirectory()) {
-      // Check if it has markdown files
-      const files = fs.readdirSync(fullPath);
-      if (files.some((f) => f.endsWith(".md") || f.endsWith(".mdx"))) {
-        return dir;
-      }
-    }
-  }
-
-  return null;
-}
-
-/**
- * Generate documentation block configuration
- */
-function generateDocumentationConfig(root = "./docs", strategy = "git_pr") {
-  return {
-    root,
-    include: ["**/*.md", "**/*.mdx"],
-    exclude: ["**/_*.mdx", "**/node_modules/**", "**/.next/**"],
-    strategy,
-    assetFormat: "markdown",
-    mappings: {},
-  };
-}
-
-/**
- * Scaffold a basic documentation structure
- */
-async function scaffoldDocumentation() {
-  const docsDir = path.join(process.cwd(), "docs");
-
-  // Create docs directory
-  fs.ensureDirSync(docsDir);
-
-  // Create README
-  const readmeContent = `# Documentation
-
-This directory contains documentation for your project.
-
-## Getting Started
-
-Documentation files are automatically synced with your codebase using Reshot DocSync.
-
-### Linking Docs to Visuals
-
-Add frontmatter to your markdown files to link them to visual journeys:
-
-\`\`\`markdown
----
-title: "Feature Name"
-reshot_journey: "feature/workflow-name"
----
-
-# Feature Documentation
-
-Your content here...
-\`\`\`
-
-## Commands
-
-- \`reshot validate\` - Validate documentation configuration
-- \`reshot ingest\` - Upload traces and documentation
-- \`reshot drifts\` - View and manage documentation drifts
-
-For more information, visit: https://docs.reshot.dev
-`;
-
-  fs.writeFileSync(path.join(docsDir, "README.md"), readmeContent);
-
-  // Create example doc
-  const exampleContent = `---
-title: "Getting Started"
-reshot_journey: "onboarding/first-steps"
-description: "Quick start guide for new users"
----
-
-# Getting Started
-
-Welcome! This is an example documentation file.
-
-## Steps
-
-1. **Step 1**: Description of first step
-2. **Step 2**: Description of second step
-3. **Step 3**: Description of third step
-
-## Next Steps
-
-Continue to the next guide...
-`;
-
-  fs.writeFileSync(path.join(docsDir, "getting-started.md"), exampleContent);
-
-  return "docs";
-}
-
 async function initCommand() {
   console.log(chalk.cyan("🚀 Initializing Reshot...\n"));
 
-  // Check if we already have a docsync.config.json with BYOS storage config
+  // Check if we already have a reshot.config.json with BYOS storage config
   let existingConfig = null;
   let isBYOSMode = false;
 
@@ -272,7 +159,7 @@ async function initCommand() {
 
     // Create a basic BYOS config with sane defaults
     const byosConfig = {
-      $schema: "https://reshot.dev/schemas/docsync-config.json",
+      $schema: "https://reshot.dev/schemas/reshot-config.json",
       version: "2.0",
       baseUrl: "http://localhost:3000",
       assetDir: ".reshot/output",
@@ -359,7 +246,7 @@ async function initCommand() {
 
     console.log(
       chalk.green(
-        "\n✔ Created docsync.config.json with BYOS storage configuration"
+        "\n✔ Created reshot.config.json with BYOS storage configuration"
       )
     );
     console.log(chalk.cyan("\nNext steps:"));
@@ -396,13 +283,13 @@ async function initCommand() {
           name: "overwrite",
           default: false,
           message:
-            "docsync.config.json already exists. Overwrite it with the latest blueprint?",
+            "reshot.config.json already exists. Overwrite it with the latest blueprint?",
         },
       ]);
       overwrite = answer.overwrite;
 
       if (!overwrite) {
-        console.log(chalk.yellow("⚠ Existing docsync.config.json preserved."));
+        console.log(chalk.yellow("⚠ Existing reshot.config.json preserved."));
         return;
       }
     }
@@ -412,132 +299,8 @@ async function initCommand() {
         overwrite,
       });
 
-      // Auto-detect and configure documentation
-      console.log(chalk.cyan("\n📚 Configuring documentation sync..."));
-
-      let docsRoot = detectDocumentationRoot();
-      let shouldScaffold = false;
-
-      if (!docsRoot) {
-        console.log(chalk.yellow("  No documentation directory detected."));
-
-        const { action } = await inquirer.prompt([
-          {
-            type: "list",
-            name: "action",
-            message: "Would you like to:",
-            choices: [
-              {
-                name: "Create a new docs/ directory with examples",
-                value: "scaffold",
-              },
-              { name: "Specify an existing directory", value: "specify" },
-              { name: "Skip documentation setup (add later)", value: "skip" },
-            ],
-          },
-        ]);
-
-        if (action === "scaffold") {
-          console.log(chalk.cyan("  Creating docs/ directory..."));
-          docsRoot = await scaffoldDocumentation();
-          shouldScaffold = true;
-          console.log(chalk.green("  ✔ Created docs/ with example files"));
-        } else if (action === "specify") {
-          const { customPath } = await inquirer.prompt([
-            {
-              type: "input",
-              name: "customPath",
-              message: "Documentation directory path:",
-              default: "./docs",
-              validate: (input) => {
-                const fullPath = path.join(process.cwd(), input);
-                if (!fs.existsSync(fullPath)) {
-                  return `Directory ${input} does not exist. Create it first or choose scaffold option.`;
-                }
-                return true;
-              },
-            },
-          ]);
-          docsRoot = customPath;
-        }
-      } else {
-        console.log(chalk.green(`  ✔ Detected documentation at: ${docsRoot}`));
-      }
-
-      // Add documentation block to config
-      if (docsRoot) {
-        // Detect if this is a GitHub repo for strategy recommendation
-        const isGitRepo = fs.existsSync(path.join(process.cwd(), ".git"));
-        const hasGitHubRemote =
-          isGitRepo &&
-          (() => {
-            try {
-              const { execSync } = require("child_process");
-              const remote = execSync("git remote get-url origin", {
-                encoding: "utf-8",
-              });
-              return remote.includes("github.com");
-            } catch {
-              return false;
-            }
-          })();
-
-        let strategy = "git_pr";
-
-        if (hasGitHubRemote) {
-          console.log(chalk.cyan("  ✔ Detected GitHub repository"));
-          const { useGitPR } = await inquirer.prompt([
-            {
-              type: "confirm",
-              name: "useGitPR",
-              message:
-                "Automatically create Pull Requests for documentation updates?",
-              default: true,
-            },
-          ]);
-          strategy = useGitPR ? "git_pr" : "external_host";
-        } else {
-          const { strategyChoice } = await inquirer.prompt([
-            {
-              type: "list",
-              name: "strategyChoice",
-              message: "How should documentation updates be delivered?",
-              choices: [
-                {
-                  name: "Git Pull Requests (recommended for GitHub/GitLab repos)",
-                  value: "git_pr",
-                },
-                {
-                  name: "Notifications only (for external CMS like ReadMe, GitBook)",
-                  value: "external_host",
-                },
-              ],
-            },
-          ]);
-          strategy = strategyChoice;
-        }
-
-        blueprint.documentation = generateDocumentationConfig(
-          docsRoot,
-          strategy
-        );
-
-        // Save updated config
-        config.writeConfig(blueprint);
-
-        console.log(chalk.green("  ✔ Documentation sync configured"));
-        console.log(chalk.gray(`     Root: ${docsRoot}`));
-        console.log(chalk.gray(`     Strategy: ${strategy}`));
-
-        if (shouldScaffold) {
-          console.log(chalk.cyan("\n  📝 Example files created:"));
-          console.log(chalk.gray("     - docs/README.md"));
-          console.log(chalk.gray("     - docs/getting-started.md"));
-        }
-      }
-
       if (blueprint._metadata?.projectName) {
-        console.log(chalk.green("✔ Pulled docsync.config.json from Reshot"));
+        console.log(chalk.green("✔ Pulled reshot.config.json from Reshot"));
       } else {
         console.log(
           chalk.yellow(
@@ -545,7 +308,7 @@ async function initCommand() {
           )
         );
       }
-      console.log(chalk.green("✔ Saved docsync.config.json"));
+      console.log(chalk.green("✔ Saved reshot.config.json"));
 
       const updatedSettings = config.readSettings();
       console.log("");
@@ -559,7 +322,7 @@ async function initCommand() {
       console.log("\nNext steps:");
       console.log(
         `  1. Review ${chalk.bold(
-          "docsync.config.json"
+          "reshot.config.json"
         )} and commit it to your repo.`
       );
       console.log(
@@ -568,38 +331,14 @@ async function initCommand() {
         )}`
       );
 
-      if (blueprint.documentation) {
-        console.log(
-          `  2. Add ${chalk.bold("reshot_journey")} frontmatter to your docs:`
-        );
-        console.log(
-          chalk.gray(
-            '     ---\n     title: "Feature Name"\n     reshot_journey: "feature/workflow"\n     ---'
-          )
-        );
-        console.log(
-          `  3. Run ${chalk.bold(
-            "reshot validate"
-          )} to check your documentation setup.`
-        );
-        console.log(
-          `  4. Run Playwright tests to generate traces, then ${chalk.bold(
-            "reshot ingest"
-          )}`
-        );
-        console.log(
-          `  5. Push your branch - Reshot will detect drift and create PRs.`
-        );
-      } else {
-        console.log(
-          `  2. Run ${chalk.bold(
-            'reshot record "My Visual"'
-          )} to capture your first flow.`
-        );
-        console.log(
-          `  3. Push your branch and open a PR. Reshot will post visual changes as a PR comment.`
-        );
-      }
+      console.log(
+        `  2. Run ${chalk.bold(
+          'reshot record "My Visual"'
+        )} to capture your first flow.`
+      );
+      console.log(
+        `  3. Push your branch and open a PR. Reshot will post visual changes as a PR comment.`
+      );
       console.log("");
     } catch (error) {
       console.error(chalk.red("Failed to initialize:"), error.message);