Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.0.2 - Unreleased]

Added

• Add Zork example script!
• Add github link to META.yml

Changed

• Change example.pl to be more representative of how to use module.

Fixed

• Clarify help menu by removing = from help output.
• Clean up warn read write message. Had leftovers in it, oops...
• Fix help dispatch using regex match instead of string equality, which caused any input containing the substring "help" to incorrectly trigger the help menu.
• Trim leading/trailing whitespace from input after chomp so commands with incidental surrounding spaces are handled correctly throughout the run loop.
• Fix shell passthrough stripping all ! characters from the command token instead of only the leading one, which corrupted commands containing ! in their arguments.
• Fix history file being opened in append mode on save, causing entries to accumulate across sessions; now overwrites with the full current history on exit.
• Fix args validation accepting any reference type instead of requiring an ARRAY ref, meaning a mistyped hashref or coderef passed as args would silently pass validation.

[0.0.1] - 2026-03-13

Added

• Initial release of Term::ReadLine::Repl.
• Basic REPL loop with prompt, welcome message, and help/quit built-in commands.
• Tab auto-completion for command names and their defined arguments.
• Argument validation in validate_args() with descriptive croak messages for missing or malformed constructor args.
• get_opts support for integrating a Getopt::Long parsing function into the loop.
• custom_logic hook allowing callers to inject mid-loop logic, control flow (next/last), and dynamic cmd_schema changes.
• passthrough option to forward !command input directly to the system shell.
• Persistent command history via hist_file.
• Build.PL for distribution build and dependency management.
• META.yml and MANIFEST for CPAN packaging.
• Full POD documentation including constructor args, methods, built-in commands, and tab completion behavior.
• Test suite covering validate_args croak paths, construction sanity checks, and _tab_complete behavior.