@mytechtoday/augment-extensions 0.1.2 → 0.4.0

package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md

@@ -0,0 +1,339 @@
+# Universal Formatting Standards
+
+## Overview
+
+This document defines the universal formatting standards for screenplays based on AMPAS (Academy of Motion Picture Arts and Sciences) Nicholl Fellowship requirements and industry best practices.
+
+## Font and Typography
+
+### Required Font
+
+- **Font Family**: Courier or Courier New
+- **Font Size**: 12-point
+- **Character Spacing**: Monospaced (fixed-width)
+- **Line Spacing**: Single-spaced with double-spacing between elements
+
+**Rationale**: Courier's fixed-width characters ensure consistent page-to-screen-time ratio (~1 page = 1 minute).
+
+### DO
+
+```fountain
+INT. COFFEE SHOP - DAY
+
+SARAH enters, scanning the room.
+```
+
+### DON'T
+
+```
+INT. Coffee Shop - Day  ❌ (Wrong case)
+
+Sarah enters, scanning the room.  ❌ (Wrong font: Arial, Times New Roman)
+```
+
+## Page Margins
+
+### Standard Margins
+
+- **Top**: 1 inch
+- **Bottom**: 0.5 to 1 inch
+- **Left**: 1.5 inches
+- **Right**: 1 inch
+
+### Element-Specific Indentation
+
+- **Scene Headings**: 1.5 inches from left edge
+- **Action**: 1.5 inches from left edge
+- **Character Name**: 3.7 inches from left edge (centered)
+- **Dialogue**: 2.5 inches from left edge
+- **Parentheticals**: 3.1 inches from left edge
+- **Transitions**: 6 inches from left edge (right-aligned)
+
+## Scene Headings (Slug Lines)
+
+### Format
+
+```
+INT./EXT. LOCATION - TIME OF DAY
+```
+
+### Components
+
+1. **INT./EXT.**: Interior or Exterior
+2. **LOCATION**: Specific place (ALL CAPS)
+3. **TIME OF DAY**: DAY, NIGHT, MORNING, EVENING, CONTINUOUS, LATER
+
+### Examples
+
+```fountain
+INT. APARTMENT - NIGHT
+
+EXT. CITY STREET - DAY
+
+INT./EXT. CAR (MOVING) - CONTINUOUS
+```
+
+### DO
+
+- Use ALL CAPS for entire slug line
+- Be specific with locations
+- Use standard time indicators
+
+### DON'T
+
+- Mix case: `Int. Apartment - Night` ❌
+- Be vague: `INT. SOMEWHERE - SOMETIME` ❌
+- Omit time: `INT. APARTMENT` ❌
+
+## Action Lines (Description)
+
+### Guidelines
+
+- **Tense**: Present tense
+- **Voice**: Active voice
+- **Length**: 3-4 lines maximum per paragraph
+- **Focus**: Visual and auditory elements only
+- **Character Introductions**: ALL CAPS on first appearance
+
+### Examples
+
+```fountain
+SARAH, 30s, professional but tired, enters carrying a briefcase.
+
+She sets it down. Looks around. Something's wrong.
+
+A SHADOW moves across the wall.
+```
+
+### DO
+
+- Write what we SEE and HEAR
+- Use short, punchy paragraphs
+- Introduce characters in ALL CAPS
+- Use present tense: "She walks" not "She walked"
+
+### DON'T
+
+- Describe thoughts: "She thinks about her mother" ❌
+- Write camera directions: "CLOSE-UP on her face" ❌
+- Use passive voice: "The door is opened by her" ❌
+- Write long paragraphs (more than 4 lines) ❌
+
+## Dialogue
+
+### Format
+
+```fountain
+CHARACTER NAME
+Dialogue text here.
+```
+
+### With Parenthetical
+
+```fountain
+CHARACTER NAME
+(whispering)
+Dialogue text here.
+```
+
+### With Extension
+
+```fountain
+CHARACTER NAME (V.O.)
+Dialogue text here.
+
+CHARACTER NAME (O.S.)
+Dialogue text here.
+```
+
+### Extensions
+
+- **(V.O.)**: Voice-over (narration, internal thoughts)
+- **(O.S.)**: Off-screen (character not visible but in scene)
+- **(CONT'D)**: Continued (same character continues after action)
+- **(PRE-LAP)**: Dialogue starts before scene transition
+- **(SUBTITLE)**: Foreign language with subtitles
+
+### DO
+
+```fountain
+SARAH
+I can't believe you did this.
+
+JOHN
+(defensive)
+I had no choice.
+
+SARAH (CONT'D)
+There's always a choice.
+```
+
+### DON'T
+
+```fountain
+Sarah  ❌ (Not ALL CAPS)
+I can't believe you did this.
+
+JOHN
+(He's defensive)  ❌ (Parenthetical should be action, not description)
+I had no choice.
+```
+
+## Transitions
+
+### Standard Transitions
+
+- **FADE IN:** (opening)
+- **FADE OUT.** (ending)
+- **CUT TO:**
+- **DISSOLVE TO:**
+- **MATCH CUT TO:**
+- **SMASH CUT TO:**
+
+### Format
+
+```fountain
+FADE IN:
+
+INT. APARTMENT - NIGHT
+
+Action here.
+
+CUT TO:
+
+EXT. STREET - DAY
+
+More action.
+
+FADE OUT.
+```
+
+### DO
+
+- Use sparingly (only when necessary)
+- Right-align (except FADE IN:)
+- Follow with colon
+
+### DON'T
+
+- Overuse: Most cuts are implied ❌
+- Use camera directions: "ZOOM IN:" ❌
+- Mix case: "Cut To:" ❌
+
+## Page Numbering
+
+- **First Page**: No page number
+- **Subsequent Pages**: Top right corner, 0.5 inches from top
+- **Format**: Page number followed by period (e.g., "2.")
+
+## Title Page
+
+### Format
+
+```
+TITLE
+by
+Author Name
+
+Contact Information
+Address
+Phone
+Email
+```
+
+### DO
+
+- Center all text
+- Use title case for title
+- Include contact info bottom left
+
+### DON'T
+
+- Add graphics or logos ❌
+- Use fancy fonts ❌
+- Include copyright notices ❌
+
+## Page-to-Screen-Time Ratio
+
+**Standard**: 1 page = 1 minute of screen time
+
+### Typical Lengths
+
+- **Feature Film**: 90-120 pages
+- **TV Drama (1 hour)**: 50-60 pages
+- **TV Comedy (30 min)**: 22-25 pages
+- **Short Film**: 5-30 pages
+
+## Fountain Markup
+
+### Basic Syntax
+
+```fountain
+# Scene Heading
+INT. LOCATION - DAY
+
+# Action
+Character does something.
+
+# Dialogue
+CHARACTER
+Dialogue here.
+
+# Transition
+> FADE OUT.
+```
+
+### Character Introduction
+
+```fountain
+SARAH, 30s, enters.  # First appearance in ALL CAPS
+```
+
+### Emphasis
+
+```fountain
+*italic*
+**bold**
+***bold italic***
+_underline_
+```
+
+## Best Practices
+
+1. **Consistency**: Use same formatting throughout
+2. **Clarity**: Write visually, not literarily
+3. **Economy**: Every word counts
+4. **Readability**: White space is your friend
+5. **Industry Standard**: Follow AMPAS guidelines
+
+## Common Mistakes
+
+❌ Camera directions (CLOSE-UP, PAN TO, ZOOM IN)  
+❌ Editing notes (MONTAGE, INTERCUT)  
+❌ Music cues (unless diegetic)  
+❌ Thoughts and feelings (unless shown visually)  
+❌ Passive voice  
+❌ Past tense  
+❌ Long action paragraphs (>4 lines)  
+
+## Validation Checklist
+
+- [ ] 12-point Courier font
+- [ ] Correct margins (1.5" left, 1" top/bottom/right)
+- [ ] Scene headings in ALL CAPS
+- [ ] Action in present tense
+- [ ] Character names in ALL CAPS (dialogue)
+- [ ] Dialogue properly indented
+- [ ] Transitions right-aligned
+- [ ] Page numbers top right (except page 1)
+- [ ] ~1 page per minute ratio
+- [ ] No camera directions
+- [ ] No editing notes
+- [ ] White space for readability
+
+## References
+
+- [AMPAS Nicholl Fellowship Requirements](https://www.oscars.org/nicholl/requirements)
+- [Fountain Specification](https://fountain.io/)
+- [Final Draft Formatting Guide](https://www.finaldraft.com/)
+

package/cli/MODULES.md

@@ -0,0 +1,302 @@
+# Augment Extensions Module Catalog
+
+This catalog lists all available extension modules for Augment Code AI.
+
+## Quick Start
+
+```bash
+# List all modules
+augx list
+
+# Show module details
+augx show <module-name>
+
+# Link a module to your project
+augx link <module-name>
+```
+
+## Coding Standards
+
+### HTML/CSS/JavaScript Standards
+- **Module**: `coding-standards/html-css-js`
+- **Version**: 1.0.0
+- **Character Count**: ~165,097
+- **Description**: Comprehensive HTML/CSS/JavaScript coding standards for modern web development with semantic HTML, modern CSS features, and ES6+ JavaScript
+- **Contents**:
+  - Async patterns
+  - Css modern features
+  - Css standards
+  - Dom manipulation
+  - Html standards
+  - Javascript standards
+  - Performance
+  - Tooling
+
+**Usage**:
+```bash
+augx link coding-standards/html-css-js
+```
+
+### Python Coding Standards
+- **Module**: `coding-standards/python`
+- **Version**: 1.1.0
+- **Character Count**: ~116,868
+- **Description**: Comprehensive Python coding standards including naming conventions, type hints (PEP 484, 585, 604), and error handling
+- **Contents**:
+  - Async patterns
+  - Best practices
+  - Code organization
+  - Documentation
+  - Error handling
+  - Naming conventions
+  - Testing
+  - Tooling
+  - Type hints
+
+**Usage**:
+```bash
+augx link coding-standards/python
+```
+
+### React Patterns
+- **Module**: `coding-standards/react`
+- **Version**: 1.0.0
+- **Character Count**: ~32,000
+- **Description**: Modern React patterns including component design, hooks, and state management best practices
+- **Contents**:
+  - Component patterns
+  - Hooks best practices
+  - Performance
+  - State management
+  - Typescript react
+
+**Usage**:
+```bash
+augx link coding-standards/react
+```
+
+### TypeScript Standards
+- **Module**: `coding-standards/typescript`
+- **Version**: 1.0.0
+- **Character Count**: ~6,416
+- **Description**: Comprehensive TypeScript coding standards and best practices
+- **Contents**:
+  - Naming conventions
+
+**Usage**:
+```bash
+augx link coding-standards/typescript
+```
+
+## Domain Rules
+
+### API Design Guidelines
+- **Module**: `domain-rules/api-design`
+- **Version**: 1.0.0
+- **Character Count**: ~35,000
+- **Description**: Comprehensive API design guidelines including REST, GraphQL, versioning, and best practices
+- **Contents**:
+  - Authentication
+  - Documentation
+  - Error handling
+  - Graphql api
+  - Rest api
+  - Versioning
+
+**Usage**:
+```bash
+augx link domain-rules/api-design
+```
+
+### Database Design Guidelines
+- **Module**: `domain-rules/database`
+- **Version**: 1.0.0
+- **Character Count**: ~449,449
+- **Description**: Comprehensive database design guidelines including schema design, normalization, indexing, and best practices
+- **Contents**:
+  - Flat databases
+  - Nosql databases
+  - Nosql document stores
+  - Nosql graph databases
+  - Nosql key value stores
+  - Performance optimization
+  - Relational databases
+  - Relational indexing
+  - Relational query optimization
+  - Relational schema design
+  - Relational transactions
+  - Security standards
+  - Universal best practices
+  - Vector databases
+  - Vector embeddings
+  - Vector indexing
+
+**Usage**:
+```bash
+augx link domain-rules/database
+```
+
+### Security Guidelines
+- **Module**: `domain-rules/security`
+- **Version**: 1.0.0
+- **Character Count**: ~38,000
+- **Description**: Comprehensive security guidelines including OWASP best practices, authentication, encryption, and secure coding
+- **Contents**:
+  - Authentication security
+  - Encryption
+  - Input validation
+  - Owasp top 10
+  - Secure coding
+  - Web security
+
+**Usage**:
+```bash
+augx link domain-rules/security
+```
+
+### WordPress Development Standards
+- **Module**: `domain-rules/wordpress`
+- **Version**: 1.0.0
+- **Character Count**: ~0
+- **Description**: Comprehensive WordPress development guidelines including themes, plugins, blocks, and best practices
+- **Contents**:
+  - Coding standards
+  - Directory structure
+  - File patterns
+  - Gutenberg blocks
+  - Performance
+  - Plugin development
+  - Project detection
+  - Rest api
+  - Security
+  - Theme development
+  - Woocommerce
+
+**Usage**:
+```bash
+augx link domain-rules/wordpress
+```
+
+### WordPress Plugin Development
+- **Module**: `domain-rules/wordpress-plugin`
+- **Version**: 1.1.0
+- **Character Count**: ~344,186
+- **Description**: Comprehensive WordPress plugin development guidelines covering plugin structure, architecture patterns, admin interfaces, frontend functionality, Gutenberg blocks, REST API, AJAX, database management, security, performance, WooCommerce integration, testing patterns, and WordPress.org submission.
+- **Contents**:
+  - Activation hooks
+  - Admin interface
+  - Ajax handlers
+  - Asset management
+  - Context providers
+  - Cron jobs
+  - Database management
+  - Documentation standards
+  - Frontend functionality
+  - Gutenberg blocks
+  - Internationalization
+  - Migration
+  - Performance optimization
+  - Plugin architecture
+  - Plugin structure
+  - Rest api
+  - Scaffolding workflow
+  - Security best practices
+  - Testing patterns
+  - Testing
+  - Vscode integration
+  - Woocommerce integration
+  - Wordpress org submission
+
+**Usage**:
+```bash
+augx link domain-rules/wordpress-plugin
+```
+
+## Workflows
+
+### Beads Workflow
+- **Module**: `workflows/beads`
+- **Version**: 1.0.0
+- **Character Count**: ~39,912
+- **Description**: Distributed, git-backed graph issue tracker for AI agents. Provides persistent, structured memory for coding agents with dependency tracking.
+- **Contents**:
+  - Best practices
+  - File format
+  - Manual setup
+  - Workflow
+
+**Usage**:
+```bash
+augx link workflows/beads
+```
+
+### OpenSpec Workflow
+- **Module**: `workflows/openspec`
+- **Version**: 1.0.0
+- **Character Count**: ~32,661
+- **Description**: Spec-driven development (SDD) workflow for AI coding assistants. Provides structured change management with proposals, specs, and tasks.
+- **Contents**:
+  - Best practices
+  - Manual setup
+  - Spec format
+  - Workflow
+
+**Usage**:
+```bash
+augx link workflows/openspec
+```
+
+## Examples
+
+### Design Patterns Examples
+- **Module**: `examples/design-patterns`
+- **Version**: 1.0.0
+- **Character Count**: ~42,000
+- **Description**: Common design patterns with TypeScript/JavaScript implementations and use cases
+
+**Usage**:
+```bash
+augx link examples/design-patterns
+```
+
+### Gutenberg Block Plugin Examples
+- **Module**: `examples/gutenberg-block-plugin`
+- **Version**: 1.0.0
+- **Character Count**: ~15,889
+- **Description**: Complete Gutenberg block plugin examples with block.json, React components, InspectorControls, RichText, MediaUpload, and build process
+
+**Usage**:
+```bash
+augx link examples/gutenberg-block-plugin
+```
+
+### REST API Plugin Examples
+- **Module**: `examples/rest-api-plugin`
+- **Version**: 1.0.0
+- **Character Count**: ~40,367
+- **Description**: Complete REST API plugin examples with custom endpoints (GET, POST, PUT, DELETE), authentication, validation, error handling, and JavaScript client examples
+
+**Usage**:
+```bash
+augx link examples/rest-api-plugin
+```
+
+### WooCommerce Extension Examples
+- **Module**: `examples/woocommerce-extension`
+- **Version**: 1.0.0
+- **Character Count**: ~24,196
+- **Description**: Complete WooCommerce extension examples with custom product fields, checkout customization, payment gateway, order hooks, and WooCommerce best practices
+
+**Usage**:
+```bash
+augx link examples/woocommerce-extension
+```
+
+## Statistics
+
+- **Total Modules**: 17
+- **Coding Standards**: 4
+- **Domain Rules**: 5
+- **Workflows**: 2
+- **Examples**: 4
+- **Total Character Count**: ~1,588,153