@rankture/cli 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,339 @@
+/**
+ * Check result from an SEO check
+ */
+interface CheckResult {
+    /** Unique check identifier */
+    checkId: string;
+    /** Human-readable check name */
+    name: string;
+    /** Severity level */
+    severity: 'critical' | 'warning' | 'info';
+    /** Whether the check passed */
+    passed: boolean;
+    /** File path where issue was found */
+    file?: string;
+    /** Description of the issue */
+    message: string;
+    /** Line number if applicable */
+    line?: number;
+    /** Column number if applicable */
+    column?: number;
+    /** How to fix the issue */
+    fix?: string;
+    /** Additional details (e.g., list of images missing alt) */
+    details?: string[];
+}
+/**
+ * Summary of all check results
+ */
+interface CheckSummary {
+    /** Total files checked */
+    totalFiles: number;
+    /** Total checks that passed */
+    passed: number;
+    /** Total critical issues */
+    critical: number;
+    /** Total warnings */
+    warning: number;
+    /** Total info messages */
+    info: number;
+}
+/**
+ * Full report from a check run
+ */
+interface CheckReport {
+    /** CLI version */
+    version: string;
+    /** When the check was run */
+    timestamp: string;
+    /** Path that was checked */
+    path: string;
+    /** Summary statistics */
+    summary: CheckSummary;
+    /** All check results */
+    results: CheckResult[];
+}
+/**
+ * Options for running checks
+ */
+interface CheckOptions {
+    /** Path to check (directory or file) */
+    path: string;
+    /** Output format */
+    format: 'terminal' | 'json' | 'html';
+    /** Output file path (optional) */
+    output?: string;
+    /** Fail threshold */
+    failOn: 'none' | 'critical' | 'warning' | 'any';
+    /** Glob patterns to ignore */
+    ignore: string[];
+    /** Config file path */
+    config?: string;
+    /** Watch mode */
+    watch?: boolean;
+    /** Only check git changed files (staged + unstaged) */
+    changed?: boolean;
+    /** Only check git staged files */
+    staged?: boolean;
+}
+/**
+ * Configuration file structure
+ */
+interface RanktureConfig {
+    /** Which checks to enable/disable */
+    checks?: Record<string, boolean>;
+    /** Paths to ignore */
+    ignore?: string[];
+    /** Severity overrides for specific checks */
+    rules?: Record<string, 'critical' | 'warning' | 'info'>;
+    /** Threshold settings */
+    thresholds?: {
+        titleLength?: {
+            min: number;
+            max: number;
+        };
+        descriptionLength?: {
+            min: number;
+            max: number;
+        };
+        maxImageSize?: number;
+        maxPageSize?: number;
+    };
+    /** API key for Pro features */
+    apiKey?: string;
+    /** Whether to sync results to dashboard */
+    sync?: boolean;
+}
+/**
+ * Parsed HTML page data for checks
+ */
+interface ParsedPage {
+    /** File path */
+    filePath: string;
+    /** Raw HTML content */
+    html: string;
+    /** Page title */
+    title?: string;
+    /** Meta description */
+    metaDescription?: string;
+    /** Canonical URL */
+    canonical?: string;
+    /** Viewport meta tag */
+    viewport?: string;
+    /** HTML lang attribute */
+    lang?: string;
+    /** All H1 tags */
+    h1s: string[];
+    /** All headings in order */
+    headings: {
+        level: number;
+        text: string;
+    }[];
+    /** All images */
+    images: {
+        src: string;
+        alt?: string;
+        line?: number;
+    }[];
+    /** All internal links */
+    internalLinks: {
+        href: string;
+        text: string;
+    }[];
+    /** All external links */
+    externalLinks: {
+        href: string;
+        text: string;
+    }[];
+    /** JSON-LD structured data */
+    jsonLd: object[];
+    /** Open Graph tags */
+    ogTags: Record<string, string>;
+    /** Twitter Card tags */
+    twitterTags: Record<string, string>;
+    /** Robots meta tag */
+    robots?: string;
+    /** Whether this is a source file (not built HTML) */
+    isSourceFile?: boolean;
+}
+
+/**
+ * Supported file extensions by category
+ */
+declare const SUPPORTED_EXTENSIONS: {
+    html: string[];
+    source: string[];
+};
+/**
+ * Parse an HTML file and extract SEO-relevant data
+ */
+declare function parseHtml(filePath: string, html: string): ParsedPage;
+/**
+ * Parse source files (JSX, TSX, Astro, Vue, Svelte, MD, MDX, Nunjucks, EJS, etc.)
+ * Extracts HTML-like content for SEO checking
+ */
+declare function parseSourceFile(filePath: string, content: string): ParsedPage;
+
+interface CheckRegistry {
+    id: string;
+    name: string;
+    description: string;
+    severity: 'critical' | 'warning' | 'info';
+    run: (page: ParsedPage, allPages: ParsedPage[], basePath: string) => CheckResult[];
+}
+/**
+ * All available checks
+ */
+declare const checks: CheckRegistry[];
+/**
+ * Run all enabled checks on a page
+ */
+declare function runChecks(page: ParsedPage, allPages: ParsedPage[], basePath: string, enabledChecks?: Set<string>): CheckResult[];
+/**
+ * Get list of all available check IDs
+ */
+declare function getAvailableChecks(): string[];
+
+/**
+ * Check for missing or problematic title tags
+ */
+declare function checkMetaTitle(page: ParsedPage, allPages: ParsedPage[]): CheckResult[];
+/**
+ * Check for missing or problematic meta descriptions
+ */
+declare function checkMetaDescription(page: ParsedPage, allPages: ParsedPage[]): CheckResult[];
+/**
+ * Check for missing viewport meta tag
+ * Note: Skipped for source files since viewport is typically in layouts
+ */
+declare function checkViewport(page: ParsedPage): CheckResult[];
+/**
+ * Check for missing lang attribute
+ * Note: Skipped for source files since lang is typically in layouts
+ */
+declare function checkLang(page: ParsedPage): CheckResult[];
+/**
+ * Check for canonical URL issues
+ * Note: Skipped for source files since canonical is typically set dynamically
+ */
+declare function checkCanonical(page: ParsedPage): CheckResult[];
+
+/**
+ * Check for missing or multiple H1 tags
+ */
+declare function checkH1(page: ParsedPage): CheckResult[];
+/**
+ * Check heading hierarchy (no skipped levels)
+ */
+declare function checkHeadingHierarchy(page: ParsedPage): CheckResult[];
+
+/**
+ * Check for images missing alt text
+ */
+declare function checkImageAlt(page: ParsedPage): CheckResult[];
+
+/**
+ * Check for broken internal links (links to files that don't exist)
+ */
+declare function checkInternalLinks(page: ParsedPage, allPages: ParsedPage[], basePath: string): CheckResult[];
+
+/**
+ * Check JSON-LD structured data for validity
+ */
+declare function checkSchema(page: ParsedPage): CheckResult[];
+/**
+ * Validate JSON-LD syntax by attempting to find invalid scripts
+ * This runs on the raw HTML to catch JSON parse errors
+ */
+declare function checkSchemaJsonValidity(page: ParsedPage): CheckResult[];
+
+/**
+ * Check for Open Graph meta tags
+ */
+declare function checkOpenGraph(page: ParsedPage): CheckResult[];
+/**
+ * Check for Twitter Card meta tags
+ */
+declare function checkTwitterCards(page: ParsedPage): CheckResult[];
+/**
+ * Check for robots meta issues
+ */
+declare function checkRobotsMeta(page: ParsedPage): CheckResult[];
+
+/**
+ * Check for ARIA and accessibility issues
+ */
+declare function checkAccessibility(page: ParsedPage): CheckResult[];
+/**
+ * Check color contrast (basic check - looks for common anti-patterns)
+ */
+declare function checkColorContrast(page: ParsedPage): CheckResult[];
+/**
+ * Check for focus visibility issues
+ */
+declare function checkFocusIndicators(page: ParsedPage): CheckResult[];
+
+/**
+ * Default configuration
+ */
+declare const defaultConfig: RanktureConfig;
+/**
+ * Find and load config file from directory
+ */
+declare function loadConfig(basePath: string, configPath?: string): Promise<RanktureConfig>;
+/**
+ * Get enabled checks from config
+ */
+declare function getEnabledChecks(config: RanktureConfig, allChecks: string[]): Set<string>;
+
+/**
+ * Format check results for terminal output
+ */
+declare function formatTerminal(report: CheckReport): string;
+
+/**
+ * Format check results as JSON
+ */
+declare function formatJson(report: CheckReport): string;
+
+/**
+ * Generate HTML report from check results
+ */
+declare function formatHtml(report: CheckReport): string;
+
+interface ValidateResult {
+    valid: boolean;
+    errors: string[];
+    warnings: string[];
+    info: string[];
+}
+/**
+ * Validate a robots.txt file
+ */
+declare function validateRobotsTxt(filePath: string): Promise<ValidateResult>;
+/**
+ * Validate a sitemap.xml file
+ */
+declare function validateSitemap(filePath: string): Promise<ValidateResult>;
+
+/**
+ * Page check result for programmatic API
+ */
+interface PageCheckResult {
+    url: string;
+    results: CheckResult[];
+    summary: {
+        total: number;
+        passed: number;
+        failed: number;
+        critical: number;
+        warnings: number;
+        score: number;
+    };
+}
+/**
+ * Run checks on a single HTML file/string programmatically
+ */
+declare function checkPage(html: string, url?: string, basePath?: string): PageCheckResult;
+
+export { type CheckOptions, type CheckReport, type CheckResult, type CheckSummary, type PageCheckResult, type ParsedPage, type RanktureConfig, SUPPORTED_EXTENSIONS, type ValidateResult, checkAccessibility, checkCanonical, checkColorContrast, checkFocusIndicators, checkH1, checkHeadingHierarchy, checkImageAlt, checkInternalLinks, checkLang, checkMetaDescription, checkMetaTitle, checkOpenGraph, checkPage, checkRobotsMeta, checkSchema, checkSchemaJsonValidity, checkTwitterCards, checkViewport, checks, defaultConfig, formatHtml, formatJson, formatTerminal, getAvailableChecks, getEnabledChecks, loadConfig, parseHtml, parseSourceFile, runChecks, validateRobotsTxt, validateSitemap };