client-handover 1.0.5 → 1.0.6

package/README.md

@@ -200,6 +200,11 @@ client-handover/
 
 ## Changelog
 
+### 1.0.6
+- Auto-scans your actual project files on every run — reads package.json, config files, env variable keys, deploy configs, folder structure, and more
+- Generated documents are now tailored to your real project, not generic templates
+- Extra notes file still supported as optional additional context
+
 ### 1.0.5
 - Interactive API key setup prompt on install — no manual config needed
 - Added `handover key <api-key>` command to save key at any time

package/cli.js

@@ -6,6 +6,7 @@ import { credentials } from './credentials.js'
 import { handover } from './handover.js'
 import { license } from './license.js'
 import { generateDoc, saveApiKey } from './generator.js'
+import { scanProject } from './scanner.js'
 import chalk from 'chalk'
 import fs from 'fs'
 import path from 'path'
@@ -42,7 +43,7 @@ function printHelp() {
   console.log()
 }
 
-async function runAll(projectInfo, folderName) {
+async function runAll(projectInfo, folderName, outputName) {
   const sections = [
     { key: 'handover',     fn: handover,     label: 'Full Handover Document' },
     { key: 'setup',        fn: setup,        label: 'Project Setup & Dependencies' },
@@ -86,17 +87,23 @@ async function main() {
     process.exit(0)
   }
 
-  // Read optional project info file
-  let projectInfo = ''
+  // Scan the current project directory
+  console.log(chalk.dim('\n🔍 Scanning project...'))
+  const scannedContext = scanProject(process.cwd())
+
+  // Read optional extra project info file
+  let extraInfo = ''
   if (infoFile) {
     if (!fs.existsSync(infoFile)) {
       console.error(chalk.red(`\n❌ File not found: ${infoFile}\n`))
       process.exit(1)
     }
-    projectInfo = fs.readFileSync(infoFile, 'utf-8')
-    console.log(chalk.green(`\n📄 Loaded project info from: ${infoFile}`))
+    extraInfo = fs.readFileSync(infoFile, 'utf-8')
+    console.log(chalk.green(`📄 Loaded extra info from: ${infoFile}`))
   }
 
+  const projectInfo = [scannedContext, extraInfo].filter(Boolean).join('\n\n---\n\n')
+
   if (command === 'all') {
     const folderName = outputName || 'all'
     try {

package/credentials.js

@@ -4,8 +4,9 @@ You are a technical documentation writer creating a CREDENTIALS section for a fr
 
 ⚠️ IMPORTANT: Never include real passwords, keys, or secrets. All sensitive values must use placeholder format: YOUR_VALUE_HERE or [REPLACE_WITH_ACTUAL_VALUE]
 
-Using the following project information:
-${projectInfo || '[No project info provided — use placeholder examples]'}
+The following context has been automatically scanned from the developer's actual project files. Use the real environment variable keys and detected services to build the credentials table for THIS specific project. Do not invent services that are not present. Mark values as "[to be filled in]".
+
+${projectInfo || '[No project data available — use placeholder examples]'}
 
 Generate a CREDENTIALS & ACCESS section that includes:
 

package/deploy.js

@@ -6,8 +6,9 @@ The audience is TWO types of readers:
 1. A NON-TECHNICAL CLIENT — plain English, no jargon
 2. A DEVELOPER — exact technical steps
 
-Using the following project information:
-${projectInfo || '[No project info provided — use placeholder examples]'}
+The following context has been automatically scanned from the developer's actual project files (deploy configs, package.json scripts, workflow files, etc.). Use it to generate deployment documentation specific to THIS project — do not use generic placeholders. Mark any missing details as "[to be filled in]".
+
+${projectInfo || '[No project data available — use placeholder examples]'}
 
 Generate a DEPLOYMENT section that includes:
 

package/handover.js

@@ -6,8 +6,9 @@ This document is for TWO audiences:
 1. NON-TECHNICAL CLIENT — plain English, reassuring tone, no jargon. They need to feel confident owning this site.
 2. DEVELOPER (future maintainer) — precise, technical, complete. They need to be able to pick this up cold.
 
-Using the following project information from the developer:
-${projectInfo || '[No project info provided — use placeholder examples throughout]'}
+The following context has been automatically scanned from the developer's actual project files (package.json, config files, folder structure, environment variable keys, deploy configs, README, etc.). Use this to generate a document specific to THIS project — do not invent or use generic placeholder examples. If a specific detail is not available in the scanned data, note it as "[to be filled in]" rather than guessing.
+
+${projectInfo || '[No project data available — use placeholder examples throughout]'}
 
 Generate a full handover document with ALL of the following sections:
 

package/license.js

@@ -2,8 +2,9 @@ export function license(projectInfo = '') {
   return `
 You are a technical documentation writer creating a LICENSING & ATTRIBUTION section for a frontend website handover document.
 
-Using the following project information:
-${projectInfo || '[No project info provided — use placeholder examples]'}
+The following context has been automatically scanned from the developer's actual project files. Use the real dependencies, license file, and detected libraries to generate licensing documentation specific to THIS project — do not use generic placeholder libraries.
+
+${projectInfo || '[No project data available — use placeholder examples]'}
 
 Generate a LICENSING & ATTRIBUTION section that includes:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "client-handover",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "AI-powered handover document generator for frontend developers handing off client websites",
   "type": "module",
   "main": "index.js",
@@ -17,6 +17,7 @@
     "credentials.js",
     "license.js",
     "postinstall.js",
+    "scanner.js",
     "README.md"
   ],
   "scripts": {

package/scanner.js

@@ -0,0 +1,193 @@
+import fs from 'fs'
+import path from 'path'
+
+const CONFIG_FILES = [
+  'vite.config.js', 'vite.config.ts',
+  'next.config.js', 'next.config.ts', 'next.config.mjs',
+  'nuxt.config.js', 'nuxt.config.ts',
+  'astro.config.js', 'astro.config.ts', 'astro.config.mjs',
+  'svelte.config.js',
+  'remix.config.js',
+  'tailwind.config.js', 'tailwind.config.ts',
+  'postcss.config.js',
+  'netlify.toml',
+  'vercel.json',
+  'render.yaml',
+  'railway.json',
+  '.htaccess',
+  'Dockerfile',
+  'docker-compose.yml',
+  'firebase.json',
+]
+
+const DEPLOY_WORKFLOW_DIR = '.github/workflows'
+
+function readFileSafe(filePath) {
+  try {
+    return fs.readFileSync(filePath, 'utf-8')
+  } catch {
+    return null
+  }
+}
+
+function getEnvKeys(filePath) {
+  const content = readFileSafe(filePath)
+  if (!content) return []
+  return content
+    .split('\n')
+    .map(l => l.trim())
+    .filter(l => l && !l.startsWith('#') && l.includes('='))
+    .map(l => l.split('=')[0].trim())
+}
+
+function getFolderStructure(dir, depth = 0, maxDepth = 2) {
+  if (depth > maxDepth) return []
+  const ignore = new Set(['node_modules', '.git', '.next', '.nuxt', 'dist', 'build', '.cache', 'coverage', '.turbo'])
+  let entries = []
+  try {
+    const items = fs.readdirSync(dir, { withFileTypes: true })
+    for (const item of items) {
+      if (ignore.has(item.name) || item.name.startsWith('.')) continue
+      const indent = '  '.repeat(depth)
+      if (item.isDirectory()) {
+        entries.push(`${indent}${item.name}/`)
+        entries.push(...getFolderStructure(path.join(dir, item.name), depth + 1, maxDepth))
+      } else {
+        entries.push(`${indent}${item.name}`)
+      }
+    }
+  } catch {}
+  return entries
+}
+
+function detectFramework(deps = {}, devDeps = {}) {
+  const all = { ...deps, ...devDeps }
+  if (all['next']) return 'Next.js'
+  if (all['nuxt'] || all['nuxt3']) return 'Nuxt'
+  if (all['@astrojs/core'] || all['astro']) return 'Astro'
+  if (all['@sveltejs/kit']) return 'SvelteKit'
+  if (all['svelte']) return 'Svelte'
+  if (all['@remix-run/react']) return 'Remix'
+  if (all['gatsby']) return 'Gatsby'
+  if (all['react']) return 'React'
+  if (all['vue']) return 'Vue'
+  if (all['angular']) return 'Angular'
+  return null
+}
+
+export function scanProject(dir = process.cwd()) {
+  const sections = []
+
+  // --- package.json ---
+  const pkgPath = path.join(dir, 'package.json')
+  let pkg = null
+  if (fs.existsSync(pkgPath)) {
+    try {
+      pkg = JSON.parse(readFileSafe(pkgPath))
+      const framework = detectFramework(pkg.dependencies, pkg.devDependencies)
+      sections.push(`## package.json`)
+      sections.push(`Name: ${pkg.name || 'unknown'}`)
+      if (pkg.description) sections.push(`Description: ${pkg.description}`)
+      if (pkg.version) sections.push(`Version: ${pkg.version}`)
+      if (framework) sections.push(`Detected framework: ${framework}`)
+      if (pkg.engines?.node) sections.push(`Node requirement: ${pkg.engines.node}`)
+
+      if (pkg.scripts && Object.keys(pkg.scripts).length) {
+        sections.push(`\nScripts:`)
+        for (const [k, v] of Object.entries(pkg.scripts)) {
+          sections.push(`  ${k}: ${v}`)
+        }
+      }
+
+      const deps = Object.keys(pkg.dependencies || {})
+      const devDeps = Object.keys(pkg.devDependencies || {})
+      if (deps.length) sections.push(`\nDependencies: ${deps.join(', ')}`)
+      if (devDeps.length) sections.push(`Dev dependencies: ${devDeps.join(', ')}`)
+    } catch {}
+  }
+
+  // --- Package manager ---
+  let pm = 'npm'
+  if (fs.existsSync(path.join(dir, 'yarn.lock'))) pm = 'yarn'
+  else if (fs.existsSync(path.join(dir, 'pnpm-lock.yaml'))) pm = 'pnpm'
+  else if (fs.existsSync(path.join(dir, 'bun.lockb'))) pm = 'bun'
+  sections.push(`\nPackage manager: ${pm}`)
+
+  // --- Environment variables ---
+  const envExampleKeys = getEnvKeys(path.join(dir, '.env.example'))
+  const envLocalKeys = getEnvKeys(path.join(dir, '.env.local'))
+  const envKeys = getEnvKeys(path.join(dir, '.env'))
+  const allEnvKeys = [...new Set([...envExampleKeys, ...envLocalKeys, ...envKeys])]
+  if (allEnvKeys.length) {
+    sections.push(`\n## Environment Variables (keys only)`)
+    allEnvKeys.forEach(k => sections.push(`  ${k}`))
+  }
+
+  // --- Config files ---
+  for (const file of CONFIG_FILES) {
+    const filePath = path.join(dir, file)
+    if (fs.existsSync(filePath)) {
+      const content = readFileSafe(filePath)
+      if (content && content.length < 4000) {
+        sections.push(`\n## ${file}`)
+        sections.push('```')
+        sections.push(content.trim())
+        sections.push('```')
+      } else if (content) {
+        sections.push(`\n## ${file} (truncated)`)
+        sections.push('```')
+        sections.push(content.trim().slice(0, 4000) + '\n...')
+        sections.push('```')
+      }
+    }
+  }
+
+  // --- GitHub Actions workflows ---
+  const workflowDir = path.join(dir, DEPLOY_WORKFLOW_DIR)
+  if (fs.existsSync(workflowDir)) {
+    try {
+      const files = fs.readdirSync(workflowDir).filter(f => f.endsWith('.yml') || f.endsWith('.yaml'))
+      for (const file of files) {
+        const content = readFileSafe(path.join(workflowDir, file))
+        if (content) {
+          sections.push(`\n## .github/workflows/${file}`)
+          sections.push('```yaml')
+          sections.push(content.trim().slice(0, 3000))
+          sections.push('```')
+        }
+      }
+    } catch {}
+  }
+
+  // --- README ---
+  const readmePath = path.join(dir, 'README.md')
+  if (fs.existsSync(readmePath)) {
+    const content = readFileSafe(readmePath)
+    if (content) {
+      sections.push(`\n## README.md`)
+      sections.push(content.trim().slice(0, 3000))
+    }
+  }
+
+  // --- License ---
+  for (const f of ['LICENSE', 'LICENSE.md', 'LICENSE.txt']) {
+    const p = path.join(dir, f)
+    if (fs.existsSync(p)) {
+      const content = readFileSafe(p)
+      if (content) {
+        sections.push(`\n## ${f}`)
+        sections.push(content.trim().slice(0, 500))
+      }
+      break
+    }
+  }
+
+  // --- Folder structure ---
+  const structure = getFolderStructure(dir)
+  if (structure.length) {
+    sections.push(`\n## Project folder structure`)
+    sections.push(structure.join('\n'))
+  }
+
+  return sections.join('\n')
+}

package/setup.js

@@ -6,8 +6,9 @@ The audience is TWO types of readers:
 1. A NON-TECHNICAL CLIENT — who needs plain-English explanations of what everything is and why it matters
 2. A DEVELOPER — who needs exact commands, file paths, and technical detail
 
-Using the following project information provided by the developer:
-${projectInfo || '[No project info provided — use placeholder examples]'}
+The following context has been automatically scanned from the developer's actual project files. Use it to generate documentation specific to THIS project — do not use generic placeholders. If something is unclear from the scanned data, mark it as "[to be filled in]".
+
+${projectInfo || '[No project data available — use placeholder examples]'}
 
 Generate a SETUP section that includes: