explorer

CLI tool for API exploration of cjm-fasthtml-tailwind utilities

Parser Setup Functions

Helper functions to set up argument parsers for each command:

add_modules_parser


def add_modules_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'modules' command to
)->ArgumentParser: # Argument parser for the 'modules' command

Add the ‘modules’ command parser.

add_factories_parser


def add_factories_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'factories' command to
    config:Optional=None, # Optional configuration to use
)->ArgumentParser: # Argument parser for the 'factories' command

Add the ‘factories’ command parser.

add_factory_parser


def add_factory_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'factory' command to
)->ArgumentParser: # Argument parser for the 'factory' command

Add the ‘factory’ command parser.

add_examples_parser


def add_examples_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'examples' command to
)->ArgumentParser: # Argument parser for the 'examples' command

Add the ‘examples’ command parser.

add_example_parser


def add_example_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'example' command to
)->ArgumentParser: # Argument parser for the 'example' command

Add the ‘example’ command parser.

add_helpers_parser


def add_helpers_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'helpers' command to
)->ArgumentParser: # Argument parser for the 'helpers' command

Add the ‘helpers’ command parser.

add_helper_parser


def add_helper_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'helper' command to
)->ArgumentParser: # Argument parser for the 'helper' command

Add the ‘helper’ command parser.

add_search_parser


def add_search_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'search' command to
)->ArgumentParser: # Argument parser for the 'search' command

Add the ‘search’ command parser.

add_test_code_parser


def add_test_code_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'test-code' command to
    config:Optional=None, # Optional configuration to use
)->ArgumentParser: # Argument parser for the 'test-code' command

Add the ‘test-code’ command parser.

add_core_utils_parser


def add_core_utils_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'core-utils' command to
)->ArgumentParser: # Argument parser for the 'core-utils' command

Add the ‘core-utils’ command parser.

add_core_util_parser


def add_core_util_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'core-util' command to
)->ArgumentParser: # Argument parser for the 'core-util' command

Add the ‘core-util’ command parser.

add_imports_parser


def add_imports_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'imports' command to
    config:Optional=None, # Optional configuration to use
)->ArgumentParser: # Argument parser for the 'imports' command

Add the ‘imports’ command parser.

Command Dispatcher

Function to handle command execution:

add_scan_parser


def add_scan_parser(
    subparsers:_SubParsersAction, # Subparsers object to add the 'scan' command to
    config:Optional=None, # Optional configuration to use
)->ArgumentParser: # Argument parser for the 'scan' command

Add the ‘scan’ command parser.

dispatch_command


def dispatch_command(
    args:Namespace, # Parsed command-line arguments
):

Dispatch the parsed arguments to the appropriate handler.

handle_search_command


def handle_search_command(
    args:Namespace, # Parsed command-line arguments for the search command
):

Handle the search command.

handle_test_code_command


def handle_test_code_command(
    args:Namespace, # Parsed command-line arguments for the test-code command
    config:Optional=None, # Optional configuration to use
):

Handle the test-code command.

Main Parser Setup

Function to set up the main argument parser:

handle_scan_command


def handle_scan_command(
    args:Namespace, # Parsed command-line arguments for the scan command
):

Handle the scan command.

create_help_description


def create_help_description(
    config:Optional=None, # Optional configuration to use
)->str: # Comprehensive description string for the CLI tool's help message

Create a comprehensive description for the CLI tool’s help message

create_example_usage_flow


def create_example_usage_flow(
    config:Optional=None, # Optional configuration to use
)->str: # Formatted example usage flow string with aligned comments

Create an example usage flow

create_help_epilogue


def create_help_epilogue(
    config:Optional=None, # Optional configuration to use
)->str: # Comprehensive epilogue string for the CLI tool's help message

Create a comprehensive epilogue for the CLI tool’s help message

setup_argument_parser


def setup_argument_parser(
    config:Optional=None, # Optional configuration to use
)->ArgumentParser: # Configured argument parser with all subcommands

Set up the main argument parser with all subcommands.

CLI Entry Point

Main function for the console script:

main


def main(
    
)->None: # Executes the CLI with parsed arguments

CLI entry point for exploring cjm-fasthtml-tailwind utilities.

Export