@esotech/contextuate 2.1.0 → 2.1.2

package/dist/templates/tools/quickref.tool.md

@@ -1,216 +0,0 @@
-# Quickref Generation Tool
-
-> **Type:** AI Tool Guide
-> **Purpose:** Instructions for generating AI-friendly quick references from documentation
-
----
-
-## When to Use This Tool
-
-Use this tool when:
-- Full documentation exceeds ~200 lines
-- A condensed reference would help AI assistants
-- Methods/APIs are frequently looked up
-- User requests a quickref be generated
-
----
-
-## Input
-
-**Required:** Path to source documentation file
-
-**Example request:**
-> "Generate a quickref for docs/classes/user-service.md"
-
----
-
-## Process
-
-### Step 1: Read the Source Documentation
-
-Read the full documentation file to understand:
-- What the class/service/API does
-- All public methods and their signatures
-- Properties and their types
-- Common usage patterns
-
-### Step 2: Extract Key Information
-
-For each **method**, capture:
-- Method name
-- Full parameter signature with types
-- One-line description (max 10 words)
-
-For each **property**, capture:
-- Property name
-- Type
-- One-line description
-
-For **common usage**, capture:
-- The single most common usage pattern
-- Keep it to 3-5 lines of code max
-
-### Step 3: Organize by Category
-
-Group methods logically:
-- By functionality (CRUD, validation, transformation)
-- By access pattern (getters, setters, actions)
-- By frequency of use (common first)
-
-### Step 4: Generate Quickref
-
-Write to `docs/ai/quickrefs/{name}.quickref.md` using the template below.
-
----
-
-## Output Template
-
-```markdown
-# {Name} - Quick Reference
-
-> **Source:** [{source-filename}](../../{path-to-source})
-> **Generated:** {YYYY-MM-DD}
-
----
-
-## Methods
-
-### {Category 1}
-
-| Method | Description |
-|--------|-------------|
-| `methodName( param: type )` | Brief description |
-| `methodName( a: type, b: type ): returnType` | Brief description |
-
-### {Category 2}
-
-| Method | Description |
-|--------|-------------|
-| `methodName( param: type )` | Brief description |
-
----
-
-## Properties
-
-| Property | Type | Description |
-|----------|------|-------------|
-| `propertyName` | type | Brief description |
-
----
-
-## Common Usage
-
-\`\`\`{language}
-// Most common pattern - keep brief
-\`\`\`
-
----
-
-*See [full documentation](../../{path-to-source}) for details.*
-```
-
----
-
-## Guidelines
-
-### Keep It Scannable
-- One line per method/property
-- No verbose explanations
-- Tables for structured data
-- Max 100 lines total
-
-### Method Signatures
-- Include all parameters with types
-- Include return type if not void
-- Use consistent formatting:
-  ```
-  methodName( param1: type, param2: type ): returnType
-  ```
-
-### Descriptions
-- Max 10 words per description
-- Start with verb: "Gets...", "Sets...", "Returns...", "Creates..."
-- No periods at end
-
-### Categories
-- 2-5 categories typically
-- Use clear, short category names
-- Most-used methods first
-
-### Common Usage
-- Single most common pattern
-- 3-5 lines of code max
-- Must be copy-paste ready
-
----
-
-## Example
-
-**Source:** `docs/classes/cache-service.md` (300 lines)
-
-**Generated quickref:**
-
-```markdown
-# Cache Service - Quick Reference
-
-> **Source:** [cache-service.class.md](../../classes/cache-service.class.md)
-> **Generated:** 2024-01-15
-
----
-
-## Methods
-
-### Core Operations
-
-| Method | Description |
-|--------|-------------|
-| `get( key: string ): mixed` | Gets cached value by key |
-| `set( key: string, value: mixed, ttl?: int )` | Sets value with optional TTL |
-| `delete( key: string ): bool` | Removes key from cache |
-| `has( key: string ): bool` | Checks if key exists |
-| `clear()` | Removes all cached values |
-
-### Batch Operations
-
-| Method | Description |
-|--------|-------------|
-| `getMultiple( keys: array ): array` | Gets multiple values at once |
-| `setMultiple( items: array, ttl?: int )` | Sets multiple values |
-| `deleteMultiple( keys: array ): bool` | Removes multiple keys |
-
----
-
-## Properties
-
-| Property | Type | Description |
-|----------|------|-------------|
-| `defaultTtl` | int | Default time-to-live in seconds |
-| `prefix` | string | Key prefix for namespacing |
-
----
-
-## Common Usage
-
-\`\`\`php
-$value = $cache->get( 'user:123' );
-if( !$value ){
-    $value = $this->loadUser( 123 );
-    $cache->set( 'user:123', $value, 3600 );
-}
-\`\`\`
-
----
-
-*See [full documentation](../../classes/cache-service.class.md) for details.*
-```
-
----
-
-## Naming Convention
-
-- **File:** `{source-name}.quickref.md`
-- **Location:** `docs/ai/quickrefs/`
-
-Examples:
-- `docs/classes/user-service.md` → `docs/ai/quickrefs/user-service.quickref.md`
-- `docs/api/auth-endpoints.md` → `docs/ai/quickrefs/auth-endpoints.quickref.md`

package/dist/templates/tools/spawn.tool.md

@@ -1,31 +0,0 @@
-# Tool: spawn_agent
-
-> **Status:** EXPERIMENTAL
-
-The `spawn_agent` tool allows you to launch a specialized sub-agent to perform a specific task in an isolated context.
-
-## Usage
-
-Use this tool when you need to:
-1.  Perform a risky operation that should be sandboxed (e.g. "Refactor auth module").
-2.  Delegate a large task to a specialized persona (e.g. "Ask documentation-expert to write docs").
-
-## Arguments
-
-| Argument     | Type     | Description                                                            |
-| :----------- | :------- | :--------------------------------------------------------------------- |
-| `agent_name` | `string` | The name of the agent to spawn (must exist in `docs/ai/agents/`).      |
-| `goal`       | `string` | Specific instructions for what the agent should achieve.               |
-| `isolation`  | `string` | Isolation mode `worktree` (recommended) or `none`. Default `worktree`. |
-
-## Example
-
-```bash
-contextuate run coder-agent --goal "Fix the bug in login.ts" --isolation=worktree
-```
-
-## Behavior
-
-1.  **Isolation:** The agent creates a new git worktree (branch).
-2.  **Execution:** The agent runs independently in that directory.
-3.  **Result:** The agent commits changes to its branch. You must then merge or review these changes.

package/dist/templates/tools/standards-detector.tool.md

@@ -1,301 +0,0 @@
-# Standards Detector Tool
-
-> **Type:** AI Tool Guide
-> **Purpose:** Analyze project files to detect and document coding standards
-
----
-
-## When to Use This Tool
-
-Use this tool when:
-- Setting up Contextuate in an existing project
-- User wants coding standards documented
-- Standards need to be inferred from existing code
-- Creating project-specific coding standards
-
----
-
-## Input
-
-**Required:** Access to project source files
-
-**Optional:**
-- Specific languages to analyze
-- Specific directories to focus on
-- Existing style config files (.eslintrc, .prettierrc, phpcs.xml, etc.)
-
----
-
-## Process
-
-### Step 1: Detect Languages
-
-Scan project for source files and identify languages:
-
-| Extension | Language |
-|-----------|----------|
-| `.php` | PHP |
-| `.js`, `.jsx` | JavaScript |
-| `.ts`, `.tsx` | TypeScript |
-| `.py` | Python |
-| `.go` | Go |
-| `.rb` | Ruby |
-| `.java` | Java |
-| `.cs` | C# |
-| `.rs` | Rust |
-
-### Step 2: Check for Config Files
-
-Look for existing style configuration:
-
-| File | Tool | Language |
-|------|------|----------|
-| `.eslintrc*` | ESLint | JS/TS |
-| `.prettierrc*` | Prettier | JS/TS/CSS |
-| `phpcs.xml` | PHP_CodeSniffer | PHP |
-| `.php-cs-fixer.php` | PHP CS Fixer | PHP |
-| `pyproject.toml` | Black/Ruff | Python |
-| `.editorconfig` | EditorConfig | All |
-| `tslint.json` | TSLint | TypeScript |
-| `.rubocop.yml` | RuboCop | Ruby |
-
-If config files exist, extract rules from them first.
-
-### Step 3: Analyze Sample Files
-
-For each detected language, read 3-5 representative files:
-- Prefer files in `src/`, `app/`, `lib/` directories
-- Choose files with 50-200 lines (not too short, not too long)
-- Include different file types (classes, utilities, controllers)
-
-### Step 4: Detect Patterns
-
-For each file, analyze:
-
-#### Formatting
-- **Indentation:** Count leading whitespace characters
-  - All tabs → tabs
-  - 2 spaces → 2-space indent
-  - 4 spaces → 4-space indent
-- **Braces:** Check if `{` appears on same line or next line
-- **Spacing:** Check patterns inside parentheses, after keywords
-- **Semicolons (JS):** Present at end of statements?
-- **Quotes (JS):** Single or double quotes predominant?
-
-#### Naming
-- **Classes:** PascalCase, snake_case, etc.
-- **Functions:** camelCase, snake_case, etc.
-- **Variables:** camelCase, snake_case, etc.
-- **Constants:** UPPER_CASE, camelCase, etc.
-
-#### Structure
-- **Import organization:** Grouped? Alphabetized?
-- **File organization:** Class structure patterns
-
-#### Documentation
-- **DocBlocks:** Present? Format?
-- **Comments:** Inline style?
-
-### Step 5: Resolve Conflicts
-
-If patterns vary across files:
-1. Count occurrences of each pattern
-2. Use majority pattern (60%+ agreement)
-3. Note inconsistencies for user review
-4. Flag if no clear majority exists
-
-### Step 6: Generate Standards Document
-
-Use the appropriate template from `templates/standards/`:
-- `php.standards.md` for PHP
-- `javascript.standards.md` for JS/TS
-
-Fill in detected values, replacing `{placeholders}`.
-
----
-
-## Output
-
-Create files in `docs/ai/standards/` (user-customizable location):
-
-```
-docs/ai/standards/
-├── php.standards.md        # If PHP detected
-├── javascript.standards.md # If JS/TS detected
-└── {language}.standards.md # For other languages
-```
-
-These user standards take priority over framework defaults in `docs/ai/.context/templates/standards/`.
-See [coding-standards.md](../standards/coding-standards.md) for resolution order.
-
----
-
-## Analysis Checklist
-
-### PHP Analysis
-
-```php
-// Check for:
-// 1. Indentation
-$line = "    code";  // 4 spaces
-$line = "\tcode";    // tab
-
-// 2. Brace style
-class Foo {          // same-line
-class Foo            // next-line
-{
-
-// 3. Parentheses spacing
-function foo( $param )   // spaces inside
-function foo($param)     // no spaces
-
-// 4. Array syntax
-$arr = array();      // long syntax
-$arr = [];           // short syntax
-
-// 5. Visibility
-public $prop;        // explicit
-var $prop;           // implicit (old style)
-
-// 6. Type hints
-function foo( string $a ): int    // yes
-function foo( $a )                 // no
-```
-
-### JavaScript Analysis
-
-```javascript
-// Check for:
-// 1. Semicolons
-const x = 1;    // with semicolon
-const x = 1     // without
-
-// 2. Quotes
-'single quotes'
-"double quotes"
-
-// 3. Variable declaration
-const x = 1;    // const preferred
-let x = 1;      // let used
-var x = 1;      // var used (legacy)
-
-// 4. Arrow functions
-const fn = () => {};     // arrow
-function fn() {}         // declaration
-
-// 5. Trailing commas
-{ a: 1, b: 2, }   // trailing
-{ a: 1, b: 2 }    // no trailing
-
-// 6. Object shorthand
-{ name: name }    // verbose
-{ name }          // shorthand
-```
-
----
-
-## Example Output
-
-After analyzing a PHP project:
-
-```markdown
-# PHP Coding Standards
-
-> **Language:** PHP
-> **Generated:** 2024-01-15
-> **Detected from:** src/Services/, src/Controllers/
-
----
-
-## Formatting
-
-### Indentation
-- **Style:** tabs
-- **Size:** 1 tab
-
-### Braces
-- **Classes/Functions:** same-line
-- **Control structures:** same-line
-
-### Spacing
-- **Inside parentheses:** yes - `function( $param )`
-- **After keywords:** yes - `if( $x )`
-- **Array brackets:** no-spaces - `$arr['key']`
-
----
-
-## Naming Conventions
-
-### Classes
-- **Style:** PascalCase
-- **Example:** `UserService`, `PaymentController`
-
-### Methods
-- **Style:** camelCase
-- **Example:** `getUserById()`, `processPayment()`
-
-### Variables
-- **Style:** snake_case
-- **Example:** `$user_name`, `$is_active`
-
-...
-```
-
----
-
-## Edge Cases
-
-### Mixed Standards
-If project has inconsistent standards:
-1. Document the majority pattern
-2. Add a note about inconsistencies
-3. Suggest the user choose one
-
-```markdown
-> **Note:** Mixed indentation detected (60% tabs, 40% 2-space).
-> Documenting tabs as primary. Consider standardizing.
-```
-
-### No Clear Pattern
-If no pattern emerges:
-1. Leave placeholder in template
-2. Note that manual input is needed
-
-```markdown
-### Variables
-- **Style:** {inconsistent - needs manual specification}
-```
-
-### Config File Conflicts
-If config files disagree with actual code:
-1. Prefer config file settings (they're intentional)
-2. Note that code may not follow config
-3. Suggest running linter to fix
-
----
-
-## Reporting
-
-After generating standards, report:
-
-1. Languages detected
-2. Files analyzed
-3. Config files found
-4. Standards documents created
-5. Any inconsistencies or manual input needed
-
-```
-Standards Detection Complete
-============================
-Languages: PHP, JavaScript
-Files analyzed: 12
-Config files: .eslintrc.js, .editorconfig
-
-Created:
-  - docs/ai/standards/php.standards.md
-  - docs/ai/standards/javascript.standards.md
-
-Notes:
-  - PHP: Inconsistent variable naming (70% snake_case)
-  - JS: No semicolons detected, matches .eslintrc
-```

package/dist/templates/version.json

@@ -1,8 +0,0 @@
-{
-	"name": "contextuate",
-	"version": "1.0.0",
-	"description": "AI Context Framework - Standardized documentation for AI coding assistants",
-	"repository": "https://github.com/contextuate/contextuate",
-	"installed": null,
-	"updated": null
-}