Skip to content

Commit

Permalink
Merge pull request #1006 from cakephp/plugins-config
Browse files Browse the repository at this point in the history
Update notes for plugins config array.
  • Loading branch information
dereuromark authored Jun 27, 2024
2 parents 501ae31 + eb27132 commit 9a7f511
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions config/plugins.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
];

0 comments on commit 9a7f511

Please sign in to comment.