@voodocs/cli 2.1.3 → 2.2.1

package/LICENSE

@@ -1,4 +1,4 @@
-VooDocs Commercial License
+Voodocs Commercial License
 
 Copyright (c) 2025 3vilEnterprises
 

package/PRIVACY.md

@@ -1,31 +1,31 @@
-# VooDocs Privacy Policy
+# Voodocs Privacy Policy
 
 **Last updated:** 2025-12-19
 
-This Privacy Policy explains how VooDocs collects, uses, and discloses information about you. This policy applies when you use the VooDocs command-line interface (CLI) and its related services.
+This Privacy Policy explains how Voodocs collects, uses, and discloses information about you. This policy applies when you use the Voodocs command-line interface (CLI) and its related services.
 
 ## 1. Information We Collect
 
-VooDocs is designed with privacy as a core principle. We collect minimal, anonymous information to help us improve the product and understand how it is used.
+Voodocs is designed with privacy as a core principle. We collect minimal, anonymous information to help us improve the product and understand how it is used.
 
 ### Anonymous Telemetry
 
-By default, VooDocs collects anonymous telemetry data about CLI usage. This data is not linked to your identity and does not include any personal information or code content.
+By default, Voodocs collects anonymous telemetry data about CLI usage. This data is not linked to your identity and does not include any personal information or code content.
 
 We collect the following anonymous data:
 
-- **Command Usage**: Which VooDocs commands are executed (e.g., `init`, `generate`).
+- **Command Usage**: Which Voodocs commands are executed (e.g., `init`, `generate`).
 - **Success/Failure Rates**: Whether commands succeed or fail.
 - **Performance Metrics**: Command execution duration.
 - **Error Information**: The type of error if a command fails (e.g., `ParserError`).
 - **Project Metadata**: The programming language of the project (e.g., `python`, `typescript`).
 - **Usage Statistics**: Number of files processed, number of annotations found.
-- **Environment Information**: Operating system, VooDocs version, Python version, Node.js version.
+- **Environment Information**: Operating system, Voodocs version, Python version, Node.js version.
 - **Anonymous Session ID**: A randomly generated UUID to group events from a single CLI session. This ID is not tied to you or your machine and resets periodically.
 
 ### What We DO NOT Collect
 
-We are developers ourselves and we respect your privacy. VooDocs **never** collects:
+We are developers ourselves and we respect your privacy. Voodocs **never** collects:
 
 - **Personally Identifiable Information (PII)**: Your name, email, IP address, or any other personal data.
 - **Code or Source Files**: The content of your source code, annotations, or generated documentation.
@@ -37,16 +37,16 @@ We are developers ourselves and we respect your privacy. VooDocs **never** colle
 
 We use the anonymous telemetry data we collect to:
 
-- **Improve VooDocs**: Understand which features are most popular and where users encounter problems.
+- **Improve Voodocs**: Understand which features are most popular and where users encounter problems.
 - **Enhance Performance**: Identify and fix performance bottlenecks.
 - **Prioritize Features**: Make data-driven decisions about what to build next.
-- **Track Adoption**: Measure the overall growth and adoption of VooDocs.
+- **Track Adoption**: Measure the overall growth and adoption of Voodocs.
 
 ## 3. Data Storage and Security
 
 - **Data Storage**: Anonymous telemetry data is stored in a secure Supabase database.
 - **Data Retention**: We retain anonymous telemetry data for a maximum of 90 days.
-- **Access Control**: Access to the telemetry data is strictly limited to authorized VooDocs personnel.
+- **Access Control**: Access to the telemetry data is strictly limited to authorized Voodocs personnel.
 
 ## 4. Your Choices
 

package/README.md

@@ -1,12 +1,12 @@
-# VooDocs - AI-Native Symbolic Documentation
+# Voodocs - AI-Native Symbolic Documentation
 
 [![NPM Version](https://img.shields.io/npm/v/@voodocs/cli.svg)](https://www.npmjs.com/package/@voodocs/cli)
 [![License](https://img.shields.io/npm/l/@voodocs/cli.svg)](https://voodocs.com/terms)
 [![Support](https://img.shields.io/badge/support-priority-blue.svg)](https://voodocs.com/support)
 
-**VooDocs** is the world's first AI-native symbolic documentation system. Using mathematical notation and semantic validation, it creates documentation that's both human-readable and optimized for AI consumption.
+**Voodocs** is the world's first AI-native symbolic documentation system. Using mathematical notation and semantic validation, it creates documentation that's both human-readable and optimized for AI consumption.
 
-## What Makes VooDocs Unique?
+## What Makes Voodocs Unique?
 
 ✅ **Symbolic Language** - Mathematical Unicode symbols (⊢, ∂, ⚠, ⊳, ⊲, ⊨, ⚡, 🔒) for concise, precise documentation  
 ✅ **Semantic Validation** - Verifies that your documentation matches your code  
@@ -37,6 +37,7 @@ voodocs init
 ```
 
 This will:
+
 - Create `.voodocs.json` configuration
 - Generate AI instructions for your coding assistant
 - Create example annotated files
@@ -95,34 +96,34 @@ def authenticate_user(user_id: str, password: str) -> Optional[str]:
 
 ### Module-Level Annotations
 
-| Symbol | Field | Description | Example |
-|--------|-------|-------------|---------|
-| ⊢ | module_purpose | What this module does | `⊢{User authentication service}` |
-| ∂ | dependencies | External dependencies | `∂{bcrypt, jsonwebtoken}` |
-| ⚠ | assumptions | Preconditions for module | `⚠{Database is initialized}` |
+| Symbol | Field          | Description              | Example                          |
+| ------ | -------------- | ------------------------ | -------------------------------- |
+| ⊢      | module_purpose | What this module does    | `⊢{User authentication service}` |
+| ∂      | dependencies   | External dependencies    | `∂{bcrypt, jsonwebtoken}`        |
+| ⚠      | assumptions    | Preconditions for module | `⚠{Database is initialized}`     |
 
 ### Function-Level Annotations
 
-| Symbol | Field | Description | Example |
-|--------|-------|-------------|---------|
-| ⊳ | preconditions | Input requirements | `⊳{userId must be a valid UUID}` |
-| ⊲ | postconditions | Output guarantees | `⊲{Returns user object ∨ null}` |
-| ⊨ | invariants | Conditions that always hold | `⊨{Does ¬ modify database}` |
-| ⚡ | complexity | Time/space complexity | `⚡{O(n log n)}` |
-| 🔒 | security | Security implications | `🔒{Password hashed with bcrypt}` |
+| Symbol | Field          | Description                 | Example                           |
+| ------ | -------------- | --------------------------- | --------------------------------- |
+| ⊳      | preconditions  | Input requirements          | `⊳{userId must be a valid UUID}`  |
+| ⊲      | postconditions | Output guarantees           | `⊲{Returns user object ∨ null}`   |
+| ⊨      | invariants     | Conditions that always hold | `⊨{Does ¬ modify database}`       |
+| ⚡     | complexity     | Time/space complexity       | `⚡{O(n log n)}`                  |
+| 🔒     | security       | Security implications       | `🔒{Password hashed with bcrypt}` |
 
 ### Logic Operators
 
-| Symbol | Meaning | Example |
-|--------|---------|---------|
-| ∧ | and | `x > 0 ∧ y > 0` |
-| ∨ | or | `Returns user ∨ null` |
-| ¬ | not | `¬ empty string` |
-| ∈ | in/element of | `user ∈ database` |
-| ∃ | exists | `∃ user: user.id = userId` |
-| ∀ | for all | `∀ item ∈ array: item ≠ null` |
-| ⇒ | implies | `x > 0 ⇒ result > 0` |
-| ⇔ | if and only if | `valid ⇔ checksum matches` |
+| Symbol | Meaning        | Example                       |
+| ------ | -------------- | ----------------------------- |
+| ∧      | and            | `x > 0 ∧ y > 0`               |
+| ∨      | or             | `Returns user ∨ null`         |
+| ¬      | not            | `¬ empty string`              |
+| ∈      | in/element of  | `user ∈ database`             |
+| ∃      | exists         | `∃ user: user.id = userId`    |
+| ∀      | for all        | `∀ item ∈ array: item ≠ null` |
+| ⇒      | implies        | `x > 0 ⇒ result > 0`          |
+| ⇔      | if and only if | `valid ⇔ checksum matches`    |
 
 ---
 
@@ -130,7 +131,7 @@ def authenticate_user(user_id: str, password: str) -> Optional[str]:
 
 ### `voodocs init`
 
-Initialize VooDocs in your project with an interactive wizard:
+Initialize Voodocs in your project with an interactive wizard:
 
 ```bash
 voodocs init              # Interactive setup
@@ -197,7 +198,7 @@ voodocs benchmark ./src --html      # HTML report
 
 ## Configuration
 
-The `.voodocs.json` file configures VooDocs for your project:
+The `.voodocs.json` file configures Voodocs for your project:
 
 ```json
 {
@@ -206,11 +207,7 @@ The `.voodocs.json` file configures VooDocs for your project:
   "format": "darkarts",
   "repository": "https://github.com/user/my-project",
   "private": true,
-  "exclude": [
-    "node_modules",
-    "dist",
-    "build"
-  ]
+  "exclude": ["node_modules", "dist", "build"]
 }
 ```
 
@@ -218,7 +215,7 @@ The `.voodocs.json` file configures VooDocs for your project:
 
 ## CI/CD Integration
 
-Add VooDocs validation to your CI pipeline:
+Add Voodocs validation to your CI pipeline:
 
 ```yaml
 # .github/workflows/validate.yml
@@ -231,7 +228,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '18'
+          node-version: "18"
       - run: npm install -g @voodocs/cli
       - run: voodocs validate ./src --strict --recursive
 ```
@@ -241,10 +238,13 @@ jobs:
 ## Why Symbolic Format?
 
 ### 1. **Concise**
+
 ```
 ⊳{userId ∈ database ∧ password ≥8 chars}
 ```
+
 vs.
+
 ```
 preconditions: [
   "userId must exist in database",
@@ -253,15 +253,19 @@ preconditions: [
 ```
 
 ### 2. **Precise**
+
 Mathematical notation eliminates ambiguity
 
 ### 3. **AI-Optimized**
+
 Fewer tokens = lower costs for AI processing
 
 ### 4. **Language-Independent**
+
 Symbols transcend language barriers
 
 ### 5. **Unique**
+
 Patent-pending innovation (VDA-004)
 
 ---
@@ -303,4 +307,4 @@ Commercial License - See [LICENSE](LICENSE) for details.
 
 ---
 
-**VooDocs** - The world's first AI-native symbolic documentation system.
+**Voodocs** - The world's first AI-native symbolic documentation system.

package/USAGE.md

@@ -1,8 +1,8 @@
-# VooDocs Usage Guide
+# Voodocs Usage Guide
 
 **Version**: v0.1.0
 
-This guide provides a comprehensive overview of VooDocs, its commands, and best practices for using it in your projects.
+This guide provides a comprehensive overview of Voodocs, its commands, and best practices for using it in your projects.
 
 ---
 
@@ -34,7 +34,7 @@ This guide provides a comprehensive overview of VooDocs, its commands, and best
 
 ## Installation
 
-Install the VooDocs CLI globally using `npm` or `pnpm`:
+Install the Voodocs CLI globally using `npm` or `pnpm`:
 
 ```bash
 npm install -g @voodocs/cli
@@ -46,16 +46,20 @@ This will make the `voodocs` command available in your terminal.
 
 ## Quick Start
 
-1.  **Initialize VooDocs** in your project:
+1.  **Initialize Voodocs** in your project:
+
     ```bash
     voodocs init
     ```
+
     This will create a `.voodocs/config.json` file.
 
 2.  **Generate AI Instructions** for your coding assistant:
+
     ```bash
     voodocs instruct
     ```
+
     This creates a `VOODOCS_INSTRUCTIONS.md` file. Provide this to your AI assistant (e.g., add to `.cursorrules`).
 
 3.  **Start Coding** with `@voodocs` annotations. Your AI assistant will help you write them.
@@ -72,14 +76,16 @@ This will make the `voodocs` command available in your terminal.
 
 ### `init`
 
-Initialize VooDocs in a project. Creates a `.voodocs/config.json` file.
+Initialize Voodocs in a project. Creates a `.voodocs/config.json` file.
 
 **Usage**:
+
 ```bash
 voodocs init [--project-name <name>] [--language <lang>]
 ```
 
 **Arguments**:
+
 - `--project-name`: The name of the project (defaults to current directory name).
 - `--language`: The primary language of the project (`python`, `typescript`, `javascript`).
 
@@ -90,11 +96,13 @@ If arguments are not provided, `init` will run in interactive mode.
 Generate AI assistant instructions.
 
 **Usage**:
+
 ```bash
 voodocs instruct [--assistant <name>] [--output <file>]
 ```
 
 **Arguments**:
+
 - `--assistant`: The AI assistant to generate instructions for (`cursor`, `claude`, `copilot`, `windsurf`, `generic`).
 - `--output`: The output file path (defaults to `.cursorrules`, `.claude/instructions.md`, etc.).
 
@@ -103,11 +111,13 @@ voodocs instruct [--assistant <name>] [--output <file>]
 Generate docs, tests, and API specs from annotations.
 
 **Usage**:
+
 ```bash
 voodocs generate <path> [--output <dir>] [--docs-only] [--tests-only] [--api-only] [--verbose]
 ```
 
 **Arguments**:
+
 - `<path>`: The path to the source code to process.
 - `--output`: The output directory (defaults to `./voodocs-output`).
 - `--docs-only`: Generate only documentation.
@@ -120,11 +130,13 @@ voodocs generate <path> [--output <dir>] [--docs-only] [--tests-only] [--api-onl
 Show project status and statistics.
 
 **Usage**:
+
 ```bash
 voodocs status [<path>]
 ```
 
 **Output**:
+
 - Annotation coverage percentage
 - Quality score (0-100)
 - Breakdown of annotated vs. unannotated functions/classes
@@ -134,11 +146,13 @@ voodocs status [<path>]
 Watch files and automatically regenerate documentation on changes.
 
 **Usage**:
+
 ```bash
 voodocs watch <path> [--interval <seconds>]
 ```
 
 **Arguments**:
+
 - `<path>`: The path to watch for changes.
 - `--interval`: The watch interval in seconds (defaults to 2).
 
@@ -147,11 +161,13 @@ voodocs watch <path> [--interval <seconds>]
 Validate annotation quality and correctness.
 
 **Usage**:
+
 ```bash
 voodocs validate <path> [--strict] [--format <fmt>]
 ```
 
 **Arguments**:
+
 - `<path>`: The path to validate.
 - `--strict`: Treat warnings as errors.
 - `--format`: Output format (`text` or `json`).
@@ -161,11 +177,13 @@ voodocs validate <path> [--strict] [--format <fmt>]
 Check annotation coverage and quality (for CI/CD).
 
 **Usage**:
+
 ```bash
 voodocs check <path> [--min-coverage <pct>] [--min-quality <pct>]
 ```
 
 **Arguments**:
+
 - `<path>`: The path to check.
 - `--min-coverage`: The minimum required annotation coverage (0-100).
 - `--min-quality`: The minimum required quality score (0-100).
@@ -177,11 +195,13 @@ Exits with code 1 if checks fail.
 Export documentation to different formats.
 
 **Usage**:
+
 ```bash
 voodocs export <file> --format <fmt> [--output <file>]
 ```
 
 **Arguments**:
+
 - `<file>`: The Markdown documentation file to export.
 - `--format`: The export format (`html` or `pdf`).
 - `--output`: The output file path.
@@ -190,7 +210,7 @@ voodocs export <file> --format <fmt> [--output <file>]
 
 ## Configuration
 
-VooDocs is configured via the `.voodocs/config.json` file. The following options are available:
+Voodocs is configured via the `.voodocs/config.json` file. The following options are available:
 
 ```json
 {
@@ -200,10 +220,7 @@ VooDocs is configured via the `.voodocs/config.json` file. The following options
   "output_dir": "./voodocs-output",
   "test_framework": "pytest",
   "api_format": "openapi",
-  "exclude_patterns": [
-    "**/test_*.py",
-    "**/node_modules/**"
-  ],
+  "exclude_patterns": ["**/test_*.py", "**/node_modules/**"],
   "include_patterns": [],
   "annotation_coverage_threshold": 50
 }
@@ -216,6 +233,7 @@ VooDocs is configured via the `.voodocs/config.json` file. The following options
 ### Annotation Syntax
 
 **Python**:
+
 ```python
 def my_function(x):
     """
@@ -227,6 +245,7 @@ def my_function(x):
 ```
 
 **TypeScript/JavaScript**:
+
 ```typescript
 /**
  * @voodocs
@@ -240,20 +259,20 @@ function myFunction(x: number): number {
 
 ### Annotation Fields
 
-| Field | Description |
-|---|---|
-| `module_purpose` | High-level purpose of the module. |
-| `dependencies` | Key dependencies of the module. |
-| `assumptions` | Assumptions made by the module. |
-| `preconditions` | Conditions that must be true before a function is called. |
-| `postconditions` | Conditions that must be true after a function returns. |
-| `invariants` | Properties that remain unchanged throughout execution. For functions: conditions that hold during execution. For classes: use `class_invariants` for object state constraints. |
-| `complexity` | Time and space complexity of an algorithm. |
-| `error_cases` | How the function behaves in error scenarios. |
-| `security_model` | Security implications and threat model. |
-| `thread_safety` | Thread safety guarantees. |
-| `state_transitions` | How the state of a class changes. |
-| `examples` | Example usage of the function. |
+| Field               | Description                                                                                                                                                                    |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `module_purpose`    | High-level purpose of the module.                                                                                                                                              |
+| `dependencies`      | Key dependencies of the module.                                                                                                                                                |
+| `assumptions`       | Assumptions made by the module.                                                                                                                                                |
+| `preconditions`     | Conditions that must be true before a function is called.                                                                                                                      |
+| `postconditions`    | Conditions that must be true after a function returns.                                                                                                                         |
+| `invariants`        | Properties that remain unchanged throughout execution. For functions: conditions that hold during execution. For classes: use `class_invariants` for object state constraints. |
+| `complexity`        | Time and space complexity of an algorithm.                                                                                                                                     |
+| `error_cases`       | How the function behaves in error scenarios.                                                                                                                                   |
+| `security_model`    | Security implications and threat model.                                                                                                                                        |
+| `thread_safety`     | Thread safety guarantees.                                                                                                                                                      |
+| `state_transitions` | How the state of a class changes.                                                                                                                                              |
+| `examples`          | Example usage of the function.                                                                                                                                                 |
 
 ### DarkArts Language
 
@@ -271,6 +290,7 @@ The DarkArts language is a formal notation used in annotations. It includes:
 ### Function with Invariants
 
 **Python**:
+
 ```python
 def transfer_funds(from_account, to_account, amount):
     """@voodocs
@@ -297,6 +317,7 @@ def transfer_funds(from_account, to_account, amount):
 ### Class with Invariants
 
 **Python**:
+
 ```python
 class BankAccount:
     """@voodocs
@@ -305,7 +326,7 @@ class BankAccount:
         "account_id is unique and immutable"
     ]
     """
-    
+
     def deposit(self, amount):
         """@voodocs
         preconditions: ["amount > 0"]
@@ -327,8 +348,9 @@ See the `examples/` directory for more complete examples in Python and TypeScrip
 Use the `voodocs check` command in your CI/CD pipeline to enforce documentation standards.
 
 **GitHub Actions Example**:
+
 ```yaml
-name: VooDocs Check
+name: Voodocs Check
 
 on: [push, pull_request]
 
@@ -353,8 +375,9 @@ jobs:
 
 **Problem**: TypeScript parser not working.
 **Solution**: The TypeScript parser is built automatically on `postinstall`. If it fails, you can build it manually:
+
 ```bash
-# Navigate to the VooDocs installation directory
+# Navigate to the Voodocs installation directory
 cd $(npm root -g)/@voodocs/cli
 
 # Build the parser

package/examples/.cursorrules

@@ -1,14 +1,14 @@
-# VooDocs Instructions for Cursor
+# Voodocs Instructions for Cursor
 
-**Project**: VooDocs Demo  
-**Generated**: Automatically by VooDocs  
+**Project**: Voodocs Demo  
+**Generated**: Automatically by Voodocs  
 **Purpose**: Guide AI assistants to document code using @voodocs annotations
 
 ---
 
 ## Overview
 
-VooDocs is an AI-native documentation system that allows you to document code in **DarkArts language** - a mathematical and logical notation that AI naturally understands. Your annotations will be automatically translated into human-readable documentation, property-based tests, and API specifications.
+Voodocs is an AI-native documentation system that allows you to document code in **DarkArts language** - a mathematical and logical notation that AI naturally understands. Your annotations will be automatically translated into human-readable documentation, property-based tests, and API specifications.
 
 **Key Benefits:**
 - Document in AI's native language (mathematical notation)
@@ -22,7 +22,7 @@ As an AI coding assistant, you should add `@voodocs` annotations to **every sign
 
 ## Core Principles
 
-When writing code with VooDocs annotations, follow these principles:
+When writing code with Voodocs annotations, follow these principles:
 
 1. **Annotate as you code** - Add `@voodocs` annotations immediately when creating functions/classes
 2. **Be precise** - Use mathematical notation for exact specifications
@@ -137,7 +137,7 @@ DarkArts is a mathematical notation language for precise specifications. Use the
 | `ℤ` | Integers (..., -1, 0, 1, ...) | `x ∈ ℤ` |
 | `ℝ` | Real numbers | `x ∈ ℝ` |
 
-**Tip**: You can use plain English too! VooDocs understands both mathematical notation and natural language. Mix them for clarity.
+**Tip**: You can use plain English too! Voodocs understands both mathematical notation and natural language. Mix them for clarity.
 
 ## Examples
 
@@ -314,7 +314,7 @@ complexity: "O(1)"
 """
 ```
 
-VooDocs generates:
+Voodocs generates:
 
 ```python
 # Generated test
@@ -369,7 +369,7 @@ complexity: "O(n log n)"
 
 **Also Good:**
 ```python
-complexity: "O(n)"  # VooDocs infers space as O(1)
+complexity: "O(n)"  # Voodocs infers space as O(1)
 ```
 
 ### 4. Document Security Implications
@@ -434,4 +434,4 @@ side_effects: ["Does stuff"]  # Too vague
 
 By documenting in DarkArts language, you're not just writing comments - you're creating a **formal specification** that generates tests, documentation, and API specs automatically.
 
-**Generated by VooDocs** - AI-native documentation for modern development.
+**Generated by Voodocs** - AI-native documentation for modern development.