dthree/vorpal
Vorpal
Vorpal este un framework CLI interactiv pentru Node.js și o bibliotecă de interfață terminală utilizată pentru a construi shell-uri extensibile în linie de comandă. Funcționează ca un parser interactiv de linie de comandă care convertește input-ul de tip șir în funcții executabile, gestionând ciclul de viață al sesiunilor de terminal și rutarea comenzilor.
Framework-ul se distinge printr-o arhitectură de extensie bazată pe plugin-uri, care permite modulelor externe să înregistreze noi comenzi, comportamente partajate și suite complete de comenzi în mediul de bază. Suportă crearea de medii shell personalizate cu namespace-uri specializate și un sistem pentru istoricul persistent al utilizatorului și stocarea locală cheie-valoare.
Proiectul oferă utilitare cuprinzătoare pentru gestionarea comenzilor, inclusiv autocomplete, suport pentru alias-uri și sisteme de ajutor programabile. Include, de asemenea, controale I/O pentru terminal pentru modificarea dinamică a prompt-ului, interceptarea output-ului standard și solicitarea interactivă a utilizatorului. Gestionarea erorilor este tratată prin listeneri globali de excepții și declanșatoare specifice pentru input-ul utilizatorului care nu se potrivește cu nicio comandă.
Features
- CLI Plugin Architectures - Features an architectural pattern that allows third-party modules to register new commands and shared behaviors.
- Plugin-Based Architectures - Features a plugin-based architecture allowing external modules to register new commands and shared behaviors.
- Node.js CLI Libraries - Provides a comprehensive toolkit for building interactive Node.js command-line applications with namespaces and prompts.
- Command Namespacing - Groups related commands into distinct namespaces using delimiters to organize application behavior.
- Customizable - Enables the design of specialized command line environments with unique delimiters and localized data storage.
- Application Key-Value Stores - Provides a local storage API for saving and retrieving key-value pairs associated with a specific application ID.
- Custom Command Definitions - Provides an API for defining custom executable commands with descriptions, aliases, and autocomplete.
- Command Line Extensions - Acts as a framework for defining custom commands, plugins, and persistent history to create an extensible shell.
- Command Line Parsers - Functions as an interactive parser converting string input into executable functions with autocomplete and aliases.
- Interactive Shell Sessions - Maintains an active terminal prompt and user history within a persistent session object to manage interface state.
- Interactive CLI Prompts - Implements interactive prompts to collect mid-command information via confirmations and text fields.
- Interactive CLI Tools - Provides a framework for building interactive CLI tools with custom prompts, namespaces, and autocompletion.
- Asynchronous Command Execution - Implements a promise-based queue for non-blocking execution of commands within the terminal interface.
- Command Routing Architectures - Maps user input strings to executable functions using registered namespaces and delimiters.
- Command Lifecycle Hooks - Provides internal hooks and listeners that trigger at specific stages of the CLI command lifecycle.
- Interactive CLI Sessions - Manages the attachment of interactive prompts to the terminal and the configuration of input delimiters.
- Command History Persistence - Saves records of previously entered commands under unique identifiers for persistent user recall across sessions.
- Interactive CLI Frameworks - Provides a comprehensive toolkit for building interactive terminal user interfaces and command-line shells.
- Terminal User Interfaces - Offers a library for managing terminal output, redrawing prompts, and intercepting stdout to create TUIs.
- Node.js Terminal Frameworks - Offers a full framework for creating complex Node.js terminal applications with state management and command routing.
- Key-Value Persistence Stores - Stores application state and user command history in a local key-value persistence system.
- Command Suite Integrations - Allows the import of external modules to add new namespaces and suites of commands.
- Command Help Customization - Allows overriding default help text with custom functions for tailored user guidance.
- Terminal Output Managers - Intercepts and processes standard output streams before they are logged to the terminal.
- Exception-Based Error Handling - Handles exceptions thrown during command execution to prevent crashes and provide user feedback.
- CLI Command Error Interception - Intercepts failed command executions to provide fallback logic or custom error messages.
- CLI Event Systems - Implements an event system that triggers custom logic during specific actions such as command registration or keypresses.
- CLI Plugin Interfaces - Provides a standardized interface for exporting modules that add new commands and custom configurations.
- Extensible Plugin Architectures - Implements an architectural pattern for integrating third-party plugins to add shared functionality.
- Core Capability Extensions - Includes mechanisms for integrating custom plugins to extend the fundamental operational logic and shared behaviors of the environment.
- Unmatched Input Handlers - Provides a specific execution trigger for when a user enters a command that does not match any defined patterns.
- Command Output Streamers - Routes standard output to ensure correct rendering and support for piped commands within the terminal.
- Global Output Interception - Captures standard output streams and processes them through a handler before rendering to the terminal.
- Terminal Display Controllers - Provides a controller for the terminal display that manages content redrawing and the input/output loop.
- JavaScript CLI Frameworks - Framework for building rich, immersive CLI environments.
