The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
StandupGenerator-0.1
River stage zero No dependents
/ StandupGenerator::Manipulator

NAME

StandupGenerator::Manipulator - allows user to easily save shortcuts for this package in their configurations

DESCRIPTION

The Manipulator module contains an auxillary method to make it easy for the user to set up short aliases for the main methods from this package.

METHODS

save_script_shortcuts

This method lets the user easily execute commands from this package via the CLI by editing their configuration file to contain certain shortcuts to key methods.

Parameters

$path

A string containing the full file path for the directory to store standup files. It should begin with /Users/. It should only ever contain .txt files in the standup format.

Examples

    perl -Ilib -e 'require "./lib/StandupGenerator.pm"; StandupGenerator::Manipulator::save_script_shortcuts("/Users/johndoe/projects/super-important-project/standups")'

Executing the above command in the CLI will add osu, csu, and wsu shortcuts to the user's configurations. As a result, executing any of those will interact with standup files stored in the standups folder within the larger super-important_project folder.

    perl -Ilib -e 'require "./lib/StandupGenerator.pm"; StandupGenerator::Manipulator::save_script_shortcuts("/Users/johndoe/work/getting-apples")'

Executing the above command in the CLI will add osu, csu, and wsu shortcuts to the user's configurations. As a result, executing any of those will interact with standup files stored in the getting-apples folder, which presumably will not contain any files other than the standup files (otherwise, there could be issues down the road).