Documentation Generator CLI Tool

Build a command-line interface tool that processes JavaScript source files and generates documentation output based on different command modes.

Capabilities

CLI Command Processing

The tool should accept command-line arguments and process them to determine the operation mode and options.

• Running with --help flag displays usage information and exits @test
• Running with --version flag displays version number and exits @test
• Running with --clear flag clears cached data and displays confirmation message @test
• Running with no flags processes input files and generates documentation output @test

Configuration Management

The tool should support loading configuration from multiple sources with proper precedence.

• Configuration loaded from .jsdoc2md.json file if it exists @test
• Configuration loaded from package.json jsdoc2md property if it exists @test
• Command-line arguments override configuration file settings @test

Data Inspection Modes

The tool should support outputting structured data in JSON format for debugging and integration purposes.

• Running with --json flag outputs template data in JSON format @test
• Running with --config flag displays the merged configuration settings @test

Implementation

@generates

API

// Main CLI entry point
// Processes command-line arguments and executes appropriate command
// Usage: node cli.js [options] [files...]
//
// Options:
//   --help              Display help information
//   --version           Display version number
//   --clear             Clear cache
//   --json              Output template data as JSON
//   --config            Display merged configuration
//
// Returns: exits with code 0 on success, non-zero on error

Dependencies { .dependencies }

jsdoc-to-markdown { .dependency }

Provides documentation generation functionality including render, getTemplateData, clear cache operations, and configuration management.

@satisfied-by