JSPM

appinspect-reporter

1.1.1
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q61580F
  • License MIT

A JavaScript utility tool that transforms Splunk AppInspect CLI JSON output into interactive, filterable HTML reports

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (appinspect-reporter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    AppInspect Reporter

    npm version

    A JavaScript utility tool that transforms Splunk AppInspect CLI JSON output into interactive, filterable HTML reports for technical teams to analyze app compliance issues efficiently.

    Features

    • 🚀 CLI Tool: Generate static reports or serve them locally
    • 📊 Interactive Dashboard: Summary metrics and app information
    • 🔍 Advanced Filtering: Filter by result type, tags, and groups
    • 📱 Responsive Design: Works on desktop and mobile devices
    • 🏗️ CI/CD Ready: Jenkins HTML Publisher plugin compatible
    • ⚡ Performance: Handles large reports (25,000+ lines) efficiently

    Requirements

    • Node.js 16 or higher

    Installation

    npm install -g appinspect-reporter

    Usage

    Generate Static Report

    Create a static HTML report for CI/CD pipelines or sharing:

    # Basic usage
appinspect-reporter generate report.json

# Custom output directory and title
appinspect-reporter generate report.json --output-dir ./my-report --title "My App Report"

    Serve Report Locally

    Start a local development server for interactive viewing:

    # Basic usage
appinspect-reporter serve report.json

# Custom port and auto-open browser
appinspect-reporter serve report.json --port 8080 --open

    CLI Options

    Generate Command

    • --output-dir <directory> - Output directory (default: ./appinspect-report)
    • --title <string> - Custom report title
    • --help - Show help

    Serve Command

    • --port <number> - Port to serve on (default: 3000)
    • --host <string> - Host to serve on (default: localhost)
    • --open - Automatically open browser
    • --help - Show help

    Report Features

    Summary Dashboard

    • App information (name, version, author, description)
    • Execution time and metadata
    • Total checks count and breakdown by result type

    Filtering System

    • Result Types: Success, Failure, Warning, Not Applicable, Manual Review, Error
    • Tags: Dynamic list extracted from checks
    • Groups: Dynamic list of group names
    • Combination Logic: AND between filter types, OR within each type

    Results Display

    • Hierarchical structure (Groups → Checks → Messages)
    • Collapsible sections for detailed exploration
    • Color-coded result indicators
    • Message details with file locations and line numbers

    Development

    For detailed development instructions, see docs/development.md.

    License

    MIT License - see LICENSE file for details.