From eb2713277485caffc52133190c49aab2f7ab815a Mon Sep 17 00:00:00 2001 From: ADmad Date: Thu, 27 Jun 2024 22:48:47 +0530 Subject: [PATCH] Update notes for plugins config array. --- config/plugins.php | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/config/plugins.php b/config/plugins.php index 72984dcdd4..6be3095e01 100644 --- a/config/plugins.php +++ b/config/plugins.php @@ -19,15 +19,18 @@ * @license https://opensource.org/licenses/mit-license.php MIT License */ + /* + * List of plugins to load in the form `PluginName` => `[configuration options]`. + * + * Available options: + * - onlyDebug: Load the plugin only in debug mode. Default false. + * - onlyCli: Load the plugin only in CLI mode. Default false. + * - optional: Do not throw an exception if the plugin is not found. Default false. + */ return [ - // Plugins only needed when in debug mode 'DebugKit' => ['onlyDebug' => true], - - // Optional plugins which are only needed in CLI commands 'Bake' => ['onlyCli' => true, 'optional' => true], - - // Required plugins only in CLI commands 'Migrations' => ['onlyCli' => true], - // Add your custom plugins here + // Additional plugins here ];