a11yanalyze
Version:
A command-line tool for developers and QA engineers to test web pages and websites for WCAG 2.2 AA accessibility compliance
80 lines • 1.92 kB
TypeScript
/**
* Comprehensive Help System
* Provides detailed guidance, examples, use cases, and interactive help
* for the accessibility analysis tool
*/
/**
* Help topic categories
*/
export type HelpCategory = 'getting-started' | 'scanning' | 'crawling' | 'configuration' | 'scoring' | 'reporting' | 'troubleshooting' | 'best-practices' | 'examples' | 'api';
/**
* Help content structure
*/
export interface HelpContent {
title: string;
description: string;
sections: HelpSection[];
examples?: Example[];
seeAlso?: string[];
}
/**
* Help section structure
*/
export interface HelpSection {
title: string;
content: string;
codeBlocks?: CodeBlock[];
tips?: string[];
warnings?: string[];
}
/**
* Code example structure
*/
export interface CodeBlock {
title: string;
language: 'bash' | 'json' | 'javascript' | 'yaml';
code: string;
description?: string;
}
/**
* Usage example structure
*/
export interface Example {
title: string;
description: string;
command: string;
explanation: string;
expectedOutput?: string;
}
/**
* Comprehensive Help Manager
*/
export declare class HelpManager {
private static readonly HELP_CONTENT;
/**
* Display comprehensive help for a specific topic
*/
static showHelp(category: HelpCategory): void;
/**
* Display help topic menu
*/
static showTopicMenu(): void;
/**
* Show quick tips based on command context
*/
static showQuickTips(command?: string): void;
/**
* Generate configuration file with comments
*/
static generateConfigTemplate(format?: 'json' | 'js'): string;
/**
* Format code blocks with syntax highlighting
* @private
*/
private static formatCodeBlock;
/**
* Search help content for keywords
*/
static searchHelp(query: string): void;
}
//# sourceMappingURL=help-manager.d.ts.map