feat: add retry/language plugins, update menu logic and documentation

Author: BlorisL

README.md

@@ -35,33 +35,37 @@ The library provides two main methods for output:
 
 - `print()`: Initializes and displays the menu interface
 - `write(message: string, color?: ColorName)`: Prints custom messages with optional styling
-  ```typescript
-  write('Success!', 'green');
-  write('Error!', 'red');
-  ```
+
+```typescript
+write('Success!', 'green');
+write('Error!', 'red');
+```
 
 ## Creating and Registering Plugins
 
 To create a new plugin, define an object implementing the `PluginType` interface:
 
 ```typescript
-import { print, addPlugin } from 'modular-cli-menu';
+import { addPlugin, print } from 'modular-cli-menu';
 
 addPlugin({
     menu: {
         name: 'test',
-        parent: "main",
+        parent: 'main',
         choices: [
             'menu.test.action1',
             'menu.action.back'
         ]
-    }, 
+    },
     actions: {
         'menu.test.action1': {
             type: 'function',
             name: 'menu.test.action1',
             options: {
-                message: { text: 'menu.test.action1.message'}
+                message: { text: 'menu.test.action1.message', color: 'green' },
+                callback: async () => {
+                    // Your logic here
+                }
             }
         }
     },
@@ -77,18 +81,18 @@ addPlugin({
             'menu.test.action1.message': 'Qualcosa',
         }
     }
-})
+});
 
 print();
 ```
 
-In the main file remember to register the plugin
+In your main file, remember to register the plugin:
+
 ```typescript
-import module1 from './plugins/myPlugin/index.ts';
+import myPlugin from './plugins/myPlugin';
 import { addPlugin, print } from 'modular-cli-menu';
 
 addPlugin(myPlugin);
-
 print();
 ```
 
@@ -98,11 +102,10 @@ The library provides several methods for menu navigation and control:
 
 ### actionExit
 
-`menu.action.exit` can be used to terminate the application. 
-Add it to your menu's choices:
+`menu.action.exit` can be used to terminate the application. Add it to your menu's choices:
 
 ```typescript
-import { actionExit } from 'modular-cli-menu';
+import { actionExit, PluginType } from 'modular-cli-menu';
 
 const myPlugin: PluginType = {
     menu: {
@@ -118,11 +121,10 @@ const myPlugin: PluginType = {
 
 ### actionGoBack
 
-`menu.action.back` can be used to navigate to the previous menu. 
-Add it to your menu's choices:
+`menu.action.back` can be used to navigate to the previous menu. Add it to your menu's choices:
 
 ```typescript
-import { actionGoBack } from 'modular-cli-menu';
+import { actionGoBack, PluginType } from 'modular-cli-menu';
 
 const myPlugin: PluginType = {
     menu: {
@@ -141,16 +143,17 @@ const myPlugin: PluginType = {
 Use `waitForKeyPress()` to pause execution until the user presses a key:
 
 ```typescript
-import { waitForKeyPress } from 'modular-cli-menu';
+import { waitForKeyPress, PluginType } from 'modular-cli-menu';
 
-const myAction: ActionType = {
+const myAction: PluginType = {
     type: 'function',
+    name: 'myAction',
     options: {
-        callback: async (parent?:) => {
+        callback: async (parent) => {
             await waitForKeyPress();
             // Continue with the next actions
-        }
-    }
+        },
+    },
 };
 ```
 
@@ -208,6 +211,10 @@ The library supports different types of actions:
     type: 'checkbox',
     name: 'checkboxAction',
     options: {
+        message: {
+            text: 'Select options:',
+            color: 'cyan',
+        },
         choices: ['Option 1', 'Option 2', 'Option 3'],
         callback: async (selected) => {
             console.log('Selected options:', selected);
@@ -222,12 +229,61 @@ The library supports different types of actions:
 {
     type: 'goto',
     name: 'gotoAction',
+    color: 'blue',
     options: {
-        menu: 'targetMenuName'
-    }
+        callback: async (to) => {
+            // Custom logic before navigating
+        },
+    },
 }
 ```
 
+## Built-in Plugins: Retry and Language
+
+The library includes some built-in plugins, such as `retry` and `language`, to enhance user experience and internationalization out of the box.
+
+### Retry Plugin
+
+The `retry` plugin provides a menu for handling invalid input or failed actions, allowing users to easily retry an operation.
+
+Example structure:
+
+```typescript
+addActionToMenu({
+    type: 'input',
+    name: 'menu.foo.action',
+    options: {
+        message: { text: 'menu.foo.action.message'},
+        callback: async (value: string) => {
+            if (value.length > 0 && fs.existsSync(value)) {
+                options.foo = value;
+                await waitForKeyPress({ message: 'menu.foo.action.callback.success', color: 'green' });
+                await print('main');
+            } else {
+                await print('retry', {
+                    action: 'menu.foo.action', 
+                    message: 'menu.foo.action.callback.error', 
+                    color: 'red' 
+                });
+            }
+        }
+    }
+});
+```
+
+You can use this plugin to prompt the user to retry an action after an error or invalid input.
+
+### Language Plugin
+
+The `language` plugin allows users to switch the interface language at runtime. It updates the `MENU_LANGUAGE` environment variable and reloads translations.
+```
+
+These plugins are registered automatically, but you can customize or extend them as needed.
+
+## Internationalization (i18n)
+
+You can provide translations for your plugin by adding a `languages` property to your plugin object. The library will automatically merge these translations and use the correct language based on the current environment.
+
 ## Support me
 
 [Share with me a cup of tea](https://www.buymeacoffee.com/bloris) ☕

src/languages/en.json

@@ -7,10 +7,5 @@
     "menu.action.back.label": "Back",
     "menu.action.exit.label": "Exit",
     "menu.action.exit.message": "Exiting the application",
-    "menu.main.action.waiting.label": "Press any key to continue...",
-    "menu.language.question": "Change language",
-    "menu.language.action.it.message": "Lingua italiana selezionata con successo",
-    "menu.language.action.en.message": "English language selected successfully",
-    "menu.language.action.it.label": "Italian",
-    "menu.language.action.en.label": "English"
+    "menu.main.action.waiting.label": "Press any key to continue..."
 }

src/languages/it.json

@@ -7,10 +7,5 @@
     "menu.action.back.label": "Torna indietro",
     "menu.action.exit.label": "Esci",
     "menu.action.exit.message": "Uscita dall'applicazione",
-    "menu.main.action.waiting.label": "Premi un tasto per continuare...",
-    "menu.language.question": "Cambio lingua",
-    "menu.language.action.it.message": "Lingua italiana selezionata con successo",
-    "menu.language.action.en.message": "English language selected successfully",
-    "menu.language.action.it.label": "Italiano",
-    "menu.language.action.en.label": "Inglese"
+    "menu.main.action.waiting.label": "Premi un tasto per continuare..."
 }