@esthernandez/vibe-doc 0.2.1 → 0.2.3

package/dist/generator/markdown-writer.js

@@ -41,6 +41,18 @@ exports.writeMarkdown = writeMarkdown;
 const path = __importStar(require("path"));
 const fs = __importStar(require("fs"));
 const logger_1 = require("../utils/logger");
+// Resolve vibe-doc's own version at module load time so generated docs
+// stamp the correct tool version. __dirname in dist/generator/ is one
+// level below the package root.
+const pkgVersion = (() => {
+    try {
+        const pkgPath = path.resolve(__dirname, '..', '..', 'package.json');
+        return JSON.parse(fs.readFileSync(pkgPath, 'utf-8')).version;
+    }
+    catch {
+        return 'unknown';
+    }
+})();
 /**
  * Write rendered content to a markdown file with metadata header
  * @param renderedContent - The rendered markdown content
@@ -75,7 +87,7 @@ function writeMarkdown(renderedContent, docType, projectPath, metadata) {
  */
 function generateMetadataHeader(metadata, docType) {
     const lines = [
-        '<!-- Generated by Vibe Doc v0.1.0 -->',
+        `<!-- Generated by Vibe Doc v${pkgVersion} -->`,
         `<!-- Date: ${metadata.generatedAt} -->`,
         `<!-- Classification: ${metadata.classification} -->`,
         `<!-- Source artifacts: ${metadata.sourceArtifacts} files scanned -->`,

package/dist/scanner/file-scanner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file-scanner.d.ts","sourceRoot":"","sources":["../../src/scanner/file-scanner.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,UAAU,cAAc;IACtB,YAAY,EAAE,eAAe,CAAC;IAC9B,cAAc,EAAE,eAAe,CAAC;IAChC,cAAc,EAAE,eAAe,CAAC;IAChC,aAAa,EAAE,eAAe,CAAC;IAC/B,cAAc,EAAE,eAAe,CAAC;IAChC,WAAW,EAAE,eAAe,CAAC;IAC7B,cAAc,EAAE,eAAe,CAAC;IAChC,SAAS,EAAE,eAAe,CAAC;IAC3B,QAAQ,EAAE,eAAe,CAAC;IAC1B,UAAU,EAAE,eAAe,CAAC;CAC7B;AA8CD,wBAAsB,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CA2B5E"}
+{"version":3,"file":"file-scanner.d.ts","sourceRoot":"","sources":["../../src/scanner/file-scanner.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,UAAU,cAAc;IACtB,YAAY,EAAE,eAAe,CAAC;IAC9B,cAAc,EAAE,eAAe,CAAC;IAChC,cAAc,EAAE,eAAe,CAAC;IAChC,aAAa,EAAE,eAAe,CAAC;IAC/B,cAAc,EAAE,eAAe,CAAC;IAChC,WAAW,EAAE,eAAe,CAAC;IAC7B,cAAc,EAAE,eAAe,CAAC;IAChC,SAAS,EAAE,eAAe,CAAC;IAC3B,QAAQ,EAAE,eAAe,CAAC;IAC1B,UAAU,EAAE,eAAe,CAAC;CAC7B;AAmDD,wBAAsB,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CA2B5E"}

package/dist/scanner/file-scanner.js

@@ -46,6 +46,14 @@ function categorizeFile(filePath) {
     const n = filePath.replace(/\\/g, '/');
     if (n.endsWith('CLAUDE.md'))
         return 'configAsDocs';
+    // Claude Code plugin manifests (plugin.json, marketplace.json inside .claude-plugin/)
+    if (n.includes('/.claude-plugin/') && n.endsWith('.json'))
+        return 'packageConfigs';
+    // SKILL.md files and command docs are plugin surface area
+    if (n.match(/\/skills\/[^/]+\/SKILL\.md$/i))
+        return 'documentation';
+    if (n.match(/\/commands\/[^/]+\.md$/i))
+        return 'documentation';
     if (n.includes('/.ai/') || n.includes('/.agent/skills/'))
         return 'agentArtifacts';
     if (n.includes('/.claude/'))
@@ -64,7 +72,7 @@ function categorizeFile(filePath) {
         return 'apiSpecs';
     return 'sourceCode';
 }
-function walkDir(dir, maxDepth = 4, currentDepth = 0) {
+function walkDir(dir, maxDepth = 6, currentDepth = 0) {
     const files = [];
     if (currentDepth > maxDepth)
         return files;
@@ -73,7 +81,7 @@ function walkDir(dir, maxDepth = 4, currentDepth = 0) {
         for (const entry of entries) {
             if (EXCLUDE_DIRS.has(entry.name))
                 continue;
-            if (entry.name.startsWith('.') && entry.name !== '.ai' && entry.name !== '.agent' && entry.name !== '.claude' && entry.name !== '.github')
+            if (entry.name.startsWith('.') && entry.name !== '.ai' && entry.name !== '.agent' && entry.name !== '.claude' && entry.name !== '.claude-plugin' && entry.name !== '.github')
                 continue;
             const fullPath = path.join(dir, entry.name);
             if (entry.isFile()) {

package/dist/templates/embedded/adr.md

@@ -0,0 +1,45 @@
+---
+docType: adr
+version: 1.0
+templateVersion: 1
+---
+
+# Architecture Decision Record
+
+## Status
+
+{{user.status}}
+
+<!-- NEEDS INPUT: What is the status of this decision? (Proposed, Accepted, Deprecated, Superseded) -->
+
+## Context
+
+{{extracted.context}}
+
+{{user.context}}
+
+<!-- NEEDS INPUT: What is the issue that motivated this decision or any context you should record here? -->
+
+## Decision
+
+{{extracted.decision}}
+
+{{user.decision}}
+
+<!-- NEEDS INPUT: What is the change that we're proposing or have agreed to do? -->
+
+## Consequences
+
+{{extracted.consequences}}
+
+{{user.consequences}}
+
+<!-- NEEDS INPUT: What becomes easier or more difficult to do because of this change? Include positive and negative consequences. -->
+
+## Alternatives
+
+{{extracted.alternatives}}
+
+{{user.alternatives}}
+
+<!-- NEEDS INPUT: What other options did you consider and why were they rejected? -->

package/dist/templates/embedded/api-spec.md

@@ -0,0 +1,55 @@
+---
+docType: api-spec
+version: 1.0
+templateVersion: 1
+---
+
+# API Specification
+
+## Base URL
+
+{{extracted.base-url}}
+
+{{user.base-url}}
+
+<!-- NEEDS INPUT: What is the base URL for your API? Include protocol, hostname, and port. -->
+
+## Endpoints
+
+{{extracted.endpoints}}
+
+{{user.endpoints}}
+
+<!-- NEEDS INPUT: List your primary endpoints. Include HTTP method, path, and brief description. -->
+
+## Request Format
+
+{{extracted.request-format}}
+
+{{user.request-format}}
+
+<!-- NEEDS INPUT: Describe the request format. Include content-type, headers, body structure, and examples. -->
+
+## Response Format
+
+{{extracted.response-format}}
+
+{{user.response-format}}
+
+<!-- NEEDS INPUT: Describe the response format. Include status codes, body structure, headers, and examples. -->
+
+## Error Handling
+
+{{extracted.error-handling}}
+
+{{user.error-handling}}
+
+<!-- NEEDS INPUT: How do you handle errors? Include error codes, error message format, and common errors. -->
+
+## Authentication
+
+{{extracted.authentication}}
+
+{{user.authentication}}
+
+<!-- NEEDS INPUT: How do clients authenticate? Include auth mechanisms, required headers, and token formats. -->

package/dist/templates/embedded/changelog-contributing.md

@@ -0,0 +1,67 @@
+---
+docType: changelog-contributing
+version: 1.0
+templateVersion: 1
+---
+
+# Changelog and Contributing
+
+## Changelog
+
+All notable changes to this project are documented here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+### Unreleased
+
+{{user.unreleased}}
+
+<!-- NEEDS INPUT: Changes that have landed on main but haven't shipped in a release yet. Group by Added / Changed / Deprecated / Removed / Fixed / Security. -->
+
+### {{user.latestVersion}} — {{user.latestDate}}
+
+{{extracted.latestRelease}}
+
+{{user.latestRelease}}
+
+<!-- NEEDS INPUT: The most recent shipped version. Same Added/Changed/etc. grouping. -->
+
+### Prior Releases
+
+{{extracted.priorReleases}}
+
+{{user.priorReleases}}
+
+<!-- NEEDS INPUT: Older releases in reverse chronological order. Keep summaries short — point to git tags or GitHub releases for full diffs. -->
+
+---
+
+## Contributing
+
+### How to Contribute
+
+{{user.howToContribute}}
+
+<!-- NEEDS INPUT: The high-level contributor path — fork, branch, change, PR. Link to the code of conduct and any contributor license terms. -->
+
+### Development Setup
+
+{{user.devSetup}}
+
+<!-- NEEDS INPUT: What a contributor needs to build and test locally. Prerequisites, install commands, how to run the test suite. This may overlap with the install guide — that's fine, contributors need it in one place. -->
+
+### Proposing a Change
+
+{{user.proposingChange}}
+
+<!-- NEEDS INPUT: Branching strategy, commit message format, PR template expectations, and any required checks (tests, linters, type checks) that must pass. -->
+
+### Review Process
+
+{{user.reviewProcess}}
+
+<!-- NEEDS INPUT: Who reviews PRs, what the turnaround looks like, and what approval is required before merge. -->
+
+### Code of Conduct
+
+{{user.codeOfConduct}}
+
+<!-- NEEDS INPUT: A link to the code of conduct or a short statement of expected behavior. -->

package/dist/templates/embedded/data-model.md

@@ -0,0 +1,55 @@
+---
+docType: data-model
+version: 1.0
+templateVersion: 1
+---
+
+# Data Model
+
+## Entity Overview
+
+{{extracted.entity-overview}}
+
+{{user.entity-overview}}
+
+<!-- NEEDS INPUT: What are the main entities/tables in your data model? Include brief descriptions of each. -->
+
+## Table Schemas
+
+{{extracted.table-schemas}}
+
+{{user.table-schemas}}
+
+<!-- NEEDS INPUT: Describe the schema for each table. Include column names, types, and descriptions. -->
+
+## Relationships
+
+{{extracted.relationships}}
+
+{{user.relationships}}
+
+<!-- NEEDS INPUT: What are the relationships between tables? Include foreign keys and cardinality. -->
+
+## Constraints
+
+{{extracted.constraints}}
+
+{{user.constraints}}
+
+<!-- NEEDS INPUT: What constraints and validation rules exist? Include unique constraints, check constraints, and business rules. -->
+
+## Indexes
+
+{{extracted.indexes}}
+
+{{user.indexes}}
+
+<!-- NEEDS INPUT: What indexes exist and why? Include primary keys, unique indexes, and performance indexes. -->
+
+## Migration Strategy
+
+{{extracted.migration-strategy}}
+
+{{user.migration-strategy}}
+
+<!-- NEEDS INPUT: How do you handle schema migrations? Include versioning, rollback strategy, and zero-downtime deployment. -->

package/dist/templates/embedded/deployment-procedure.md

@@ -0,0 +1,63 @@
+---
+docType: deployment-procedure
+version: 1.0
+templateVersion: 1
+---
+
+# Deployment Procedure
+
+## Prerequisites
+
+{{extracted.prerequisites}}
+
+{{user.prerequisites}}
+
+<!-- NEEDS INPUT: What prerequisites must be met before deployment? Include access, tools, accounts, and configurations. -->
+
+## Build Process
+
+{{extracted.build-process}}
+
+{{user.build-process}}
+
+<!-- NEEDS INPUT: What are the steps to build the application? Include compilation, dependency installation, and artifact generation. -->
+
+## Environment Setup
+
+{{extracted.environment-setup}}
+
+{{user.environment-setup}}
+
+<!-- NEEDS INPUT: What environment variables, secrets, and configurations are required for each environment? -->
+
+## Testing Before Deploy
+
+{{extracted.testing-before-deploy}}
+
+{{user.testing-before-deploy}}
+
+<!-- NEEDS INPUT: What tests and validations run before deployment? Include smoke tests, integration tests, and health checks. -->
+
+## Deployment Steps
+
+{{extracted.deployment-steps}}
+
+{{user.deployment-steps}}
+
+<!-- NEEDS INPUT: What are the step-by-step deployment instructions? Include database migrations, service restarts, and traffic shifting. -->
+
+## Post-Deployment Checks
+
+{{extracted.post-deployment-checks}}
+
+{{user.post-deployment-checks}}
+
+<!-- NEEDS INPUT: What checks verify the deployment was successful? Include health checks, endpoint tests, and monitoring. -->
+
+## Rollback Procedure
+
+{{extracted.rollback-procedure}}
+
+{{user.rollback-procedure}}
+
+<!-- NEEDS INPUT: How do you rollback to the previous version? Include steps, data rollback, and communication plan. -->

package/dist/templates/embedded/install-guide.md

@@ -0,0 +1,49 @@
+---
+docType: install-guide
+version: 1.0
+templateVersion: 1
+---
+
+# Installation Guide
+
+## Prerequisites
+
+{{extracted.prerequisites}}
+
+{{user.prerequisites}}
+
+<!-- NEEDS INPUT: What does a user need before they start? OS, runtime versions (Node 18+, Python 3.11+, etc.), required CLI tools, accounts, API keys. Be specific about minimum versions. -->
+
+## Install Steps
+
+{{extracted.installSteps}}
+
+{{user.installSteps}}
+
+<!-- NEEDS INPUT: The exact ordered steps. For each step, include the command to run and the expected outcome. If there are multiple install paths (npm vs. git clone vs. marketplace), list them all. -->
+
+## Verification
+
+{{user.verification}}
+
+<!-- NEEDS INPUT: How does a user confirm the install worked? A command they can run (e.g., `vibe-doc --version`), a health-check URL, or a first-use command that should produce expected output. -->
+
+## Configuration
+
+{{user.configuration}}
+
+<!-- NEEDS INPUT: Any required configuration after install — env vars, config files, credentials. If none are required, say so explicitly. -->
+
+## Troubleshooting
+
+{{extracted.troubleshooting}}
+
+{{user.troubleshooting}}
+
+<!-- NEEDS INPUT: The three to five most common installation failures and their fixes. Real users have hit these problems — write the fix, not a generic "contact support." -->
+
+## Uninstalling
+
+{{user.uninstall}}
+
+<!-- NEEDS INPUT: How to cleanly remove the project. Include any config files or data directories that need manual cleanup. -->

package/dist/templates/embedded/readme.md

@@ -0,0 +1,55 @@
+---
+docType: readme
+version: 1.0
+templateVersion: 1
+---
+
+# {{user.projectName}}
+
+{{extracted.tagline}}
+
+{{user.tagline}}
+
+<!-- NEEDS INPUT: One-sentence description of what this project is and who it's for. -->
+
+## Overview
+
+{{extracted.overview}}
+
+{{user.overview}}
+
+<!-- NEEDS INPUT: A short paragraph explaining what the project does, the problem it solves, and the audience. Keep it under 100 words. -->
+
+## Installation
+
+{{extracted.installation}}
+
+{{user.installation}}
+
+<!-- NEEDS INPUT: The shortest path to getting the project installed and working. Include prerequisites and the exact install command. -->
+
+## Usage
+
+{{extracted.usage}}
+
+{{user.usage}}
+
+<!-- NEEDS INPUT: A minimal working example showing the most common use case. Prefer a code block or a short step list over prose. -->
+
+## Examples
+
+{{user.examples}}
+
+<!-- NEEDS INPUT: Two or three additional examples covering the next-most-common use cases. Link to a /docs or /examples folder if one exists. -->
+
+## Documentation
+
+{{user.documentation}}
+
+<!-- NEEDS INPUT: Where does a reader go next? Link to fuller docs, a command reference, a changelog, or a contributing guide. -->
+
+## License
+
+{{user.license}}
+
+<!-- NEEDS INPUT: The project's license (usually one line — e.g. "MIT" — and a link to LICENSE). -->

package/dist/templates/embedded/runbook.md

@@ -0,0 +1,55 @@
+---
+docType: runbook
+version: 1.0
+templateVersion: 1
+---
+
+# Runbook
+
+## Service Overview
+
+{{extracted.service-overview}}
+
+{{user.service-overview}}
+
+<!-- NEEDS INPUT: What does this service do? What is its primary responsibility? -->
+
+## Startup Procedure
+
+{{extracted.startup-procedure}}
+
+{{user.startup-procedure}}
+
+<!-- NEEDS INPUT: What are the steps to start the service? Include environment setup, dependencies, configuration. -->
+
+## Health Checks
+
+{{extracted.health-checks}}
+
+{{user.health-checks}}
+
+<!-- NEEDS INPUT: How do you verify the service is healthy? What are the key metrics or checks? -->
+
+## Common Issues
+
+{{extracted.common-issues}}
+
+{{user.common-issues}}
+
+<!-- NEEDS INPUT: What are the most common problems and their solutions? -->
+
+## Rollback Procedure
+
+{{extracted.rollback-procedure}}
+
+{{user.rollback-procedure}}
+
+<!-- NEEDS INPUT: How do you roll back to a previous version? What steps are required? -->
+
+## Escalation Path
+
+{{extracted.escalation-path}}
+
+{{user.escalation-path}}
+
+<!-- NEEDS INPUT: Who should be contacted for different severity levels? What is the on-call process? -->

package/dist/templates/embedded/skill-command-reference.md

@@ -0,0 +1,77 @@
+---
+docType: skill-command-reference
+version: 1.0
+templateVersion: 1
+---
+
+# Skill and Command Reference
+
+This document lists every skill and command this plugin exposes, what each one does, and how to invoke it.
+
+## Skills
+
+{{extracted.skillList}}
+
+{{user.skillList}}
+
+<!-- NEEDS INPUT: One entry per skill. For each: the skill name, a one-sentence description, when a user should reach for it, and a pointer to the underlying SKILL.md file if applicable. -->
+
+### Skill: {{user.skillName}}
+
+**Purpose:** {{user.skillPurpose}}
+
+**When to use:** {{user.skillWhenToUse}}
+
+**Inputs:** {{user.skillInputs}}
+
+**Example:**
+
+```
+{{user.skillExample}}
+```
+
+<!-- NEEDS INPUT: Repeat this block for each skill the plugin ships. -->
+
+## Commands
+
+{{extracted.commandList}}
+
+{{user.commandList}}
+
+<!-- NEEDS INPUT: One entry per slash command. For each: the command, its purpose, arguments (required and optional), and a minimal example invocation. -->
+
+### Command: `{{user.commandName}}`
+
+**Purpose:** {{user.commandPurpose}}
+
+**Syntax:** `/{{user.commandName}} [arguments]`
+
+**Arguments:**
+
+{{user.commandArguments}}
+
+<!-- NEEDS INPUT: List each argument with name, type, required/optional, and a one-line description. -->
+
+**Example:**
+
+```
+{{user.commandExample}}
+```
+
+**Output:**
+
+{{user.commandOutput}}
+
+<!-- NEEDS INPUT: What the user sees when the command succeeds. A screenshot, an expected text snippet, or a description of the artifact created. -->
+
+## Composition
+
+{{user.composition}}
+
+<!-- NEEDS INPUT: If the plugin's commands chain together (e.g., /scan → /report → /generate), document the typical workflow here. Show the order and what each step hands to the next. -->
+
+## Errors and Edge Cases
+
+{{user.errors}}
+
+<!-- NEEDS INPUT: The most common failure modes (missing prerequisites, invalid inputs, environment issues) and how the user should respond. -->

package/dist/templates/embedded/test-plan.md

@@ -0,0 +1,55 @@
+---
+docType: test-plan
+version: 1.0
+templateVersion: 1
+---
+
+# Test Plan
+
+## Test Strategy
+
+{{extracted.test-strategy}}
+
+{{user.test-strategy}}
+
+<!-- NEEDS INPUT: What is your overall testing strategy? Include testing levels, approach, and priorities. -->
+
+## Unit Tests
+
+{{extracted.unit-tests}}
+
+{{user.unit-tests}}
+
+<!-- NEEDS INPUT: What components and functions are covered by unit tests? Include test coverage goals. -->
+
+## Integration Tests
+
+{{extracted.integration-tests}}
+
+{{user.integration-tests}}
+
+<!-- NEEDS INPUT: What system interactions are tested? Include database, APIs, and third-party services. -->
+
+## E2E Tests
+
+{{extracted.e2e-tests}}
+
+{{user.e2e-tests}}
+
+<!-- NEEDS INPUT: What critical user workflows are tested end-to-end? Include scenarios and acceptance criteria. -->
+
+## Performance Tests
+
+{{extracted.performance-tests}}
+
+{{user.performance-tests}}
+
+<!-- NEEDS INPUT: What performance characteristics are tested? Include load tests, latency targets, and throughput. -->
+
+## Coverage Targets
+
+{{extracted.coverage-targets}}
+
+{{user.coverage-targets}}
+
+<!-- NEEDS INPUT: What are your code coverage targets? Include overall target and critical areas. -->

package/dist/templates/embedded/threat-model.md

@@ -0,0 +1,47 @@
+---
+docType: threat-model
+version: 1.0
+templateVersion: 1
+---
+
+# Threat Model
+
+## Asset Scope
+
+{{extracted.asset-scope}}
+
+{{user.asset-scope}}
+
+<!-- NEEDS INPUT: What are the valuable assets you need to protect? Include data, infrastructure, and systems. -->
+
+## Threat Actors
+
+{{extracted.threat-actors}}
+
+{{user.threat-actors}}
+
+<!-- NEEDS INPUT: Who are the potential threat actors? (e.g., external attackers, malicious insiders, nation-states) -->
+
+## Threat Scenarios
+
+{{extracted.threat-scenarios}}
+
+{{user.threat-scenarios}}
+
+<!-- NEEDS INPUT: What are the specific threat scenarios you are concerned about? How might they compromise your assets? -->
+
+## Mitigations
+
+{{extracted.mitigations}}
+
+{{user.mitigations}}
+
+<!-- NEEDS INPUT: What controls do you have in place to mitigate these threats? Include technical, process, and organizational controls. -->
+
+## Residual Risks
+
+{{extracted.residual-risks}}
+
+{{user.residual-risks}}
+
+<!-- NEEDS INPUT: What risks remain after implementing mitigations? What is your risk tolerance? -->