@voodocs/cli 2.1.3 → 2.2.1

package/examples/instructions/.claude/instructions.md

@@ -1,16 +1,17 @@
-# VooDocs Instructions for Claude Code / Cline
+# Voodocs Instructions for Claude Code / Cline
 
-**Project**: VooDocs Example Project  
-**Generated**: Automatically by VooDocs  
+**Project**: Voodocs Example Project  
+**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)
 - Automatic generation of comprehensive tests
 - Property-based testing with Hypothesis
@@ -22,7 +23,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
@@ -43,7 +44,7 @@ complexity: "O(1)"
 security_implications: ["Requires authentication", "Validates account ownership"]
 */
 function withdraw(account: Account, amount: number): boolean {
-    // Implementation
+  // Implementation
 }
 ```
 
@@ -55,7 +56,7 @@ class_invariants: ["this.balance >= 0", "this.transactions.length >= 0"]
 state_transitions: ["PENDING → ACTIVE", "ACTIVE → SUSPENDED", "SUSPENDED → CLOSED"]
 */
 class BankAccount {
-    // Implementation
+  // Implementation
 }
 ```
 
@@ -63,33 +64,33 @@ class BankAccount {
 
 ### For Functions/Methods
 
-| Field | Required | Description | Example |
-|-------|----------|-------------|---------|
-| `preconditions` | Recommended | Conditions that must be true before execution | `["x > 0", "user is authenticated"]` |
-| `postconditions` | Recommended | Conditions guaranteed after execution | `["result > 0", "database updated"]` |
-| `complexity` | Recommended | Time/space complexity | `"O(n log n)"` or `"O(n)"` |
-| `invariants` | Optional | Properties that remain unchanged | `["∀ x: x ∈ original_set ⇒ x ∈ result_set"]` |
-| `error_cases` | Optional | Error conditions and exceptions | `["x < 0 → ValueError", "file not found → FileNotFoundError"]` |
-| `side_effects` | Optional | External changes made | `["Writes to database", "Sends email"]` |
-| `security_implications` | Optional | Security considerations | `["Requires admin role", "Rate limited"]` |
-| `assumptions` | Optional | Environmental assumptions | `["Database is available", "Network is stable"]` |
+| Field                   | Required    | Description                                   | Example                                                        |
+| ----------------------- | ----------- | --------------------------------------------- | -------------------------------------------------------------- |
+| `preconditions`         | Recommended | Conditions that must be true before execution | `["x > 0", "user is authenticated"]`                           |
+| `postconditions`        | Recommended | Conditions guaranteed after execution         | `["result > 0", "database updated"]`                           |
+| `complexity`            | Recommended | Time/space complexity                         | `"O(n log n)"` or `"O(n)"`                                     |
+| `invariants`            | Optional    | Properties that remain unchanged              | `["∀ x: x ∈ original_set ⇒ x ∈ result_set"]`                   |
+| `error_cases`           | Optional    | Error conditions and exceptions               | `["x < 0 → ValueError", "file not found → FileNotFoundError"]` |
+| `side_effects`          | Optional    | External changes made                         | `["Writes to database", "Sends email"]`                        |
+| `security_implications` | Optional    | Security considerations                       | `["Requires admin role", "Rate limited"]`                      |
+| `assumptions`           | Optional    | Environmental assumptions                     | `["Database is available", "Network is stable"]`               |
 
 ### For Classes
 
-| Field | Description | Example |
-|-------|-------------|---------|
-| `class_invariants` | Properties that always hold | `["∀ item ∈ queue: item.status ∈ VALID_STATUSES"]` |
-| `state_transitions` | Valid state changes | `["IDLE → PROCESSING", "PROCESSING → COMPLETE"]` |
-| `thread_safety` | Concurrency safety | `"Thread-safe with mutex"` or `"Not thread-safe"` |
+| Field               | Description                 | Example                                            |
+| ------------------- | --------------------------- | -------------------------------------------------- |
+| `class_invariants`  | Properties that always hold | `["∀ item ∈ queue: item.status ∈ VALID_STATUSES"]` |
+| `state_transitions` | Valid state changes         | `["IDLE → PROCESSING", "PROCESSING → COMPLETE"]`   |
+| `thread_safety`     | Concurrency safety          | `"Thread-safe with mutex"` or `"Not thread-safe"`  |
 
 ### For Modules
 
-| Field | Description | Example |
-|-------|-------------|---------|
-| `module_purpose` | High-level module description | `"User authentication and authorization"` |
-| `dependencies` | External dependencies | `["@supabase/supabase-js", "bcrypt"]` |
-| `assumptions` | Module-level assumptions | `["Database schema v2.0", "Redis available"]` |
-| `security_model` | Overall security approach | `"Defense in depth - fails closed"` |
+| Field            | Description                   | Example                                       |
+| ---------------- | ----------------------------- | --------------------------------------------- |
+| `module_purpose` | High-level module description | `"User authentication and authorization"`     |
+| `dependencies`   | External dependencies         | `["@supabase/supabase-js", "bcrypt"]`         |
+| `assumptions`    | Module-level assumptions      | `["Database schema v2.0", "Redis available"]` |
+| `security_model` | Overall security approach     | `"Defense in depth - fails closed"`           |
 
 ## DarkArts Language Guide
 
@@ -97,49 +98,49 @@ DarkArts is a mathematical notation language for precise specifications. Use the
 
 ### Logical Operators
 
-| Symbol | Meaning | Example |
-|--------|---------|---------|
-| `∧` | AND | `x > 0 ∧ y > 0` |
-| `∨` | OR | `x = 0 ∨ y = 0` |
-| `¬` | NOT | `¬(x < 0)` |
-| `⇒` | IMPLIES | `x > 0 ⇒ result > 0` |
-| `⇔` | IF AND ONLY IF | `result = true ⇔ user.isAdmin` |
+| Symbol | Meaning        | Example                        |
+| ------ | -------------- | ------------------------------ |
+| `∧`    | AND            | `x > 0 ∧ y > 0`                |
+| `∨`    | OR             | `x = 0 ∨ y = 0`                |
+| `¬`    | NOT            | `¬(x < 0)`                     |
+| `⇒`    | IMPLIES        | `x > 0 ⇒ result > 0`           |
+| `⇔`    | IF AND ONLY IF | `result = true ⇔ user.isAdmin` |
 
 ### Quantifiers
 
-| Symbol | Meaning | Example |
-|--------|---------|---------|
-| `∀` | FOR ALL | `∀ x ∈ items: x > 0` |
-| `∃` | THERE EXISTS | `∃ x ∈ items: x = target` |
+| Symbol | Meaning      | Example                   |
+| ------ | ------------ | ------------------------- |
+| `∀`    | FOR ALL      | `∀ x ∈ items: x > 0`      |
+| `∃`    | THERE EXISTS | `∃ x ∈ items: x = target` |
 
 ### Set Operations
 
-| Symbol | Meaning | Example |
-|--------|---------|---------|
-| `∈` | IN / ELEMENT OF | `x ∈ valid_values` |
-| `∉` | NOT IN | `x ∉ blacklist` |
-| `⊆` | SUBSET OF | `result ⊆ input` |
-| `∪` | UNION | `result = set1 ∪ set2` |
-| `∩` | INTERSECTION | `common = set1 ∩ set2` |
+| Symbol | Meaning         | Example                |
+| ------ | --------------- | ---------------------- |
+| `∈`    | IN / ELEMENT OF | `x ∈ valid_values`     |
+| `∉`    | NOT IN          | `x ∉ blacklist`        |
+| `⊆`    | SUBSET OF       | `result ⊆ input`       |
+| `∪`    | UNION           | `result = set1 ∪ set2` |
+| `∩`    | INTERSECTION    | `common = set1 ∩ set2` |
 
 ### Comparisons
 
-| Symbol | Meaning | Example |
-|--------|---------|---------|
-| `≥` | GREATER THAN OR EQUAL | `x ≥ 0` |
-| `≤` | LESS THAN OR EQUAL | `x ≤ 100` |
-| `≠` | NOT EQUAL | `x ≠ 0` |
-| `≈` | APPROXIMATELY EQUAL | `result ≈ expected` |
+| Symbol | Meaning               | Example             |
+| ------ | --------------------- | ------------------- |
+| `≥`    | GREATER THAN OR EQUAL | `x ≥ 0`             |
+| `≤`    | LESS THAN OR EQUAL    | `x ≤ 100`           |
+| `≠`    | NOT EQUAL             | `x ≠ 0`             |
+| `≈`    | APPROXIMATELY EQUAL   | `result ≈ expected` |
 
 ### Number Sets
 
-| Symbol | Meaning | Example |
-|--------|---------|---------|
-| `ℕ` | Natural numbers (0, 1, 2, ...) | `n ∈ ℕ` |
-| `ℤ` | Integers (..., -1, 0, 1, ...) | `x ∈ ℤ` |
-| `ℝ` | Real numbers | `x ∈ ℝ` |
+| Symbol | Meaning                        | Example |
+| ------ | ------------------------------ | ------- |
+| `ℕ`    | Natural numbers (0, 1, 2, ...) | `n ∈ ℕ` |
+| `ℤ`    | 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
 
@@ -172,10 +173,10 @@ side_effects: [
 complexity: "O(1)"
 */
 async function transferMoney(
-    request: Request,
-    response: Response
+  request: Request,
+  response: Response
 ): Promise<void> {
-    // Implementation
+  // Implementation
 }
 ```
 
@@ -198,7 +199,7 @@ assumptions: [
 complexity: "O(n) where n = props.items.length"
 */
 function ItemList({ items, onSelect }: ItemListProps) {
-    // Implementation
+  // Implementation
 }
 ```
 
@@ -249,7 +250,7 @@ complexity: "O(1)"
 """
 ```
 
-VooDocs generates:
+Voodocs generates:
 
 ```python
 # Generated test
@@ -267,6 +268,7 @@ def test_property_based_add(x, y):
 ### 1. Be Specific with Preconditions
 
 **Good:**
+
 ```python
 preconditions: [
     "amount > 0",
@@ -276,6 +278,7 @@ preconditions: [
 ```
 
 **Avoid:**
+
 ```python
 preconditions: ["valid input"]  # Too vague
 ```
@@ -283,6 +286,7 @@ preconditions: ["valid input"]  # Too vague
 ### 2. Use Mathematical Notation for Precision
 
 **Good:**
+
 ```python
 postconditions: [
     "∀ x ∈ result: x ∈ input",  # All results are from input
@@ -291,6 +295,7 @@ postconditions: [
 ```
 
 **Avoid:**
+
 ```python
 postconditions: ["returns filtered list"]  # Imprecise
 ```
@@ -298,18 +303,21 @@ postconditions: ["returns filtered list"]  # Imprecise
 ### 3. Always Specify Complexity
 
 **Good:**
+
 ```python
 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
 
 **Good:**
+
 ```python
 security_implications: [
     "Requires admin role",
@@ -321,6 +329,7 @@ security_implications: [
 ### 5. Specify Error Cases
 
 **Good:**
+
 ```python
 error_cases: [
     "amount <= 0 → ValueError",
@@ -332,6 +341,7 @@ error_cases: [
 ### 6. Use Invariants for Loops and Recursion
 
 **Good:**
+
 ```python
 invariants: [
     "∀ iteration: 0 <= i < len(arr)",
@@ -342,6 +352,7 @@ invariants: [
 ### 7. Document Side Effects
 
 **Good:**
+
 ```python
 side_effects: [
     "Writes to database",
@@ -351,6 +362,7 @@ side_effects: [
 ```
 
 **Avoid:**
+
 ```python
 side_effects: ["Does stuff"]  # Too vague
 ```
@@ -369,4 +381,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.

package/examples/instructions/.cursorrules

@@ -1,14 +1,14 @@
-# VooDocs Instructions for Cursor
+# Voodocs Instructions for Cursor
 
-**Project**: VooDocs Example Project  
-**Generated**: Automatically by VooDocs  
+**Project**: Voodocs Example Project  
+**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.

package/examples/instructions/.windsurfrules

@@ -1,14 +1,14 @@
-# VooDocs Instructions for Windsurf
+# Voodocs Instructions for Windsurf
 
-**Project**: VooDocs Example Project  
-**Generated**: Automatically by VooDocs  
+**Project**: Voodocs Example Project  
+**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.