Some checks failed
Test Suite / unit-tests (3.11) (push) Has been cancelled
Test Suite / unit-tests (3.12) (push) Has been cancelled
Test Suite / integration-tests (push) Has been cancelled
Test Suite / e2e-tests (push) Has been cancelled
Test Suite / performance-tests (push) Has been cancelled
Test Suite / code-quality (push) Has been cancelled
Test Suite / security-scan (push) Has been cancelled
Test Suite / test-summary (push) Has been cancelled
## Command Restructuring Implementation - Add new db-data command as replacement for metadata command - Implement complete functionality matching original metadata command - Support all output formats (table, json, yaml, simple) - Follow established db- prefix pattern from Issue #39 ## Backward Compatibility & Migration - Maintain existing metadata command with full functionality - Add deprecation warnings using legacy compatibility system - Update help documentation with migration guidance - Provide clear examples showing new db-data usage ## CLI Enhancements - Consistent error handling across both commands - Comprehensive help documentation for smooth migration - Integration with existing legacy compatibility framework - Support for all established output format options ## Testing & Validation - Create comprehensive test suite for command restructuring - Verify backward compatibility with existing scripts - Test deprecation warning functionality - Validate format consistency between old and new commands ## GAMEPLAN Documentation - Create detailed implementation roadmap for all 5 phases - Document technical architecture for component separation - Establish testing strategy for comprehensive CLI enhancement - Plan future phases for content, frontmatter, and tailmatter commands Phase 1 Complete: ✅ Command restructuring with full backward compatibility Next: Phase 2 - Content commands (content-stats, content-get) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2851 lines
106 KiB
Python
2851 lines
106 KiB
Python
"""
|
|
CLI Entry Point and Basic Commands - Issue #12
|
|
|
|
This module provides the command-line interface for MarkiTect, allowing users
|
|
to interact with core functionality through terminal commands.
|
|
|
|
Commands:
|
|
- ingest: Process and store a markdown file
|
|
- status: Show processing status and metadata for a file
|
|
- list: List all stored files and their status
|
|
|
|
Integration with existing components:
|
|
- Uses DatabaseManager for file storage and retrieval
|
|
- Uses DocumentManager for high-performance document processing
|
|
- Maintains performance caching architecture
|
|
"""
|
|
|
|
import click
|
|
import os
|
|
import sys
|
|
import json
|
|
import yaml
|
|
from pathlib import Path
|
|
from typing import Optional
|
|
from tabulate import tabulate
|
|
import builtins
|
|
|
|
from .database import DatabaseManager
|
|
from .legacy_compat import LegacyMode, emit_deprecation_warning, legacy_switch_option
|
|
|
|
# Import legacy system components for advanced management
|
|
try:
|
|
from .legacy import (
|
|
LegacyRegistry, LegacyAgent, LegacyStatus, AgentConfig
|
|
)
|
|
LEGACY_SYSTEM_AVAILABLE = True
|
|
except ImportError:
|
|
LEGACY_SYSTEM_AVAILABLE = False
|
|
|
|
|
|
def detect_execution_mode():
|
|
"""
|
|
Detect whether we're running in interactive or automation mode.
|
|
|
|
Returns:
|
|
str: 'interactive' or 'automation'
|
|
|
|
Detection logic:
|
|
- Environment variable MARKITECT_MODE overrides detection
|
|
- Interactive: TTY present, not in CI, not in pipe
|
|
- Automation: CI environment, pipe/redirect, or explicit setting
|
|
"""
|
|
# Explicit mode override
|
|
mode = os.environ.get('MARKITECT_MODE', '').lower()
|
|
if mode in ['interactive', 'automation']:
|
|
return mode
|
|
|
|
# Detect CI environments
|
|
ci_indicators = [
|
|
'CI', 'CONTINUOUS_INTEGRATION', 'GITHUB_ACTIONS',
|
|
'GITLAB_CI', 'JENKINS_URL', 'BUILD_NUMBER'
|
|
]
|
|
if any(os.environ.get(var) for var in ci_indicators):
|
|
return 'automation'
|
|
|
|
# Check if output is being piped or redirected
|
|
if not sys.stdout.isatty():
|
|
return 'automation'
|
|
|
|
# Check if input is being piped
|
|
if not sys.stdin.isatty():
|
|
return 'automation'
|
|
|
|
# Default to interactive for terminal usage
|
|
return 'interactive'
|
|
|
|
|
|
def should_use_associated_files():
|
|
"""Determine if commands should use associated files behavior."""
|
|
return detect_execution_mode() == 'interactive'
|
|
from .document_manager import DocumentManager
|
|
from .serializer import ASTSerializer
|
|
from .cache_service import CacheDirectoryService
|
|
from .ast_service import ASTService
|
|
from .schema_generator import SchemaGenerator
|
|
from .schema_validator import SchemaValidator
|
|
from .exceptions import FileNotFoundError, InvalidDepthError, SchemaValidationError, InvalidSchemaError
|
|
|
|
|
|
# Global options for CLI configuration
|
|
pass_config = click.make_pass_decorator(dict, ensure=True)
|
|
|
|
|
|
def get_default_format(available_formats=['table', 'json', 'yaml', 'simple'], fallback='simple'):
|
|
"""
|
|
Get the default output format from environment variable or fallback.
|
|
|
|
Supports MARKITECT_DEFAULT_FORMAT environment variable to customize
|
|
the default output format across all commands.
|
|
|
|
Args:
|
|
available_formats: List of formats supported by the command
|
|
fallback: Default format to use if env var not set or invalid
|
|
|
|
Returns:
|
|
Default format string
|
|
"""
|
|
env_format = os.environ.get('MARKITECT_DEFAULT_FORMAT', '').lower()
|
|
|
|
if env_format and env_format in available_formats:
|
|
return env_format
|
|
|
|
# If simple is available and no env override, use simple
|
|
if 'simple' in available_formats:
|
|
return 'simple'
|
|
|
|
# Otherwise use the provided fallback
|
|
return fallback
|
|
|
|
|
|
def format_output(data, output_format):
|
|
"""
|
|
Format data according to specified output format.
|
|
|
|
Args:
|
|
data: Data to format
|
|
output_format: Format type ('table', 'json', 'yaml')
|
|
|
|
Returns:
|
|
Formatted string output
|
|
"""
|
|
if output_format == 'json':
|
|
return json.dumps(data, indent=2, default=str)
|
|
elif output_format == 'yaml':
|
|
return yaml.dump(data, default_flow_style=False, allow_unicode=True)
|
|
elif output_format == 'simple':
|
|
# Simple format - just basic text output
|
|
if isinstance(data, builtins.list):
|
|
return '\n'.join(str(item) for item in data)
|
|
elif isinstance(data, builtins.dict):
|
|
return '\n'.join(f"{key}: {value}" for key, value in data.items())
|
|
else:
|
|
return str(data)
|
|
elif output_format == 'table':
|
|
try:
|
|
# Check if it's a list type
|
|
if isinstance(data, (builtins.list, builtins.tuple)):
|
|
if data and isinstance(data[0], builtins.dict):
|
|
# List of dictionaries - format as table
|
|
headers = sorted(data[0].keys())
|
|
rows = []
|
|
for item in data:
|
|
row = []
|
|
for header in headers:
|
|
row.append(item.get(header, ''))
|
|
rows.append(row)
|
|
return tabulate(rows, headers=headers, tablefmt='grid')
|
|
else:
|
|
# List of simple values
|
|
return tabulate([[item] for item in data], headers=['Value'], tablefmt='grid')
|
|
elif isinstance(data, builtins.dict):
|
|
# Single dictionary - format as key-value table
|
|
rows = [[key, value] for key, value in data.items()]
|
|
return tabulate(rows, headers=['Key', 'Value'], tablefmt='grid')
|
|
else:
|
|
# Fallback to string representation
|
|
return str(data)
|
|
except Exception as e:
|
|
# Fallback to string if table formatting fails
|
|
return f"Table formatting error: {e}\nData: {str(data)}"
|
|
else:
|
|
# Default to table format
|
|
return format_output(data, 'table')
|
|
|
|
|
|
@click.group()
|
|
@click.option('--verbose', '-v', is_flag=True, help='Enable verbose output')
|
|
@click.option('--config', 'config_file', type=click.Path(exists=True), help='Configuration file path')
|
|
@click.option('--database', type=click.Path(), help='Database file path')
|
|
@pass_config
|
|
def cli(config, verbose, database, config_file):
|
|
"""
|
|
MarkiTect - Advanced Markdown engine for structured content.
|
|
|
|
Process markdown files with front matter support, AST caching,
|
|
and relational metadata queries.
|
|
|
|
Examples:
|
|
markitect ingest document.md # Process a markdown file
|
|
markitect status document.md # Check file status
|
|
markitect list # List all stored files
|
|
"""
|
|
# Store configuration in context
|
|
config['verbose'] = verbose
|
|
config['config_file'] = config_file
|
|
|
|
# Determine database path
|
|
if database:
|
|
config['database_path'] = database
|
|
else:
|
|
# Default database location
|
|
config['database_path'] = os.path.expanduser('~/.markitect/markitect.db')
|
|
|
|
# Initialize database manager and ensure database exists
|
|
try:
|
|
db_manager = DatabaseManager(config['database_path'])
|
|
db_manager.initialize_database()
|
|
config['db_manager'] = db_manager
|
|
|
|
if verbose:
|
|
click.echo(f"Using database: {config['database_path']}", err=True)
|
|
except Exception as e:
|
|
click.echo(f"Error initializing database: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command()
|
|
@click.argument('file_path', type=click.Path(exists=True))
|
|
@pass_config
|
|
def ingest(config, file_path):
|
|
"""
|
|
Process and store a markdown file.
|
|
|
|
Ingests a markdown file into the MarkiTect system, parsing its content,
|
|
extracting front matter, generating AST cache, and storing metadata
|
|
in the database.
|
|
|
|
FILE_PATH: Path to the markdown file to process
|
|
|
|
Examples:
|
|
markitect ingest README.md
|
|
markitect ingest docs/guide.md
|
|
"""
|
|
try:
|
|
file_path = Path(file_path)
|
|
|
|
if config['verbose']:
|
|
click.echo(f"Processing file: {file_path}")
|
|
|
|
# Initialize document manager with database manager
|
|
doc_manager = DocumentManager(config['db_manager'])
|
|
|
|
# Ingest the file
|
|
result = doc_manager.ingest_file(file_path)
|
|
|
|
if config['verbose']:
|
|
click.echo(f"Processing results:")
|
|
click.echo(f" File: {result['metadata']['filename']}")
|
|
click.echo(f" AST nodes: {len(result['ast'])} nodes")
|
|
click.echo(f" Cache file: {result['ast_cache_path']}")
|
|
click.echo(f" Parse time: {result['parse_time']:.2f}s")
|
|
click.echo(f" Cache time: {result['cache_time']:.2f}s")
|
|
|
|
click.echo(f"✓ Successfully ingested: {file_path.name}")
|
|
|
|
except FileNotFoundError:
|
|
click.echo(f"Error: File not found: {file_path}", err=True)
|
|
sys.exit(1)
|
|
except PermissionError:
|
|
click.echo(f"Error: Permission denied accessing: {file_path}", err=True)
|
|
sys.exit(1)
|
|
except Exception as e:
|
|
click.echo(f"Error processing file: {e}", err=True)
|
|
if config['verbose']:
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command()
|
|
@click.argument('file_path', type=str)
|
|
@pass_config
|
|
def status(config, file_path):
|
|
"""
|
|
Show processing status and metadata for a file.
|
|
|
|
Displays information about a file's processing status, metadata,
|
|
and front matter content from the database.
|
|
|
|
FILE_PATH: Path or name of the file to check
|
|
|
|
Examples:
|
|
markitect status README.md
|
|
markitect status docs/guide.md
|
|
"""
|
|
try:
|
|
if config['verbose']:
|
|
click.echo(f"Checking status for: {file_path}")
|
|
|
|
# Get file information from database
|
|
db_manager = config['db_manager']
|
|
file_info = db_manager.get_markdown_file(file_path)
|
|
|
|
if file_info:
|
|
click.echo(f"File: {file_info['filename']}")
|
|
click.echo(f"Status: Processed")
|
|
click.echo(f"Created: {file_info['created_at']}")
|
|
|
|
if file_info['front_matter']:
|
|
try:
|
|
front_matter = eval(file_info['front_matter']) # Safe for our controlled data
|
|
if front_matter:
|
|
click.echo("Front Matter:")
|
|
for key, value in front_matter.items():
|
|
click.echo(f" {key}: {value}")
|
|
except (ValueError, TypeError, SyntaxError):
|
|
click.echo("Front Matter: (parsing error)")
|
|
elif file_info['front_matter'] is None:
|
|
pass # No front matter to display
|
|
|
|
if config['verbose']:
|
|
content_preview = file_info['content'][:200] + "..." if len(file_info['content']) > 200 else file_info['content']
|
|
click.echo(f"Content preview: {content_preview}")
|
|
else:
|
|
click.echo(f"File not found in database: {file_path}")
|
|
click.echo("Use 'markitect ingest' to process the file first.")
|
|
sys.exit(1)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error checking file status: {e}", err=True)
|
|
if config['verbose']:
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command()
|
|
@click.argument('file_path', type=str)
|
|
@click.option('--output', '-o', type=click.Path(), help='Output file path (default: stdout)')
|
|
@pass_config
|
|
def get(config, file_path, output):
|
|
"""
|
|
Retrieve and output a processed markdown file.
|
|
|
|
Loads the file from the database and AST cache, then serializes it back
|
|
to markdown format. Supports outputting to file or stdout.
|
|
|
|
FILE_PATH: Name of the file to retrieve
|
|
|
|
Examples:
|
|
markitect get README.md
|
|
markitect get docs/guide.md --output modified_guide.md
|
|
"""
|
|
try:
|
|
if config['verbose']:
|
|
click.echo(f"Retrieving file: {file_path}")
|
|
|
|
db_manager = config['db_manager']
|
|
|
|
# Get file information from database
|
|
file_info = db_manager.get_markdown_file(file_path)
|
|
if not file_info:
|
|
click.echo(f"File not found in database: {file_path}", err=True)
|
|
click.echo("Use 'markitect ingest' to process the file first.", err=True)
|
|
sys.exit(1)
|
|
|
|
# Load AST from cache
|
|
cache_filename = f"{file_path}.ast.json"
|
|
cache_path = Path('.ast_cache') / cache_filename
|
|
|
|
if not cache_path.exists():
|
|
click.echo(f"AST cache not found: {cache_path}", err=True)
|
|
click.echo("Try re-ingesting the file to regenerate cache.", err=True)
|
|
sys.exit(1)
|
|
|
|
# Read AST from cache
|
|
with open(cache_path, 'r', encoding='utf-8') as f:
|
|
ast = json.load(f)
|
|
|
|
# Parse front matter from database
|
|
front_matter = None
|
|
if file_info.get('front_matter'):
|
|
try:
|
|
front_matter = eval(file_info['front_matter'])
|
|
except (ValueError, TypeError, SyntaxError):
|
|
if config['verbose']:
|
|
click.echo("Warning: Could not parse front matter", err=True)
|
|
|
|
# Serialize AST back to markdown
|
|
serializer = ASTSerializer()
|
|
markdown_content = serializer.serialize_to_markdown(ast, front_matter)
|
|
|
|
# Output to file or stdout
|
|
if output:
|
|
output_path = Path(output)
|
|
output_path.parent.mkdir(parents=True, exist_ok=True)
|
|
with open(output_path, 'w', encoding='utf-8') as f:
|
|
f.write(markdown_content)
|
|
click.echo(f"✓ File written to: {output_path}")
|
|
else:
|
|
click.echo(markdown_content)
|
|
|
|
if config['verbose']:
|
|
click.echo(f"Retrieved {len(ast)} AST tokens", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error retrieving file: {e}", err=True)
|
|
if config['verbose']:
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command()
|
|
@click.argument('file_path', type=str)
|
|
@click.option('--add-section', type=str, help='Add section with title')
|
|
@click.option('--section-content', type=str, default='', help='Content for new section')
|
|
@click.option('--section-level', type=int, default=2, help='Heading level for new section (1-6)')
|
|
@click.option('--update-front-matter', type=str, help='Update front matter (format: key:value)')
|
|
@click.option('--output', '-o', type=click.Path(), help='Output file path (default: overwrite original in cache)')
|
|
@pass_config
|
|
def modify(config, file_path, add_section, section_content, section_level, update_front_matter, output):
|
|
"""
|
|
Modify the content of a processed markdown file.
|
|
|
|
Loads the file from cache, applies modifications, and updates the cache
|
|
or outputs to a new file. Supports adding sections and updating front matter.
|
|
|
|
FILE_PATH: Name of the file to modify
|
|
|
|
Examples:
|
|
markitect modify README.md --add-section "New Section" --section-content "New content"
|
|
markitect modify doc.md --update-front-matter "status:updated"
|
|
markitect modify doc.md --add-section "Notes" --output modified_doc.md
|
|
"""
|
|
try:
|
|
if config['verbose']:
|
|
click.echo(f"Modifying file: {file_path}")
|
|
|
|
db_manager = config['db_manager']
|
|
|
|
# Get file information from database
|
|
file_info = db_manager.get_markdown_file(file_path)
|
|
if not file_info:
|
|
click.echo(f"File not found in database: {file_path}", err=True)
|
|
click.echo("Use 'markitect ingest' to process the file first.", err=True)
|
|
sys.exit(1)
|
|
|
|
# Load AST from cache
|
|
cache_filename = f"{file_path}.ast.json"
|
|
cache_path = Path('.ast_cache') / cache_filename
|
|
|
|
if not cache_path.exists():
|
|
click.echo(f"AST cache not found: {cache_path}", err=True)
|
|
click.echo("Try re-ingesting the file to regenerate cache.", err=True)
|
|
sys.exit(1)
|
|
|
|
# Read AST from cache
|
|
with open(cache_path, 'r', encoding='utf-8') as f:
|
|
ast = json.load(f)
|
|
|
|
# Parse front matter from database
|
|
front_matter = {}
|
|
if file_info.get('front_matter'):
|
|
try:
|
|
front_matter = eval(file_info['front_matter']) or {}
|
|
except (ValueError, TypeError, SyntaxError):
|
|
if config['verbose']:
|
|
click.echo("Warning: Could not parse existing front matter", err=True)
|
|
|
|
# Prepare modifications
|
|
modifications = {}
|
|
changes_made = []
|
|
|
|
# Handle add-section modification
|
|
if add_section:
|
|
modifications['add_section'] = {
|
|
'title': add_section,
|
|
'content': section_content,
|
|
'level': section_level
|
|
}
|
|
changes_made.append(f"Added section: {add_section}")
|
|
|
|
# Handle front matter updates
|
|
if update_front_matter:
|
|
try:
|
|
if ':' in update_front_matter:
|
|
key, value = update_front_matter.split(':', 1)
|
|
key = key.strip()
|
|
value = value.strip()
|
|
|
|
# Try to parse value as appropriate type
|
|
if value.lower() in ['true', 'false']:
|
|
value = value.lower() == 'true'
|
|
elif value.isdigit():
|
|
value = int(value)
|
|
elif value.replace('.', '').isdigit():
|
|
value = float(value)
|
|
|
|
front_matter[key] = value
|
|
changes_made.append(f"Updated front matter: {key} = {value}")
|
|
else:
|
|
click.echo("Invalid front matter format. Use 'key:value'", err=True)
|
|
sys.exit(1)
|
|
except ValueError as e:
|
|
click.echo(f"Error parsing front matter update: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
if not changes_made:
|
|
click.echo("No modifications specified. Use --add-section or --update-front-matter", err=True)
|
|
sys.exit(1)
|
|
|
|
# Apply modifications to AST
|
|
serializer = ASTSerializer()
|
|
if modifications:
|
|
ast = serializer.modify_ast_content(ast, modifications)
|
|
|
|
# Serialize back to markdown
|
|
markdown_content = serializer.serialize_to_markdown(ast, front_matter)
|
|
|
|
# Handle output
|
|
if output:
|
|
# Write to specified output file
|
|
output_path = Path(output)
|
|
output_path.parent.mkdir(parents=True, exist_ok=True)
|
|
with open(output_path, 'w', encoding='utf-8') as f:
|
|
f.write(markdown_content)
|
|
click.echo(f"✓ Modified file written to: {output_path}")
|
|
else:
|
|
# Update the cache and database with modifications
|
|
with open(cache_path, 'w', encoding='utf-8') as f:
|
|
json.dump(ast, f, indent=2, ensure_ascii=False)
|
|
|
|
# Update database with new front matter
|
|
if front_matter:
|
|
# Note: This would require extending DatabaseManager to update front matter
|
|
# For now, we'll just note the modification
|
|
if config['verbose']:
|
|
click.echo("Note: Database front matter update not implemented yet", err=True)
|
|
|
|
click.echo(f"✓ Modified file updated in cache: {file_path}")
|
|
|
|
# Show changes made
|
|
if config['verbose']:
|
|
click.echo("Changes applied:", err=True)
|
|
for change in changes_made:
|
|
click.echo(f" - {change}", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error modifying file: {e}", err=True)
|
|
if config['verbose']:
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command()
|
|
@click.argument('sql', type=str)
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']), default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']), help='Output format')
|
|
@pass_config
|
|
def query(config, sql, format):
|
|
"""
|
|
Execute SQL query against the database.
|
|
|
|
DEPRECATED: Use 'db-query' instead. This command will be removed in a future version.
|
|
|
|
Execute read-only SQL queries to explore and analyze document metadata.
|
|
Only SELECT and WITH statements are allowed for security.
|
|
|
|
SQL: SQL query to execute (SELECT statements only)
|
|
|
|
Examples:
|
|
markitect db-query "SELECT filename, created_at FROM markdown_files"
|
|
markitect db-query "SELECT COUNT(*) as total FROM markdown_files" --format json
|
|
markitect db-query "SELECT * FROM markdown_files WHERE filename LIKE '%.md'" --format yaml
|
|
"""
|
|
# Show deprecation warning (unless in legacy mode)
|
|
if not LegacyMode.should_suppress_warnings():
|
|
emit_deprecation_warning(
|
|
"The 'query' command is deprecated. Please use 'db-query' instead. "
|
|
"This command will be removed in a future version."
|
|
)
|
|
|
|
try:
|
|
if config['verbose']:
|
|
click.echo(f"Executing query: {sql}", err=True)
|
|
|
|
db_manager = config['db_manager']
|
|
|
|
# Execute the query
|
|
results = db_manager.execute_query(sql)
|
|
|
|
if not results:
|
|
if format == 'json':
|
|
click.echo('[]')
|
|
elif format == 'yaml':
|
|
click.echo('[]')
|
|
else:
|
|
click.echo("No results found.")
|
|
return
|
|
|
|
# Format and display results
|
|
formatted_output = format_output(results, format)
|
|
click.echo(formatted_output)
|
|
|
|
if config['verbose']:
|
|
click.echo(f"Query returned {len(results)} result(s)", err=True)
|
|
|
|
except ValueError as e:
|
|
click.echo(f"Query error: {e}", err=True)
|
|
sys.exit(1)
|
|
except Exception as e:
|
|
click.echo(f"Database error: {e}", err=True)
|
|
if config['verbose']:
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('db-query')
|
|
@click.argument('sql', type=str)
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']), default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']), help='Output format')
|
|
@pass_config
|
|
def db_query(config, sql, format):
|
|
"""
|
|
Execute SQL query against the database.
|
|
|
|
Execute read-only SQL queries to explore and analyze document metadata.
|
|
Only SELECT and WITH statements are allowed for security.
|
|
|
|
SQL: SQL query to execute (SELECT statements only)
|
|
|
|
Examples:
|
|
markitect db-query "SELECT filename, created_at FROM markdown_files"
|
|
markitect db-query "SELECT COUNT(*) as total FROM markdown_files" --format json
|
|
markitect db-query "SELECT * FROM markdown_files WHERE filename LIKE '%.md'" --format yaml
|
|
"""
|
|
try:
|
|
if config['verbose']:
|
|
click.echo(f"Executing query: {sql}", err=True)
|
|
|
|
db_manager = config['db_manager']
|
|
|
|
# Execute the query
|
|
results = db_manager.execute_query(sql)
|
|
|
|
if not results:
|
|
if format == 'json':
|
|
click.echo('[]')
|
|
elif format == 'yaml':
|
|
click.echo('[]')
|
|
else:
|
|
click.echo("No results found.")
|
|
return
|
|
|
|
# Format and display results
|
|
formatted_output = format_output(results, format)
|
|
click.echo(formatted_output)
|
|
|
|
if config['verbose']:
|
|
click.echo(f"Query returned {len(results)} result(s)", err=True)
|
|
|
|
except ValueError as e:
|
|
click.echo(f"Query error: {e}", err=True)
|
|
sys.exit(1)
|
|
except Exception as e:
|
|
click.echo(f"Database error: {e}", err=True)
|
|
if config['verbose']:
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command()
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']), default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']), help='Output format')
|
|
@pass_config
|
|
def schema(config, format):
|
|
"""
|
|
Show database schema and table structure.
|
|
|
|
DEPRECATED: Use 'db-schema' instead. This command will be removed in a future version.
|
|
|
|
Display the structure of all tables in the database, including
|
|
column names, types, and constraints.
|
|
|
|
Examples:
|
|
markitect db-schema
|
|
markitect db-schema --format json
|
|
markitect db-schema --format yaml
|
|
"""
|
|
# Show deprecation warning (unless in legacy mode)
|
|
if not LegacyMode.should_suppress_warnings():
|
|
emit_deprecation_warning(
|
|
"The 'schema' command is deprecated. Please use 'db-schema' instead. "
|
|
"This command will be removed in a future version."
|
|
)
|
|
|
|
try:
|
|
if config['verbose']:
|
|
click.echo("Retrieving database schema...", err=True)
|
|
|
|
db_manager = config['db_manager']
|
|
|
|
# Get schema information
|
|
schema_info = db_manager.get_schema()
|
|
|
|
if not schema_info:
|
|
click.echo("No tables found in database.")
|
|
return
|
|
|
|
# Format and display schema
|
|
formatted_output = format_output(schema_info, format)
|
|
click.echo(formatted_output)
|
|
|
|
if config['verbose']:
|
|
table_count = len(schema_info)
|
|
click.echo(f"Schema contains {table_count} table(s)", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Schema error: {e}", err=True)
|
|
if config['verbose']:
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('db-schema')
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']), default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']), help='Output format')
|
|
@pass_config
|
|
def db_schema(config, format):
|
|
"""
|
|
Show database schema and table structure.
|
|
|
|
Display the structure of all tables in the database, including
|
|
column names, types, and constraints.
|
|
|
|
Examples:
|
|
markitect db-schema
|
|
markitect db-schema --format json
|
|
markitect db-schema --format yaml
|
|
"""
|
|
try:
|
|
if config['verbose']:
|
|
click.echo("Retrieving database schema...", err=True)
|
|
|
|
db_manager = config['db_manager']
|
|
|
|
# Get schema information
|
|
schema_info = db_manager.get_schema()
|
|
|
|
if not schema_info:
|
|
click.echo("No tables found in database.")
|
|
return
|
|
|
|
# Format and display schema
|
|
formatted_output = format_output(schema_info, format)
|
|
click.echo(formatted_output)
|
|
|
|
if config['verbose']:
|
|
table_count = len(schema_info)
|
|
click.echo(f"Schema contains {table_count} table(s)", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Schema error: {e}", err=True)
|
|
if config['verbose']:
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command()
|
|
@click.argument('file_path', type=str)
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']), default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']), help='Output format')
|
|
@pass_config
|
|
def metadata(config, file_path, format):
|
|
"""
|
|
Display file metadata and front matter.
|
|
|
|
DEPRECATED: Use 'db-data' instead. This command will be removed in a future version.
|
|
|
|
Show detailed information about a specific file including its
|
|
front matter, database metadata, and processing information.
|
|
|
|
FILE_PATH: Name of the file to display metadata for
|
|
|
|
Examples:
|
|
markitect metadata README.md (deprecated - use: markitect db-data README.md)
|
|
markitect metadata docs/guide.md --format json (deprecated - use: markitect db-data docs/guide.md --format json)
|
|
markitect metadata config.md --format yaml (deprecated - use: markitect db-data config.md --format yaml)
|
|
"""
|
|
# Show deprecation warning (unless in legacy mode)
|
|
if not LegacyMode.should_suppress_warnings():
|
|
emit_deprecation_warning(
|
|
"The 'metadata' command is deprecated. Please use 'db-data' instead. "
|
|
"This command will be removed in a future version."
|
|
)
|
|
|
|
try:
|
|
if config['verbose']:
|
|
click.echo(f"Retrieving metadata for: {file_path}", err=True)
|
|
|
|
db_manager = config['db_manager']
|
|
|
|
# Get file information from database
|
|
file_info = db_manager.get_markdown_file(file_path)
|
|
|
|
if not file_info:
|
|
click.echo(f"File not found in database: {file_path}", err=True)
|
|
click.echo("Use 'markitect ingest' to process the file first.", err=True)
|
|
sys.exit(1)
|
|
|
|
# Parse front matter for better display
|
|
if file_info.get('front_matter'):
|
|
try:
|
|
if isinstance(file_info['front_matter'], str):
|
|
file_info['front_matter'] = eval(file_info['front_matter'])
|
|
except (ValueError, TypeError, SyntaxError):
|
|
if config['verbose']:
|
|
click.echo("Warning: Could not parse front matter", err=True)
|
|
|
|
# Format and display metadata
|
|
formatted_output = format_output(file_info, format)
|
|
click.echo(formatted_output)
|
|
|
|
if config['verbose']:
|
|
content_length = len(file_info.get('content', ''))
|
|
click.echo(f"Content length: {content_length} characters", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Metadata error: {e}", err=True)
|
|
if config['verbose']:
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command()
|
|
@click.option('--format', 'output_format', type=click.Choice(['table', 'json', 'yaml', 'simple']),
|
|
default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']), help='Output format')
|
|
@click.option('--names-only', is_flag=True, help='Show only filenames (no metadata)')
|
|
@pass_config
|
|
def list(config, output_format, names_only):
|
|
"""
|
|
List all stored files and their status.
|
|
|
|
Shows all markdown files that have been processed and stored
|
|
in the MarkiTect database with their basic metadata.
|
|
|
|
Examples:
|
|
markitect list
|
|
markitect list --format table
|
|
markitect list --format json
|
|
markitect list --names-only
|
|
"""
|
|
try:
|
|
if config['verbose']:
|
|
click.echo("Retrieving all stored files...")
|
|
|
|
db_manager = config['db_manager']
|
|
files = db_manager.list_markdown_files()
|
|
|
|
if not files:
|
|
click.echo("No files found in database.")
|
|
click.echo("Use 'markitect ingest <file>' to add files.")
|
|
return
|
|
|
|
# Handle names-only option
|
|
if names_only:
|
|
for file_info in files:
|
|
click.echo(file_info['filename'])
|
|
return
|
|
|
|
# Handle different output formats
|
|
if output_format == 'simple':
|
|
# Original emoji format
|
|
click.echo(f"Found {len(files)} file(s):")
|
|
click.echo()
|
|
|
|
for file_info in files:
|
|
click.echo(f"📄 {file_info['filename']}")
|
|
if config['verbose']:
|
|
click.echo(f" Created: {file_info['created_at']}")
|
|
if file_info.get('front_matter'):
|
|
try:
|
|
front_matter = eval(file_info['front_matter'])
|
|
if front_matter:
|
|
click.echo(f" Front matter: {list(front_matter.keys())}")
|
|
except (ValueError, TypeError, SyntaxError):
|
|
click.echo(f" Front matter: (parsing error)")
|
|
click.echo()
|
|
else:
|
|
# Use structured format (table, json, yaml)
|
|
formatted_output = format_output(files, output_format)
|
|
click.echo(formatted_output)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error listing files: {e}", err=True)
|
|
if config['verbose']:
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('cache-info')
|
|
@pass_config
|
|
def cache_info(config):
|
|
"""
|
|
Display cache statistics and effectiveness.
|
|
|
|
Shows information about AST cache including directory path,
|
|
total files cached, cache size, and performance metrics.
|
|
"""
|
|
try:
|
|
cache_service = CacheDirectoryService()
|
|
stats = cache_service.get_cache_stats()
|
|
|
|
click.echo(f"Cache Directory: {stats['directory']}")
|
|
click.echo(f"Total Files: {stats['total_files']}")
|
|
click.echo(f"Cache Size: {stats['size_formatted']}")
|
|
|
|
except Exception as e:
|
|
click.echo(f"Cache info error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('cache-clean')
|
|
@pass_config
|
|
def cache_clean(config):
|
|
"""
|
|
Clear cache and free memory.
|
|
|
|
Removes all cached AST files from the cache directory
|
|
to free up disk space and memory.
|
|
"""
|
|
try:
|
|
cache_service = CacheDirectoryService()
|
|
result = cache_service.clean_cache()
|
|
|
|
click.echo(result['message'])
|
|
|
|
if not result['success'] and result.get('errors'):
|
|
for error in result['errors']:
|
|
click.echo(f"Warning: {error}", err=True)
|
|
|
|
if not result['success']:
|
|
sys.exit(1)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Cache clean error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('cache-invalidate')
|
|
@click.argument('file_path', type=str)
|
|
@pass_config
|
|
def cache_invalidate(config, file_path):
|
|
"""
|
|
Invalidate specific file cache.
|
|
|
|
Removes the cached AST for a specific markdown file,
|
|
forcing it to be re-parsed on next access.
|
|
|
|
Args:
|
|
file_path: Path to the file whose cache should be invalidated
|
|
"""
|
|
try:
|
|
cache_service = CacheDirectoryService()
|
|
result = cache_service.invalidate_file_cache(file_path)
|
|
|
|
click.echo(result['message'])
|
|
|
|
if not result['success']:
|
|
sys.exit(1)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Cache invalidate error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('ast-show')
|
|
@click.argument('file_path', type=click.Path(exists=False))
|
|
@click.option('--format', '-f', type=click.Choice(['tree', 'json', 'compact']), default='tree', help='Display format')
|
|
@pass_config
|
|
def ast_show(config, file_path, format):
|
|
"""
|
|
Display AST structure for file.
|
|
|
|
Shows the Abstract Syntax Tree representation of a markdown file
|
|
with various formatting options for analysis and debugging.
|
|
|
|
FILE_PATH: Path to the markdown file to analyze
|
|
|
|
Examples:
|
|
markitect ast-show document.md
|
|
markitect ast-show document.md --format json
|
|
markitect ast-show document.md --format compact
|
|
"""
|
|
try:
|
|
if config.get('verbose'):
|
|
click.echo(f"Analyzing AST structure for: {file_path}", err=True)
|
|
|
|
ast_service = ASTService()
|
|
result = ast_service.display_ast(Path(file_path), format)
|
|
|
|
if result['success']:
|
|
if result.get('message'):
|
|
if config.get('verbose'):
|
|
click.echo(f"Info: {result['message']}", err=True)
|
|
click.echo(result['output'])
|
|
|
|
if config.get('verbose') and result.get('token_count'):
|
|
click.echo(f"Total tokens: {result['token_count']}", err=True)
|
|
else:
|
|
click.echo(f"Error: {result['message']}", err=True)
|
|
sys.exit(1)
|
|
|
|
except Exception as e:
|
|
click.echo(f"AST display error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('ast-query')
|
|
@click.argument('file_path', type=click.Path(exists=False))
|
|
@click.argument('jsonpath', type=str)
|
|
@click.option('--format', '-f', type=click.Choice(['json', 'compact']), default='json', help='Output format')
|
|
@pass_config
|
|
def ast_query(config, file_path, jsonpath, format):
|
|
"""
|
|
Query AST using JSONPath.
|
|
|
|
Execute JSONPath expressions against the AST structure of a markdown file
|
|
to extract specific elements or patterns.
|
|
|
|
FILE_PATH: Path to the markdown file to query
|
|
JSONPATH: JSONPath expression to execute
|
|
|
|
Examples:
|
|
markitect ast-query doc.md '$.*.type'
|
|
markitect ast-query doc.md '$..tag'
|
|
markitect ast-query doc.md '$[:5]' --format compact
|
|
"""
|
|
try:
|
|
if config.get('verbose'):
|
|
click.echo(f"Executing JSONPath query on: {file_path}", err=True)
|
|
click.echo(f"Query: {jsonpath}", err=True)
|
|
|
|
ast_service = ASTService()
|
|
result = ast_service.query_ast(Path(file_path), jsonpath)
|
|
|
|
if result['success']:
|
|
if config.get('verbose'):
|
|
click.echo(f"Query results: {result['count']} matches", err=True)
|
|
|
|
if result['count'] == 0:
|
|
click.echo("No matches found for query.")
|
|
else:
|
|
if format == 'compact':
|
|
for i, match in enumerate(result['matches']):
|
|
if isinstance(match, dict):
|
|
token_type = match.get('type', 'unknown')
|
|
content = match.get('content', match.get('tag', ''))[:30]
|
|
click.echo(f"[{i}] {token_type}: {content}")
|
|
else:
|
|
click.echo(f"[{i}] {match}")
|
|
else:
|
|
import json
|
|
click.echo(json.dumps(result['matches'], indent=2, ensure_ascii=False))
|
|
else:
|
|
click.echo(f"Error: {result['message']}", err=True)
|
|
sys.exit(1)
|
|
|
|
except Exception as e:
|
|
click.echo(f"AST query error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('ast-stats')
|
|
@click.argument('file_path', type=click.Path(exists=False))
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']), default='table', help='Output format')
|
|
@pass_config
|
|
def ast_stats(config, file_path, format):
|
|
"""
|
|
Show AST statistics (headings, links, etc.).
|
|
|
|
Analyze markdown file structure and provide comprehensive statistics
|
|
about document elements, organization, and content patterns.
|
|
|
|
FILE_PATH: Path to the markdown file to analyze
|
|
|
|
Examples:
|
|
markitect ast-stats document.md
|
|
markitect ast-stats document.md --format json
|
|
markitect ast-stats document.md --format yaml
|
|
"""
|
|
try:
|
|
if config.get('verbose'):
|
|
click.echo(f"Calculating statistics for: {file_path}", err=True)
|
|
|
|
ast_service = ASTService()
|
|
result = ast_service.analyze_ast_statistics(Path(file_path))
|
|
|
|
if result['success']:
|
|
if config.get('verbose'):
|
|
click.echo(f"Analysis complete for: {Path(file_path).name}", err=True)
|
|
|
|
stats = result['statistics']
|
|
if format == 'table':
|
|
# Format statistics as readable table
|
|
click.echo("Document Statistics:")
|
|
click.echo("=" * 40)
|
|
click.echo(f"Total AST tokens: {stats.get('total_tokens', 0)}")
|
|
click.echo(f"Document structure: {stats.get('document_structure', 'unknown')}")
|
|
click.echo()
|
|
|
|
# Headings
|
|
headings = stats.get('headings', {})
|
|
click.echo(f"Headings: {headings.get('total', 0)}")
|
|
for level, count in headings.get('by_level', {}).items():
|
|
click.echo(f" {level.upper()}: {count}")
|
|
|
|
click.echo(f"Paragraphs: {stats.get('paragraphs', 0)}")
|
|
click.echo(f"Links: {stats.get('links', 0)}")
|
|
|
|
# Lists
|
|
lists = stats.get('lists', {})
|
|
total_lists = lists.get('ordered', 0) + lists.get('unordered', 0)
|
|
click.echo(f"Lists: {total_lists}")
|
|
if total_lists > 0:
|
|
click.echo(f" Ordered: {lists.get('ordered', 0)}")
|
|
click.echo(f" Unordered: {lists.get('unordered', 0)}")
|
|
|
|
click.echo(f"Code blocks: {stats.get('code_blocks', 0)}")
|
|
click.echo(f"Inline code: {stats.get('inline_code', 0)}")
|
|
click.echo(f"Blockquotes: {stats.get('blockquotes', 0)}")
|
|
|
|
# Emphasis
|
|
emphasis = stats.get('emphasis', {})
|
|
click.echo(f"Strong text: {emphasis.get('strong', 0)}")
|
|
click.echo(f"Italic text: {emphasis.get('italic', 0)}")
|
|
|
|
elif format == 'json':
|
|
import json
|
|
click.echo(json.dumps(stats, indent=2, ensure_ascii=False))
|
|
elif format == 'yaml':
|
|
import yaml
|
|
click.echo(yaml.dump(stats, default_flow_style=False, allow_unicode=True))
|
|
elif format == 'simple':
|
|
# Simple format - same as table but more concise
|
|
click.echo("Document Statistics:")
|
|
click.echo("=" * 40)
|
|
click.echo(f"Total AST tokens: {stats.get('total_tokens', 0)}")
|
|
click.echo(f"Document structure: {stats.get('document_structure', 'unknown')}")
|
|
click.echo()
|
|
# Headings
|
|
headings = stats.get('headings', {})
|
|
click.echo(f"Headings: {headings.get('total', 0)}")
|
|
for level, count in headings.get('by_level', {}).items():
|
|
click.echo(f" {level.upper()}: {count}")
|
|
click.echo(f"Paragraphs: {stats.get('paragraphs', 0)}")
|
|
click.echo(f"Links: {stats.get('links', 0)}")
|
|
# Lists
|
|
lists = stats.get('lists', {})
|
|
total_lists = lists.get('ordered', 0) + lists.get('unordered', 0)
|
|
click.echo(f"Lists: {total_lists}")
|
|
if total_lists > 0:
|
|
click.echo(f" Ordered: {lists.get('ordered', 0)}")
|
|
click.echo(f" Unordered: {lists.get('unordered', 0)}")
|
|
click.echo(f"Code blocks: {stats.get('code_blocks', 0)}")
|
|
click.echo(f"Inline code: {stats.get('inline_code', 0)}")
|
|
click.echo(f"Blockquotes: {stats.get('blockquotes', 0)}")
|
|
# Emphasis
|
|
emphasis = stats.get('emphasis', {})
|
|
click.echo(f"Strong text: {emphasis.get('strong', 0)}")
|
|
click.echo(f"Italic text: {emphasis.get('italic', 0)}")
|
|
|
|
else:
|
|
click.echo(f"Error: {result['message']}", err=True)
|
|
sys.exit(1)
|
|
|
|
except Exception as e:
|
|
click.echo(f"AST statistics error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('schema-generate')
|
|
@click.argument('file_path', type=click.Path(exists=True, path_type=Path))
|
|
@click.option('--max-depth', '-d', type=int, help='Maximum heading depth to include in schema')
|
|
@click.option('--output', '-o', type=click.Path(path_type=Path), help='Output file path (default: stdout)')
|
|
@click.option('--format', 'output_format', type=click.Choice(['json', 'yaml']), default='json', help='Output format')
|
|
@pass_config
|
|
def generate_schema(config, file_path, max_depth, output, output_format):
|
|
"""
|
|
Generate a JSON schema from a markdown file's AST structure.
|
|
|
|
FILE_PATH: Path to the markdown file to analyze
|
|
|
|
Example:
|
|
markitect schema-generate document.md
|
|
markitect schema-generate document.md --max-depth 2
|
|
markitect schema-generate document.md --output schema.json
|
|
"""
|
|
try:
|
|
# Initialize schema generator and associated files manager
|
|
generator = SchemaGenerator()
|
|
from .associated_files import AssociatedFilesManager
|
|
associated_files = AssociatedFilesManager()
|
|
|
|
# Generate schema
|
|
schema = generator.generate_schema_from_file(file_path, max_depth=max_depth)
|
|
|
|
# Format output
|
|
if output_format == 'json':
|
|
formatted_output = json.dumps(schema, indent=2, ensure_ascii=False)
|
|
elif output_format == 'yaml':
|
|
formatted_output = yaml.dump(schema, default_flow_style=False, allow_unicode=True)
|
|
else:
|
|
formatted_output = json.dumps(schema, indent=2, ensure_ascii=False)
|
|
|
|
# Mode-based output logic
|
|
if not output and should_use_associated_files():
|
|
# Interactive mode: use associated file path
|
|
from .associated_files import AssociatedFilesManager
|
|
associated_files = AssociatedFilesManager()
|
|
output = associated_files.get_associated_schema_path(file_path)
|
|
if config.get('verbose'):
|
|
click.echo(f"Interactive mode: using associated file path: {output}", err=True)
|
|
|
|
# Write to output
|
|
if output:
|
|
output.write_text(formatted_output, encoding='utf-8')
|
|
click.echo(f"Schema written to: {output}")
|
|
|
|
# Show summary
|
|
properties = schema.get('properties', {})
|
|
click.echo(f"Generated schema with {len(properties)} property types")
|
|
|
|
if 'headings' in properties:
|
|
heading_levels = len(properties['headings'].get('properties', {}))
|
|
click.echo(f" - {heading_levels} heading levels found")
|
|
|
|
structural_elements = ['paragraphs', 'lists', 'code_blocks', 'blockquotes', 'tables']
|
|
found_elements = [elem for elem in structural_elements if elem in properties]
|
|
if found_elements:
|
|
click.echo(f" - Structural elements: {', '.join(found_elements)}")
|
|
else:
|
|
click.echo(formatted_output)
|
|
|
|
except FileNotFoundError as e:
|
|
click.echo(f"File not found: {e}", err=True)
|
|
sys.exit(1)
|
|
except InvalidDepthError as e:
|
|
click.echo(f"Invalid depth parameter: {e}", err=True)
|
|
sys.exit(1)
|
|
except Exception as e:
|
|
click.echo(f"Schema generation error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('validate')
|
|
@click.argument('file_path', type=click.Path(exists=True, path_type=Path))
|
|
@click.option('--schema', '-s', type=click.Path(exists=True, path_type=Path),
|
|
help='Path to JSON schema file')
|
|
@click.option('--schema-json', type=str,
|
|
help='JSON schema provided as a string')
|
|
@click.option('--quiet', '-q', is_flag=True,
|
|
help='Only output validation result (true/false)')
|
|
@click.option('--detailed-errors', '--errors', is_flag=True,
|
|
help='Show detailed validation errors (Issue #8)')
|
|
@click.option('--error-format', type=click.Choice(['text', 'json', 'markdown']), default='text',
|
|
help='Format for detailed error output')
|
|
@pass_config
|
|
def validate(config, file_path, schema, schema_json, quiet, detailed_errors, error_format):
|
|
"""
|
|
Validate a markdown file against a JSON schema.
|
|
|
|
Checks if a markdown document strictly adheres to the structure defined
|
|
by a specified schema. Returns boolean result (True/False).
|
|
|
|
Issue #8: Enhanced with detailed error reporting for failed validations.
|
|
|
|
Examples:
|
|
markitect validate doc.md --schema schema.json
|
|
markitect validate doc.md --schema-json '{"$schema": "...", "type": "object"}'
|
|
markitect validate doc.md --schema schema.json --detailed-errors
|
|
markitect validate doc.md --schema schema.json --errors --error-format json
|
|
"""
|
|
try:
|
|
validator = SchemaValidator()
|
|
from .associated_files import AssociatedFilesManager
|
|
associated_files = AssociatedFilesManager()
|
|
|
|
# Validate schema source or auto-discover
|
|
schema_sources = [schema, schema_json]
|
|
provided_sources = [s for s in schema_sources if s is not None]
|
|
|
|
if len(provided_sources) == 0:
|
|
# Auto-discover associated schema file
|
|
auto_schema = associated_files.find_associated_schema(file_path)
|
|
if auto_schema:
|
|
schema = auto_schema
|
|
if config.get('verbose'):
|
|
click.echo(f"Auto-discovered associated schema: {schema}", err=True)
|
|
else:
|
|
click.echo("Error: No schema specified and no associated schema file found", err=True)
|
|
click.echo("Provide --schema FILE or --schema-json JSON, or ensure an associated .json file exists", err=True)
|
|
sys.exit(1)
|
|
elif len(provided_sources) > 1:
|
|
click.echo("Error: Specify exactly one schema source (--schema or --schema-json)", err=True)
|
|
sys.exit(1)
|
|
|
|
# Perform validation (with or without detailed errors)
|
|
if detailed_errors:
|
|
# Use detailed error reporting for Issue #8
|
|
if schema:
|
|
error_collector = validator.validate_file_with_errors_file(file_path, schema)
|
|
schema_source = f"schema file: {schema}"
|
|
else:
|
|
error_collector = validator.validate_file_with_errors_string(file_path, schema_json)
|
|
schema_source = "provided JSON schema"
|
|
|
|
is_valid = not error_collector.has_errors()
|
|
|
|
# Output detailed errors
|
|
if quiet:
|
|
click.echo(str(is_valid).lower())
|
|
else:
|
|
status = "VALID" if is_valid else "INVALID"
|
|
click.echo(f"Validation result: {status}")
|
|
click.echo(f"File: {file_path}")
|
|
click.echo(f"Schema: {schema_source}")
|
|
|
|
if is_valid:
|
|
click.echo("✅ Document structure matches schema requirements")
|
|
else:
|
|
click.echo("❌ Document structure does not match schema requirements")
|
|
click.echo()
|
|
click.echo(error_collector.format_errors(error_format))
|
|
|
|
else:
|
|
# Use simple boolean validation (original Issue #7 functionality)
|
|
if schema:
|
|
is_valid = validator.validate_file_against_schema_file(file_path, schema)
|
|
schema_source = f"schema file: {schema}"
|
|
else:
|
|
is_valid = validator.validate_file_against_schema_string(file_path, schema_json)
|
|
schema_source = "provided JSON schema"
|
|
|
|
# Output results
|
|
if quiet:
|
|
click.echo(str(is_valid).lower())
|
|
else:
|
|
status = "VALID" if is_valid else "INVALID"
|
|
click.echo(f"Validation result: {status}")
|
|
click.echo(f"File: {file_path}")
|
|
click.echo(f"Schema: {schema_source}")
|
|
|
|
if is_valid:
|
|
click.echo("✅ Document structure matches schema requirements")
|
|
else:
|
|
click.echo("❌ Document structure does not match schema requirements")
|
|
click.echo("💡 Use --detailed-errors to see specific validation issues")
|
|
|
|
# Exit with appropriate code
|
|
sys.exit(0 if is_valid else 1)
|
|
|
|
except FileNotFoundError as e:
|
|
click.echo(f"File not found: {e}", err=True)
|
|
sys.exit(1)
|
|
except (InvalidSchemaError, SchemaValidationError) as e:
|
|
click.echo(f"Schema validation error: {e}", err=True)
|
|
sys.exit(1)
|
|
except Exception as e:
|
|
click.echo(f"Validation error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
# Schema management commands for Issue #3
|
|
@cli.command('schema-ingest')
|
|
@click.argument('schema_file', type=click.Path(exists=True, path_type=Path))
|
|
@click.option('--name', type=str, help='Custom name for the schema (default: filename)')
|
|
@pass_config
|
|
def schema_ingest(config, schema_file, name):
|
|
"""
|
|
Read and store a JSON schema file in the database.
|
|
|
|
Implements Issue #3 functionality to ingest external schema files
|
|
and store them for later use with validation and other operations.
|
|
|
|
SCHEMA_FILE: Path to the JSON schema file to store
|
|
|
|
Examples:
|
|
markitect schema-ingest my_schema.json
|
|
markitect schema-ingest external_schema.json --name custom-name
|
|
"""
|
|
try:
|
|
# Determine schema name
|
|
schema_name = name if name else schema_file.name
|
|
|
|
# Read schema file content
|
|
with open(schema_file, 'r', encoding='utf-8') as f:
|
|
schema_content = f.read()
|
|
|
|
# Validate JSON format
|
|
try:
|
|
schema_data = json.loads(schema_content)
|
|
except json.JSONDecodeError as e:
|
|
click.echo(f"Error: Invalid JSON in schema file - {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
# Initialize database and store schema
|
|
from .database import DatabaseManager
|
|
db_path = config.get('database', 'markitect.db')
|
|
db_manager = DatabaseManager(db_path)
|
|
db_manager.initialize_database()
|
|
|
|
record_id = db_manager.store_schema_file(schema_name, schema_content)
|
|
|
|
if record_id:
|
|
title = schema_data.get('title', schema_name)
|
|
description = schema_data.get('description', '')
|
|
|
|
click.echo(f"✅ Schema stored successfully")
|
|
click.echo(f" Name: {schema_name}")
|
|
click.echo(f" Title: {title}")
|
|
if description:
|
|
click.echo(f" Description: {description}")
|
|
click.echo(f" Record ID: {record_id}")
|
|
|
|
if config.get('verbose'):
|
|
click.echo(f" Source file: {schema_file}")
|
|
click.echo(f" Database: {db_path}")
|
|
else:
|
|
click.echo("❌ Failed to store schema in database", err=True)
|
|
sys.exit(1)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Schema ingest error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('schema-list')
|
|
@click.option('--format', 'output_format', type=click.Choice(['table', 'json', 'yaml', 'simple']),
|
|
default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']), help='Output format')
|
|
@click.option('--names-only', is_flag=True, help='Show only schema names (no metadata)')
|
|
@pass_config
|
|
def schema_list(config, output_format, names_only):
|
|
"""
|
|
List all stored schema files.
|
|
|
|
Shows metadata for all JSON schemas stored in the database,
|
|
including their names, titles, descriptions, and timestamps.
|
|
|
|
Examples:
|
|
markitect schema-list
|
|
markitect schema-list --format json
|
|
markitect schema-list --format simple
|
|
markitect schema-list --names-only
|
|
"""
|
|
try:
|
|
from .database import DatabaseManager
|
|
|
|
db_path = config.get('database', 'markitect.db')
|
|
db_manager = DatabaseManager(db_path)
|
|
schemas = db_manager.list_schema_files()
|
|
|
|
if not schemas:
|
|
click.echo("No schemas found in database.")
|
|
return
|
|
|
|
# Handle names-only option
|
|
if names_only:
|
|
for schema_info in schemas:
|
|
click.echo(schema_info['filename'])
|
|
return
|
|
|
|
# Handle different output formats
|
|
if output_format == 'simple':
|
|
# Simple emoji format like the original list command
|
|
click.echo(f"Found {len(schemas)} schema(s):")
|
|
click.echo()
|
|
|
|
for schema_info in schemas:
|
|
click.echo(f"🔧 {schema_info['filename']}")
|
|
if config.get('verbose'):
|
|
click.echo(f" Title: {schema_info['title']}")
|
|
click.echo(f" Created: {schema_info['created_at']}")
|
|
if schema_info['description']:
|
|
click.echo(f" Description: {schema_info['description']}")
|
|
click.echo()
|
|
else:
|
|
# Use structured format (table, json, yaml)
|
|
formatted_output = format_output(schemas, output_format)
|
|
click.echo(formatted_output)
|
|
|
|
if config.get('verbose'):
|
|
click.echo(f"\nTotal schemas: {len(schemas)}", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Schema list error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('schema-get')
|
|
@click.argument('schema_name', type=str)
|
|
@click.option('--output', '-o', type=click.Path(path_type=Path),
|
|
help='Output file path (default: stdout)')
|
|
@pass_config
|
|
def schema_get(config, schema_name, output):
|
|
"""
|
|
Retrieve and output a stored schema file.
|
|
|
|
Fetches a JSON schema from the database by name and outputs
|
|
its content either to stdout or to a specified file.
|
|
|
|
SCHEMA_NAME: Name of the stored schema to retrieve
|
|
|
|
Examples:
|
|
markitect schema-get my_schema.json
|
|
markitect schema-get my_schema.json --output exported_schema.json
|
|
"""
|
|
try:
|
|
from .database import DatabaseManager
|
|
|
|
db_path = config.get('database', 'markitect.db')
|
|
db_manager = DatabaseManager(db_path)
|
|
schema_data = db_manager.get_schema_file(schema_name)
|
|
|
|
if not schema_data:
|
|
click.echo(f"Error: Schema '{schema_name}' not found in database", err=True)
|
|
sys.exit(1)
|
|
|
|
schema_content = schema_data['schema_content']
|
|
|
|
# Output to file or stdout
|
|
if output:
|
|
with open(output, 'w', encoding='utf-8') as f:
|
|
f.write(schema_content)
|
|
click.echo(f"✅ Schema exported to: {output}")
|
|
|
|
if config.get('verbose'):
|
|
click.echo(f" Title: {schema_data['title']}")
|
|
click.echo(f" Description: {schema_data['description']}")
|
|
else:
|
|
click.echo(schema_content)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Schema get error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('schema-delete')
|
|
@click.argument('schema_name', type=str)
|
|
@click.option('--confirm', is_flag=True, help='Skip confirmation prompt')
|
|
@pass_config
|
|
def schema_delete(config, schema_name, confirm):
|
|
"""
|
|
Delete a stored schema file from the database.
|
|
|
|
Removes a JSON schema from the database permanently.
|
|
This action cannot be undone.
|
|
|
|
SCHEMA_NAME: Name of the stored schema to delete
|
|
|
|
Examples:
|
|
markitect schema-delete old_schema.json
|
|
markitect schema-delete old_schema.json --confirm
|
|
"""
|
|
try:
|
|
from .database import DatabaseManager
|
|
|
|
db_path = config.get('database', 'markitect.db')
|
|
db_manager = DatabaseManager(db_path)
|
|
|
|
# Check if schema exists
|
|
schema_data = db_manager.get_schema_file(schema_name)
|
|
if not schema_data:
|
|
click.echo(f"Error: Schema '{schema_name}' not found in database", err=True)
|
|
sys.exit(1)
|
|
|
|
# Confirmation prompt
|
|
if not confirm:
|
|
title = schema_data['title']
|
|
click.echo(f"Schema to delete:")
|
|
click.echo(f" Name: {schema_name}")
|
|
click.echo(f" Title: {title}")
|
|
click.echo(f" Created: {schema_data['created_at']}")
|
|
|
|
if not click.confirm("Are you sure you want to delete this schema?"):
|
|
click.echo("Deletion cancelled.")
|
|
return
|
|
|
|
# Perform deletion
|
|
success = db_manager.delete_schema_file(schema_name)
|
|
|
|
if success:
|
|
click.echo(f"✅ Schema '{schema_name}' deleted successfully")
|
|
else:
|
|
click.echo(f"❌ Failed to delete schema '{schema_name}'", err=True)
|
|
sys.exit(1)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Schema delete error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('generate-stub')
|
|
@click.argument('schema_file', type=click.Path(exists=True, path_type=Path))
|
|
@click.option('--output', '-o', type=click.Path(path_type=Path),
|
|
help='Output file path (default: stdout)')
|
|
@click.option('--style', type=click.Choice(['default', 'custom', 'detailed']),
|
|
default='default', help='Placeholder content style')
|
|
@click.option('--title', type=str, help='Custom document title')
|
|
@pass_config
|
|
def generate_stub(config, schema_file, output, style, title):
|
|
"""
|
|
Generate a markdown stub/template from a JSON schema.
|
|
|
|
Creates a markdown document with proper heading hierarchy and placeholder
|
|
content based on the structural definitions in the JSON schema.
|
|
|
|
SCHEMA_FILE: Path to the JSON schema file
|
|
|
|
Examples:
|
|
markitect generate-stub blog_schema.json
|
|
markitect generate-stub schema.json --output template.md
|
|
markitect generate-stub schema.json --style detailed --title "My Document"
|
|
"""
|
|
try:
|
|
if config.get('verbose'):
|
|
click.echo(f"Generating stub from schema: {schema_file}", err=True)
|
|
|
|
from .stub_generator import StubGenerator
|
|
from .associated_files import AssociatedFilesManager
|
|
|
|
generator = StubGenerator()
|
|
associated_files = AssociatedFilesManager()
|
|
|
|
# Load schema and generate stub content
|
|
import json
|
|
with open(schema_file, 'r') as f:
|
|
schema = json.load(f)
|
|
|
|
stub_content = generator.generate_stub_from_schema(
|
|
schema, placeholder_style=style, title=title
|
|
)
|
|
|
|
# Mode-based output logic
|
|
if not output and should_use_associated_files():
|
|
# Interactive mode: use associated file path
|
|
output = associated_files.get_associated_markdown_path(schema_file)
|
|
if config.get('verbose'):
|
|
click.echo(f"Interactive mode: using associated file path: {output}", err=True)
|
|
|
|
# Output to file or stdout
|
|
if output:
|
|
generator.generate_stub_to_file(schema, output, style, title)
|
|
click.echo(f"✅ Stub generated: {output}")
|
|
|
|
if config.get('verbose'):
|
|
click.echo(f"Generated markdown template saved to: {output}", err=True)
|
|
else:
|
|
click.echo(stub_content)
|
|
|
|
if config.get('verbose'):
|
|
click.echo(f"Generated {len(stub_content)} characters of content", err=True)
|
|
|
|
except FileNotFoundError as e:
|
|
click.echo(f"Error: {e}", err=True)
|
|
sys.exit(1)
|
|
except json.JSONDecodeError as e:
|
|
click.echo(f"Error: Invalid JSON in schema file - {e}", err=True)
|
|
sys.exit(1)
|
|
except Exception as e:
|
|
click.echo(f"Stub generation error: {e}", err=True)
|
|
if config and config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.group('associated-files')
|
|
@pass_config
|
|
def associated_files_group(config):
|
|
"""
|
|
Manage associated markdown and schema file pairs.
|
|
|
|
Commands for working with files that follow the convention of having
|
|
identical basenames with different extensions (e.g., document.md ↔ document.json).
|
|
"""
|
|
pass
|
|
|
|
|
|
@associated_files_group.command('list')
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']),
|
|
default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']),
|
|
help='Output format')
|
|
@click.argument('directory', type=click.Path(exists=True, file_okay=False, path_type=Path), default='.')
|
|
@pass_config
|
|
def list_associated_files(config, format, directory):
|
|
"""
|
|
List all associated file pairs in a directory.
|
|
|
|
Shows markdown/schema file pairs that follow the naming convention.
|
|
|
|
Examples:
|
|
markitect associated-files list
|
|
markitect associated-files list docs/
|
|
markitect associated-files list --format json
|
|
"""
|
|
try:
|
|
from .associated_files import AssociatedFilesManager
|
|
manager = AssociatedFilesManager()
|
|
|
|
if config.get('verbose'):
|
|
click.echo(f"Scanning directory: {directory}", err=True)
|
|
|
|
pairs = manager.list_file_pairs(directory)
|
|
|
|
if not pairs:
|
|
click.echo("No associated file pairs found.")
|
|
return
|
|
|
|
# Format output
|
|
if format == 'table':
|
|
click.echo(f"Associated File Pairs in {directory}:")
|
|
click.echo("=" * 60)
|
|
for pair in pairs:
|
|
click.echo(f"📄 {pair['basename']}")
|
|
click.echo(f" Markdown: {pair['markdown_file'].name}")
|
|
click.echo(f" Schema: {pair['schema_file'].name}")
|
|
click.echo()
|
|
elif format == 'json':
|
|
import json
|
|
output_data = []
|
|
for pair in pairs:
|
|
output_data.append({
|
|
'basename': pair['basename'],
|
|
'markdown_file': str(pair['markdown_file']),
|
|
'schema_file': str(pair['schema_file']),
|
|
'both_exist': pair['both_exist']
|
|
})
|
|
click.echo(json.dumps(output_data, indent=2))
|
|
elif format == 'yaml':
|
|
import yaml
|
|
output_data = []
|
|
for pair in pairs:
|
|
output_data.append({
|
|
'basename': pair['basename'],
|
|
'markdown_file': str(pair['markdown_file']),
|
|
'schema_file': str(pair['schema_file']),
|
|
'both_exist': pair['both_exist']
|
|
})
|
|
click.echo(yaml.dump(output_data, default_flow_style=False))
|
|
else:
|
|
# Simple format
|
|
for pair in pairs:
|
|
click.echo(f"{pair['basename']} ({pair['markdown_file'].name} ↔ {pair['schema_file'].name})")
|
|
|
|
if config.get('verbose'):
|
|
click.echo(f"Found {len(pairs)} associated file pairs", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error listing associated files: {e}", err=True)
|
|
if config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@associated_files_group.command('info')
|
|
@click.argument('file_path', type=click.Path(exists=True, path_type=Path))
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']),
|
|
default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']),
|
|
help='Output format')
|
|
@pass_config
|
|
def associated_files_info(config, file_path, format):
|
|
"""
|
|
Show detailed information about associated files.
|
|
|
|
Displays information about a file and its associated counterpart.
|
|
|
|
Examples:
|
|
markitect associated-files info document.md
|
|
markitect associated-files info schema.json --format json
|
|
"""
|
|
try:
|
|
from .associated_files import AssociatedFilesManager
|
|
manager = AssociatedFilesManager()
|
|
|
|
info = manager.get_file_pair_info(file_path)
|
|
|
|
if format == 'table':
|
|
click.echo(f"Associated Files Information:")
|
|
click.echo("=" * 40)
|
|
click.echo(f"Basename: {info['basename']}")
|
|
click.echo(f"Markdown: {info['markdown_file']}")
|
|
click.echo(f" Exists: {'✅' if info['markdown_file'].exists() else '❌'}")
|
|
if 'markdown_size' in info:
|
|
click.echo(f" Size: {info['markdown_size']} bytes")
|
|
|
|
click.echo(f"Schema: {info['schema_file']}")
|
|
click.echo(f" Exists: {'✅' if info['schema_file'].exists() else '❌'}")
|
|
if 'schema_size' in info:
|
|
click.echo(f" Size: {info['schema_size']} bytes")
|
|
|
|
click.echo(f"Both exist: {'✅' if info['both_exist'] else '❌'}")
|
|
|
|
elif format == 'json':
|
|
import json
|
|
# Convert Path objects to strings for JSON serialization
|
|
json_info = {k: str(v) if isinstance(v, Path) else v for k, v in info.items()}
|
|
click.echo(json.dumps(json_info, indent=2))
|
|
|
|
elif format == 'yaml':
|
|
import yaml
|
|
# Convert Path objects to strings for YAML serialization
|
|
yaml_info = {k: str(v) if isinstance(v, Path) else v for k, v in info.items()}
|
|
click.echo(yaml.dump(yaml_info, default_flow_style=False))
|
|
else:
|
|
# Simple format
|
|
status = "paired" if info['both_exist'] else "orphaned"
|
|
click.echo(f"{info['basename']}: {status}")
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error getting file info: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@associated_files_group.command('status')
|
|
@click.argument('directory', type=click.Path(exists=True, file_okay=False, path_type=Path), default='.')
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']),
|
|
default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']),
|
|
help='Output format')
|
|
@pass_config
|
|
def associated_files_status(config, directory, format):
|
|
"""
|
|
Show status of associated files in a directory.
|
|
|
|
Displays paired files and orphaned files (files without their counterpart).
|
|
|
|
Examples:
|
|
markitect associated-files status
|
|
markitect associated-files status docs/
|
|
"""
|
|
try:
|
|
from .associated_files import AssociatedFilesManager
|
|
manager = AssociatedFilesManager()
|
|
|
|
status = manager.get_directory_status(directory)
|
|
|
|
if format == 'table':
|
|
click.echo(f"Associated Files Status for {directory}:")
|
|
click.echo("=" * 50)
|
|
click.echo(f"📌 Paired files: {status['paired_files']}")
|
|
click.echo(f"📄 Orphaned markdown: {status['orphaned_markdown']}")
|
|
click.echo(f"🔧 Orphaned schemas: {status['orphaned_schemas']}")
|
|
|
|
if status['pairs']:
|
|
click.echo("\n📌 Paired Files:")
|
|
for pair in status['pairs']:
|
|
click.echo(f" • {pair['basename']}")
|
|
|
|
if status['orphaned']['orphaned_markdown']:
|
|
click.echo("\n📄 Orphaned Markdown Files:")
|
|
for md in status['orphaned']['orphaned_markdown']:
|
|
click.echo(f" • {md.name}")
|
|
|
|
if status['orphaned']['orphaned_schemas']:
|
|
click.echo("\n🔧 Orphaned Schema Files:")
|
|
for schema in status['orphaned']['orphaned_schemas']:
|
|
click.echo(f" • {schema.name}")
|
|
|
|
elif format == 'json':
|
|
import json
|
|
# Convert Path objects to strings for JSON serialization
|
|
json_status = {
|
|
'directory': str(status['directory']),
|
|
'paired_files': status['paired_files'],
|
|
'orphaned_markdown': status['orphaned_markdown'],
|
|
'orphaned_schemas': status['orphaned_schemas'],
|
|
'pairs': [{'basename': p['basename'],
|
|
'markdown_file': str(p['markdown_file']),
|
|
'schema_file': str(p['schema_file'])}
|
|
for p in status['pairs']],
|
|
'orphaned': {
|
|
'orphaned_markdown': [str(f) for f in status['orphaned']['orphaned_markdown']],
|
|
'orphaned_schemas': [str(f) for f in status['orphaned']['orphaned_schemas']]
|
|
}
|
|
}
|
|
click.echo(json.dumps(json_status, indent=2))
|
|
|
|
elif format == 'yaml':
|
|
import yaml
|
|
yaml_status = {
|
|
'directory': str(status['directory']),
|
|
'paired_files': status['paired_files'],
|
|
'orphaned_markdown': status['orphaned_markdown'],
|
|
'orphaned_schemas': status['orphaned_schemas'],
|
|
'pairs': [{'basename': p['basename'],
|
|
'markdown_file': str(p['markdown_file']),
|
|
'schema_file': str(p['schema_file'])}
|
|
for p in status['pairs']],
|
|
'orphaned': {
|
|
'orphaned_markdown': [str(f) for f in status['orphaned']['orphaned_markdown']],
|
|
'orphaned_schemas': [str(f) for f in status['orphaned']['orphaned_schemas']]
|
|
}
|
|
}
|
|
click.echo(yaml.dump(yaml_status, default_flow_style=False))
|
|
else:
|
|
# Simple format
|
|
click.echo(f"Paired: {status['paired_files']}, Orphaned: {status['orphaned_markdown'] + status['orphaned_schemas']}")
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error getting status: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@associated_files_group.command('create-schema')
|
|
@click.argument('markdown_file', type=click.Path(exists=True, path_type=Path))
|
|
@click.option('--max-depth', '-d', type=int, help='Maximum heading depth to include in schema')
|
|
@pass_config
|
|
def create_associated_schema(config, markdown_file, max_depth):
|
|
"""
|
|
Create an associated schema file for a markdown file.
|
|
|
|
Generates a JSON schema and places it next to the source markdown file
|
|
with the same basename but .json extension.
|
|
|
|
Examples:
|
|
markitect associated-files create-schema document.md
|
|
markitect associated-files create-schema doc.md --max-depth 3
|
|
"""
|
|
try:
|
|
from .associated_files import AssociatedFilesManager
|
|
from .schema_generator import SchemaGenerator
|
|
|
|
manager = AssociatedFilesManager()
|
|
generator = SchemaGenerator()
|
|
|
|
# Check if associated schema already exists
|
|
existing_schema = manager.find_associated_schema(markdown_file)
|
|
if existing_schema:
|
|
if not click.confirm(f"Associated schema {existing_schema} already exists. Overwrite?"):
|
|
click.echo("Operation cancelled.")
|
|
return
|
|
|
|
# Generate schema
|
|
schema = generator.generate_schema_from_file(markdown_file, max_depth=max_depth)
|
|
|
|
# Save to associated path
|
|
schema_path = manager.get_associated_schema_path(markdown_file)
|
|
|
|
import json
|
|
with open(schema_path, 'w', encoding='utf-8') as f:
|
|
json.dump(schema, f, indent=2, ensure_ascii=False)
|
|
|
|
click.echo(f"✅ Created associated schema: {schema_path}")
|
|
|
|
if config.get('verbose'):
|
|
properties = schema.get('properties', {})
|
|
click.echo(f"Generated schema with {len(properties)} property types", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error creating schema: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@associated_files_group.command('create-stub')
|
|
@click.argument('schema_file', type=click.Path(exists=True, path_type=Path))
|
|
@click.option('--style', type=click.Choice(['default', 'custom', 'detailed']),
|
|
default='default', help='Placeholder content style')
|
|
@click.option('--title', type=str, help='Custom document title')
|
|
@pass_config
|
|
def create_associated_stub(config, schema_file, style, title):
|
|
"""
|
|
Create an associated markdown stub for a schema file.
|
|
|
|
Generates a markdown template and places it next to the source schema file
|
|
with the same basename but .md extension.
|
|
|
|
Examples:
|
|
markitect associated-files create-stub schema.json
|
|
markitect associated-files create-stub schema.json --style detailed
|
|
"""
|
|
try:
|
|
from .associated_files import AssociatedFilesManager
|
|
from .stub_generator import StubGenerator
|
|
|
|
manager = AssociatedFilesManager()
|
|
generator = StubGenerator()
|
|
|
|
# Check if associated markdown already exists
|
|
existing_md = manager.find_associated_markdown(schema_file)
|
|
if existing_md:
|
|
if not click.confirm(f"Associated markdown {existing_md} already exists. Overwrite?"):
|
|
click.echo("Operation cancelled.")
|
|
return
|
|
|
|
# Load schema and generate stub
|
|
import json
|
|
with open(schema_file, 'r') as f:
|
|
schema = json.load(f)
|
|
|
|
# Save to associated path
|
|
md_path = manager.get_associated_markdown_path(schema_file)
|
|
generator.generate_stub_to_file(schema, md_path, style, title)
|
|
|
|
click.echo(f"✅ Created associated stub: {md_path}")
|
|
|
|
if config.get('verbose'):
|
|
content = md_path.read_text()
|
|
click.echo(f"Generated {len(content)} characters of content", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error creating stub: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('db-delete')
|
|
@click.option('--force', is_flag=True, help='Delete without confirmation prompt')
|
|
@click.option('--database', type=click.Path(), help='Database file path (overrides global setting)')
|
|
@pass_config
|
|
def db_delete(config, force, database):
|
|
"""
|
|
Delete the database file.
|
|
|
|
WARNING: This operation cannot be undone. All stored data will be lost.
|
|
|
|
Examples:
|
|
markitect db-delete
|
|
markitect db-delete --force
|
|
markitect db-delete --database /path/to/db.sqlite --force
|
|
"""
|
|
try:
|
|
# Use command-specific database option or fall back to global config
|
|
if database:
|
|
db_path = Path(database)
|
|
else:
|
|
db_path = Path(config.get('database_path', os.path.expanduser('~/.markitect/markitect.db')))
|
|
|
|
if not db_path.exists():
|
|
click.echo(f"Database file not found: {db_path}")
|
|
return
|
|
|
|
if not force:
|
|
if not click.confirm(f"⚠️ Are you sure you want to delete the database at {db_path}?\nThis action cannot be undone."):
|
|
click.echo("Operation cancelled.")
|
|
return
|
|
|
|
# Delete the database file
|
|
db_path.unlink()
|
|
click.echo(f"✅ Database deleted: {db_path}")
|
|
|
|
if config.get('verbose'):
|
|
click.echo("All stored data has been permanently removed.", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error deleting database: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('db-status')
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']),
|
|
default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']), help='Output format')
|
|
@click.option('--database', type=click.Path(), help='Database file path (overrides global setting)')
|
|
@pass_config
|
|
def db_status(config, format, database):
|
|
"""
|
|
Show database statistics and information.
|
|
|
|
Display database size and basic information. For detailed table analysis,
|
|
use existing database commands after ensuring the database is accessible.
|
|
|
|
Examples:
|
|
markitect db-status
|
|
markitect db-status --format json
|
|
markitect db-status --database /path/to/db.sqlite
|
|
"""
|
|
try:
|
|
# Use command-specific database option or fall back to global config
|
|
if database:
|
|
db_path = Path(database)
|
|
else:
|
|
db_path = Path(config.get('database_path', os.path.expanduser('~/.markitect/markitect.db')))
|
|
|
|
if not db_path.exists():
|
|
if format == 'json':
|
|
click.echo('{"error": "Database not found", "path": "' + str(db_path) + '"}')
|
|
elif format == 'yaml':
|
|
click.echo(f'error: Database not found\npath: {db_path}')
|
|
else:
|
|
click.echo(f"Database file not found: {db_path}")
|
|
return
|
|
|
|
# Basic file information (no database connection needed)
|
|
file_size = db_path.stat().st_size
|
|
|
|
stats = {
|
|
'database_path': str(db_path),
|
|
'exists': True,
|
|
'size_bytes': file_size,
|
|
'size_human': format_file_size(file_size),
|
|
'status': 'accessible' if db_path.is_file() else 'inaccessible'
|
|
}
|
|
|
|
# Format and display statistics
|
|
formatted_output = format_output(stats, format)
|
|
click.echo(formatted_output)
|
|
|
|
if config.get('verbose'):
|
|
click.echo(f"Database status retrieved successfully", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error getting database status: {e}", err=True)
|
|
if config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@cli.command('db-data')
|
|
@click.argument('file_path', type=str)
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']),
|
|
default=lambda: get_default_format(['table', 'json', 'yaml', 'simple']), help='Output format')
|
|
@pass_config
|
|
def db_data(config, file_path, format):
|
|
"""
|
|
Display complete file data including metadata, frontmatter, and content.
|
|
|
|
Show comprehensive information about a specific file including its
|
|
front matter, database metadata, and processing information.
|
|
This is the new name for what was previously called 'metadata'.
|
|
|
|
FILE_PATH: Name of the file to display data for
|
|
|
|
Examples:
|
|
markitect db-data README.md
|
|
markitect db-data docs/guide.md --format json
|
|
markitect db-data config.md --format yaml
|
|
"""
|
|
try:
|
|
if config['verbose']:
|
|
click.echo(f"Retrieving complete data for: {file_path}", err=True)
|
|
|
|
db_manager = config['db_manager']
|
|
|
|
# Get file information from database
|
|
file_info = db_manager.get_markdown_file(file_path)
|
|
|
|
if not file_info:
|
|
click.echo(f"File not found in database: {file_path}", err=True)
|
|
click.echo("Use 'markitect ingest' to process the file first.", err=True)
|
|
sys.exit(1)
|
|
|
|
# Parse front matter for better display
|
|
if file_info.get('front_matter'):
|
|
try:
|
|
if isinstance(file_info['front_matter'], str):
|
|
file_info['front_matter'] = eval(file_info['front_matter'])
|
|
except (ValueError, TypeError, SyntaxError):
|
|
if config['verbose']:
|
|
click.echo("Warning: Could not parse front matter", err=True)
|
|
|
|
# Format and display complete data
|
|
formatted_output = format_output(file_info, format)
|
|
click.echo(formatted_output)
|
|
|
|
if config['verbose']:
|
|
content_length = len(file_info.get('content', ''))
|
|
click.echo(f"Content length: {content_length} characters", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error retrieving file data: {e}", err=True)
|
|
if config['verbose']:
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
def format_file_size(size_bytes):
|
|
"""Format file size in human-readable format."""
|
|
if size_bytes < 1024:
|
|
return f"{size_bytes} B"
|
|
elif size_bytes < 1024 * 1024:
|
|
return f"{size_bytes / 1024:.1f} KB"
|
|
elif size_bytes < 1024 * 1024 * 1024:
|
|
return f"{size_bytes / (1024 * 1024):.1f} MB"
|
|
else:
|
|
return f"{size_bytes / (1024 * 1024 * 1024):.1f} GB"
|
|
|
|
|
|
# Legacy Agent Management Commands
|
|
# =================================
|
|
# Comprehensive CLI interface for managing legacy interface lifecycle
|
|
|
|
@cli.group('legacy')
|
|
def legacy_management():
|
|
"""
|
|
Manage legacy interface compatibility and lifecycle.
|
|
|
|
Provides comprehensive tools for analyzing, managing, and cleaning up
|
|
legacy interfaces including deprecation progression, migration assistance,
|
|
and automated maintenance.
|
|
"""
|
|
if not LEGACY_SYSTEM_AVAILABLE:
|
|
click.echo("Error: Legacy management system not available", err=True)
|
|
click.echo("Install with: pip install markitect[legacy]", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@legacy_management.command('status')
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'simple']),
|
|
default='table', help='Output format')
|
|
@click.option('--include-removed', is_flag=True, help='Include removed interfaces')
|
|
@pass_config
|
|
def legacy_status(config, format, include_removed):
|
|
"""
|
|
Show status of all legacy interfaces.
|
|
|
|
Displays comprehensive information about all registered legacy interfaces
|
|
including their current status, deprecation dates, and removal schedules.
|
|
|
|
Examples:
|
|
markitect legacy status
|
|
markitect legacy status --format json
|
|
markitect legacy status --include-removed
|
|
"""
|
|
try:
|
|
registry = LegacyRegistry()
|
|
|
|
# Get all legacy interfaces
|
|
interfaces = []
|
|
for command in registry._interfaces:
|
|
for version, interface in registry._interfaces[command].items():
|
|
if not include_removed and interface.status == LegacyStatus.REMOVED:
|
|
continue
|
|
|
|
interfaces.append({
|
|
'command': interface.command,
|
|
'version': interface.version,
|
|
'status': interface.status.value,
|
|
'deprecated_date': interface.deprecated_date,
|
|
'removal_date': interface.removal_date,
|
|
'git_commit': interface.git_commit[:8] if interface.git_commit else 'N/A',
|
|
'description': interface.description or 'No description'
|
|
})
|
|
|
|
if format == 'json':
|
|
click.echo(json.dumps(interfaces, indent=2))
|
|
elif format == 'yaml':
|
|
import yaml
|
|
click.echo(yaml.dump(interfaces, default_flow_style=False))
|
|
elif format == 'simple':
|
|
for interface in interfaces:
|
|
status_icon = {
|
|
'current': '✅',
|
|
'deprecated': '⚠️',
|
|
'legacy': '🔄',
|
|
'sunset': '🌅',
|
|
'removed': '❌'
|
|
}.get(interface['status'], '❓')
|
|
click.echo(f"{status_icon} {interface['command']} {interface['version']} ({interface['status']})")
|
|
else:
|
|
# Table format
|
|
if interfaces:
|
|
headers = ['Command', 'Version', 'Status', 'Deprecated', 'Removal', 'Commit', 'Description']
|
|
rows = [[
|
|
i['command'], i['version'], i['status'],
|
|
i['deprecated_date'][:10] if i['deprecated_date'] else 'N/A',
|
|
i['removal_date'][:10] if i['removal_date'] else 'N/A',
|
|
i['git_commit'],
|
|
i['description'][:30] + '...' if len(i['description']) > 30 else i['description']
|
|
] for i in interfaces]
|
|
click.echo(tabulate(rows, headers=headers, tablefmt='grid'))
|
|
else:
|
|
click.echo("No legacy interfaces found.")
|
|
|
|
if config.get('verbose'):
|
|
total = len(interfaces)
|
|
by_status = {}
|
|
for interface in interfaces:
|
|
status = interface['status']
|
|
by_status[status] = by_status.get(status, 0) + 1
|
|
|
|
click.echo(f"\nSummary: {total} interfaces", err=True)
|
|
for status, count in by_status.items():
|
|
click.echo(f" {status}: {count}", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error getting legacy status: {e}", err=True)
|
|
if config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@legacy_management.command('analyze')
|
|
@click.argument('command', required=False)
|
|
@click.argument('version', required=False)
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml', 'detailed']),
|
|
default='detailed', help='Output format')
|
|
@pass_config
|
|
def legacy_analyze(config, command, version, format):
|
|
"""
|
|
Analyze legacy interfaces for needed actions.
|
|
|
|
Performs comprehensive analysis of legacy interfaces to identify
|
|
deprecation candidates, migration opportunities, and cleanup needs.
|
|
|
|
Examples:
|
|
markitect legacy analyze
|
|
markitect legacy analyze query
|
|
markitect legacy analyze query v1.0
|
|
"""
|
|
try:
|
|
registry = LegacyRegistry()
|
|
agent = LegacyAgent(registry=registry)
|
|
|
|
if command and version:
|
|
# Analyze specific interface
|
|
interface = registry.get_legacy_interface(command, version)
|
|
if not interface:
|
|
click.echo(f"Legacy interface {command} {version} not found", err=True)
|
|
sys.exit(1)
|
|
|
|
analysis = {
|
|
'command': interface.command,
|
|
'version': interface.version,
|
|
'current_status': interface.status.value,
|
|
'deprecated_date': interface.deprecated_date,
|
|
'removal_date': interface.removal_date,
|
|
'git_commit': interface.git_commit,
|
|
'breaking_changes': interface.breaking_changes,
|
|
'migration_guide_available': bool(interface.migration_guide),
|
|
'recommendations': []
|
|
}
|
|
|
|
# Add recommendations based on status
|
|
if interface.status == LegacyStatus.DEPRECATED:
|
|
analysis['recommendations'].append("Consider progressing to LEGACY status")
|
|
elif interface.status == LegacyStatus.LEGACY:
|
|
analysis['recommendations'].append("Monitor usage and prepare for SUNSET")
|
|
elif interface.status == LegacyStatus.SUNSET:
|
|
analysis['recommendations'].append("Schedule final removal")
|
|
|
|
if not interface.migration_guide:
|
|
analysis['recommendations'].append("Generate migration guide")
|
|
|
|
if format == 'json':
|
|
click.echo(json.dumps(analysis, indent=2))
|
|
elif format == 'yaml':
|
|
import yaml
|
|
click.echo(yaml.dump(analysis, default_flow_style=False))
|
|
else:
|
|
click.echo(f"Analysis for {command} {version}")
|
|
click.echo("=" * 40)
|
|
click.echo(f"Status: {analysis['current_status']}")
|
|
click.echo(f"Deprecated: {analysis['deprecated_date'] or 'N/A'}")
|
|
click.echo(f"Removal: {analysis['removal_date'] or 'N/A'}")
|
|
click.echo(f"Migration guide: {'Available' if analysis['migration_guide_available'] else 'Missing'}")
|
|
|
|
if analysis['breaking_changes']:
|
|
click.echo(f"\nBreaking changes ({len(analysis['breaking_changes'])}):")
|
|
for change in analysis['breaking_changes']:
|
|
click.echo(f" • {change}")
|
|
|
|
if analysis['recommendations']:
|
|
click.echo(f"\nRecommendations:")
|
|
for rec in analysis['recommendations']:
|
|
click.echo(f" • {rec}")
|
|
|
|
else:
|
|
# Analyze all interfaces
|
|
candidates = registry.get_deprecation_candidates(days_ahead=30)
|
|
usage_stats = registry.get_usage_statistics(days=30)
|
|
|
|
analysis = {
|
|
'total_interfaces': sum(len(versions) for versions in registry._interfaces.values()),
|
|
'deprecation_candidates': len(candidates),
|
|
'recent_usage': usage_stats['total_usage'],
|
|
'cleanup_opportunities': 0,
|
|
'migration_guides_needed': 0
|
|
}
|
|
|
|
# Count missing migration guides and cleanup opportunities
|
|
for command_versions in registry._interfaces.values():
|
|
for interface in command_versions.values():
|
|
if not interface.migration_guide and interface.status in [LegacyStatus.LEGACY, LegacyStatus.SUNSET]:
|
|
analysis['migration_guides_needed'] += 1
|
|
if interface.status == LegacyStatus.SUNSET:
|
|
analysis['cleanup_opportunities'] += 1
|
|
|
|
if format == 'json':
|
|
click.echo(json.dumps(analysis, indent=2))
|
|
elif format == 'yaml':
|
|
import yaml
|
|
click.echo(yaml.dump(analysis, default_flow_style=False))
|
|
else:
|
|
click.echo("Legacy Interface Analysis")
|
|
click.echo("=" * 30)
|
|
click.echo(f"Total interfaces: {analysis['total_interfaces']}")
|
|
click.echo(f"Deprecation candidates: {analysis['deprecation_candidates']}")
|
|
click.echo(f"Recent usage events: {analysis['recent_usage']}")
|
|
click.echo(f"Migration guides needed: {analysis['migration_guides_needed']}")
|
|
click.echo(f"Cleanup opportunities: {analysis['cleanup_opportunities']}")
|
|
|
|
if candidates:
|
|
click.echo(f"\nUpcoming removals:")
|
|
for candidate in candidates[:5]: # Show first 5
|
|
click.echo(f" • {candidate.command} {candidate.version} (removal: {candidate.removal_date})")
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error analyzing legacy interfaces: {e}", err=True)
|
|
if config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@legacy_management.command('migrate')
|
|
@click.argument('command')
|
|
@click.argument('version')
|
|
@click.option('--to-version', default='current', help='Target version for migration')
|
|
@pass_config
|
|
def legacy_migrate(config, command, version, to_version):
|
|
"""
|
|
Get migration guidance for a legacy version.
|
|
|
|
Provides detailed migration instructions and breaking change information
|
|
for upgrading from a legacy interface version to current or another version.
|
|
|
|
Examples:
|
|
markitect legacy migrate query v1.0
|
|
markitect legacy migrate query v1.0 --to-version v2.0
|
|
"""
|
|
try:
|
|
registry = LegacyRegistry()
|
|
|
|
interface = registry.get_legacy_interface(command, version)
|
|
if not interface:
|
|
click.echo(f"Legacy version {command} {version} not found", err=True)
|
|
sys.exit(1)
|
|
|
|
migration = registry.get_migration_path(command, version, to_version)
|
|
|
|
click.echo(f"Migration Guide: {command} {version} → {to_version}")
|
|
click.echo("=" * 60)
|
|
|
|
if interface.migration_guide:
|
|
click.echo(interface.migration_guide)
|
|
else:
|
|
click.echo("No specific migration guide available.")
|
|
click.echo("Consider generating one with: markitect legacy generate-guide")
|
|
|
|
if migration['breaking_changes']:
|
|
click.echo("\nBreaking Changes:")
|
|
for i, change in enumerate(migration['breaking_changes'], 1):
|
|
click.echo(f"{i}. {change}")
|
|
|
|
if migration['steps']:
|
|
click.echo("\nMigration Steps:")
|
|
for i, step in enumerate(migration['steps'], 1):
|
|
click.echo(f"{i}. {step}")
|
|
|
|
# Show additional context
|
|
click.echo(f"\nInterface Details:")
|
|
click.echo(f" Current status: {interface.status.value}")
|
|
if interface.deprecated_date:
|
|
click.echo(f" Deprecated: {interface.deprecated_date}")
|
|
if interface.removal_date:
|
|
click.echo(f" Removal scheduled: {interface.removal_date}")
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error getting migration guide: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@legacy_management.command('cleanup')
|
|
@click.argument('command')
|
|
@click.argument('version')
|
|
@click.option('--force', is_flag=True, help='Force cleanup without confirmation')
|
|
@click.option('--backup', is_flag=True, default=True, help='Create backup before cleanup')
|
|
@pass_config
|
|
def legacy_cleanup(config, command, version, force, backup):
|
|
"""
|
|
Clean up a specific legacy version.
|
|
|
|
Permanently removes a legacy interface from the registry and optionally
|
|
creates a backup for restoration if needed.
|
|
|
|
Examples:
|
|
markitect legacy cleanup query v1.0
|
|
markitect legacy cleanup query v1.0 --force
|
|
markitect legacy cleanup query v1.0 --no-backup
|
|
"""
|
|
try:
|
|
agent = LegacyAgent()
|
|
|
|
if not force:
|
|
interface = agent.registry.get_legacy_interface(command, version)
|
|
if interface:
|
|
click.echo(f"About to clean up {command} {version}")
|
|
click.echo(f"Status: {interface.status.value}")
|
|
if interface.removal_date:
|
|
click.echo(f"Scheduled removal: {interface.removal_date}")
|
|
|
|
if interface.status not in [LegacyStatus.SUNSET, LegacyStatus.REMOVED]:
|
|
click.echo("Warning: Interface is not in SUNSET status")
|
|
|
|
if not click.confirm("Are you sure you want to proceed?"):
|
|
click.echo("Cleanup cancelled.")
|
|
return
|
|
|
|
# Configure backup behavior
|
|
original_backup_config = agent.config.backup_before_cleanup
|
|
agent.config.backup_before_cleanup = backup
|
|
|
|
success = agent.force_cleanup(command, version)
|
|
|
|
# Restore original config
|
|
agent.config.backup_before_cleanup = original_backup_config
|
|
|
|
if success:
|
|
click.echo(f"✅ Successfully cleaned up {command} {version}")
|
|
if backup:
|
|
click.echo("📦 Backup created in agent data directory")
|
|
else:
|
|
click.echo(f"❌ Failed to clean up {command} {version}", err=True)
|
|
sys.exit(1)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error during cleanup: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@legacy_management.command('agent-run')
|
|
@click.option('--dry-run', is_flag=True, help='Show what would be done without executing')
|
|
@pass_config
|
|
def legacy_agent_run(config, dry_run):
|
|
"""
|
|
Run legacy agent maintenance cycle.
|
|
|
|
Executes automated maintenance including deprecation progression,
|
|
cleanup scheduling, migration guide generation, and user notifications.
|
|
|
|
Examples:
|
|
markitect legacy agent-run
|
|
markitect legacy agent-run --dry-run
|
|
"""
|
|
try:
|
|
agent = LegacyAgent()
|
|
|
|
if dry_run:
|
|
click.echo("DRY RUN: Legacy agent maintenance preview")
|
|
click.echo("=" * 50)
|
|
|
|
# Show what would be done
|
|
agent_config = AgentConfig(
|
|
auto_progression=False, # Disable actual changes
|
|
cleanup_unused_days=agent.config.cleanup_unused_days,
|
|
migration_guide_auto_generation=False,
|
|
notification_threshold_days=agent.config.notification_threshold_days,
|
|
max_concurrent_migrations=agent.config.max_concurrent_migrations,
|
|
backup_before_cleanup=agent.config.backup_before_cleanup
|
|
)
|
|
|
|
# Create a preview agent
|
|
preview_agent = LegacyAgent(config=agent_config)
|
|
|
|
# Analyze what would be done
|
|
preview_agent._analyze_legacy_interfaces()
|
|
pending_tasks = [task for task in preview_agent._tasks if not task.completed]
|
|
|
|
if pending_tasks:
|
|
click.echo(f"Would schedule {len(pending_tasks)} tasks:")
|
|
for task in pending_tasks:
|
|
click.echo(f" • {task.action.value}: {task.command}:{task.version}")
|
|
else:
|
|
click.echo("No maintenance tasks needed")
|
|
|
|
else:
|
|
click.echo("Running legacy agent maintenance...")
|
|
|
|
summary = agent.run_maintenance()
|
|
|
|
click.echo("Maintenance Summary")
|
|
click.echo("=" * 20)
|
|
click.echo(f"Tasks executed: {summary['tasks_executed']}")
|
|
click.echo(f"Progressions: {summary['progressions']}")
|
|
click.echo(f"Cleanups: {summary['cleanups']}")
|
|
click.echo(f"Notifications: {summary['notifications']}")
|
|
|
|
if summary['errors']:
|
|
click.echo(f"\nErrors ({len(summary['errors'])}):")
|
|
for error in summary['errors']:
|
|
click.echo(f" • {error}")
|
|
|
|
click.echo(f"\nStarted: {summary['started_at']}")
|
|
click.echo(f"Completed: {summary['completed_at']}")
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error running agent maintenance: {e}", err=True)
|
|
if config.get('verbose'):
|
|
import traceback
|
|
click.echo(traceback.format_exc(), err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@legacy_management.command('agent-status')
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml']),
|
|
default='table', help='Output format')
|
|
@pass_config
|
|
def legacy_agent_status(config, format):
|
|
"""
|
|
Show legacy agent status and statistics.
|
|
|
|
Displays comprehensive information about the legacy agent including
|
|
task queue status, configuration, and registry statistics.
|
|
|
|
Examples:
|
|
markitect legacy agent-status
|
|
markitect legacy agent-status --format json
|
|
"""
|
|
try:
|
|
agent = LegacyAgent()
|
|
status = agent.get_agent_status()
|
|
|
|
if format == 'json':
|
|
click.echo(json.dumps(status, indent=2))
|
|
elif format == 'yaml':
|
|
import yaml
|
|
click.echo(yaml.dump(status, default_flow_style=False))
|
|
else:
|
|
click.echo("Legacy Agent Status")
|
|
click.echo("=" * 30)
|
|
click.echo(f"Data Directory: {status['data_directory']}")
|
|
click.echo(f"Auto Progression: {'Enabled' if status['config']['auto_progression'] else 'Disabled'}")
|
|
click.echo(f"Cleanup After: {status['config']['cleanup_unused_days']} days")
|
|
|
|
click.echo(f"\nTask Queue:")
|
|
click.echo(f" Total: {status['tasks']['total']}")
|
|
click.echo(f" Pending: {status['tasks']['pending']}")
|
|
click.echo(f" Completed: {status['tasks']['completed']}")
|
|
|
|
if status['next_maintenance']:
|
|
click.echo(f"\nNext Maintenance: {status['next_maintenance']}")
|
|
|
|
click.echo(f"\nRegistry Statistics:")
|
|
for stat_name, stat_value in status['registry_stats'].items():
|
|
if stat_name == 'commands':
|
|
click.echo(f" Commands: {', '.join(stat_value) if stat_value else 'none'}")
|
|
else:
|
|
click.echo(f" {stat_name}: {stat_value}")
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error getting agent status: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@legacy_management.command('usage-stats')
|
|
@click.option('--command', help='Filter by specific command')
|
|
@click.option('--days', type=int, default=30, help='Number of days to analyze')
|
|
@click.option('--format', '-f', type=click.Choice(['table', 'json', 'yaml']),
|
|
default='table', help='Output format')
|
|
@pass_config
|
|
def legacy_usage_stats(config, command, days, format):
|
|
"""
|
|
Show usage statistics for legacy interfaces.
|
|
|
|
Displays usage patterns to help make informed decisions about
|
|
deprecation timelines and cleanup priorities.
|
|
|
|
Examples:
|
|
markitect legacy usage-stats
|
|
markitect legacy usage-stats --command query
|
|
markitect legacy usage-stats --days 90 --format json
|
|
"""
|
|
try:
|
|
registry = LegacyRegistry()
|
|
stats = registry.get_usage_statistics(command=command, days=days)
|
|
|
|
if format == 'json':
|
|
click.echo(json.dumps(stats, indent=2))
|
|
elif format == 'yaml':
|
|
import yaml
|
|
click.echo(yaml.dump(stats, default_flow_style=False))
|
|
else:
|
|
click.echo(f"Legacy Interface Usage ({days} days)")
|
|
click.echo("=" * 40)
|
|
click.echo(f"Total usage events: {stats['total_usage']}")
|
|
|
|
if stats['by_command']:
|
|
click.echo(f"\nBy Command:")
|
|
for cmd, versions in stats['by_command'].items():
|
|
total_cmd_usage = sum(v['usage_count'] for v in versions.values())
|
|
click.echo(f" {cmd}: {total_cmd_usage} uses")
|
|
for version, data in versions.items():
|
|
click.echo(f" {version}: {data['usage_count']} (last: {data['last_used'][:10]})")
|
|
|
|
if stats['by_version']:
|
|
click.echo(f"\nMost Used Versions:")
|
|
sorted_versions = sorted(stats['by_version'].items(),
|
|
key=lambda x: x[1], reverse=True)
|
|
for version_key, count in sorted_versions[:10]:
|
|
click.echo(f" {version_key}: {count} uses")
|
|
|
|
if config.get('verbose'):
|
|
click.echo(f"\nAnalysis period: {days} days", err=True)
|
|
if command:
|
|
click.echo(f"Filtered to command: {command}", err=True)
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error getting usage statistics: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
@legacy_management.command('generate-guide')
|
|
@click.argument('command')
|
|
@click.argument('version')
|
|
@click.option('--output', '-o', type=click.Path(), help='Output file (default: stdout)')
|
|
@pass_config
|
|
def legacy_generate_guide(config, command, version, output):
|
|
"""
|
|
Generate migration guide for a legacy interface.
|
|
|
|
Creates detailed migration documentation for upgrading from
|
|
a legacy interface version to the current implementation.
|
|
|
|
Examples:
|
|
markitect legacy generate-guide query v1.0
|
|
markitect legacy generate-guide query v1.0 --output migration_guide.md
|
|
"""
|
|
try:
|
|
registry = LegacyRegistry()
|
|
interface = registry.get_legacy_interface(command, version)
|
|
|
|
if not interface:
|
|
click.echo(f"Legacy interface {command} {version} not found", err=True)
|
|
sys.exit(1)
|
|
|
|
# Generate guide content
|
|
guide_content = f"""# Migration Guide: {command} {version} → Current
|
|
|
|
## Overview
|
|
This guide helps you migrate from the legacy `{command}` {version} interface to the current implementation.
|
|
|
|
**Status**: {interface.status.value}
|
|
**Deprecated**: {interface.deprecated_date or 'Not specified'}
|
|
**Removal Date**: {interface.removal_date or 'Not scheduled'}
|
|
|
|
## Breaking Changes
|
|
"""
|
|
|
|
if interface.breaking_changes:
|
|
for i, change in enumerate(interface.breaking_changes, 1):
|
|
guide_content += f"{i}. {change}\n"
|
|
else:
|
|
guide_content += "No specific breaking changes documented.\n"
|
|
|
|
guide_content += f"""
|
|
## Migration Steps
|
|
|
|
1. **Remove the legacy flag**: Stop using `--legacy-{version.replace('.', '-')}`
|
|
2. **Update command syntax**: Review the current command documentation
|
|
3. **Test thoroughly**: Verify that your use cases work with the new interface
|
|
4. **Update automation**: Modify any scripts or tools that use the legacy interface
|
|
|
|
## Getting Help
|
|
|
|
- Run: `markitect help {command}`
|
|
- Check the documentation for current syntax
|
|
- Review the changelog for detailed changes
|
|
|
|
## Example Migration
|
|
|
|
```bash
|
|
# Old (legacy {version})
|
|
markitect {command} --legacy-{version.replace('.', '-')} [arguments]
|
|
|
|
# New (current)
|
|
markitect {command} [arguments]
|
|
```
|
|
|
|
For specific parameter changes, refer to the breaking changes section above.
|
|
"""
|
|
|
|
if interface.migration_guide:
|
|
guide_content += f"\n## Additional Notes\n\n{interface.migration_guide}\n"
|
|
|
|
# Output
|
|
if output:
|
|
with open(output, 'w', encoding='utf-8') as f:
|
|
f.write(guide_content)
|
|
click.echo(f"✅ Migration guide written to: {output}")
|
|
else:
|
|
click.echo(guide_content)
|
|
|
|
# Update interface with generated guide if it didn't have one
|
|
if not interface.migration_guide:
|
|
interface.migration_guide = guide_content
|
|
# Note: In a full implementation, this would save back to registry
|
|
|
|
except Exception as e:
|
|
click.echo(f"Error generating migration guide: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
def main():
|
|
"""
|
|
Main entry point for the CLI.
|
|
|
|
This function is referenced in pyproject.toml console_scripts.
|
|
"""
|
|
try:
|
|
cli()
|
|
except KeyboardInterrupt:
|
|
click.echo("\nOperation interrupted by user.", err=True)
|
|
sys.exit(130) # Standard exit code for SIGINT
|
|
except Exception as e:
|
|
click.echo(f"Unexpected error: {e}", err=True)
|
|
sys.exit(1)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main() |