plentyDevTool helps you streamline your plugin development workflow. Synchronise your local files with the ones on your plentymarkets system.
The Settings menu will also open if plentyDevTool does not recognize a local path for synchronisation.
When downloading new plugins from remote, plentyDevTool will automatically create new folders in the folder you selected for synchronisation. Folders will be created in the following pattern:
LocalSyncFolder/ ├── System_PID/ │ ├── Set_ID/ │ │ │ │ │ ├── Plugin_Name/ │ │ │ │ │ ├── Plugin_Name/ │ │ │ │ │ └── . . . │ └── . . . └── . . . plenty.ignore
Do not change this structure or the folder names. If you do, plentyDevTool will no longer recognize those systems, plugin sets and plugins locally.
Do not add, delete or modify files manually anywhere outside the plugin subfolders.
In addition to the folder structure, plentyDevTool generates a
plenty.ignore file. Use this file to specify file paths you don't want to synchronise. You can use the
* wildcard operator. By default, the following paths are ignored:
Changes take effect when you restart the app or change the synchronisation path in the plentyDevTool settings. If you delete the
plenty.ignore file, it's automatically regenerated with the default entries.
Before you can start coding, you need to decide which plugins you want to work on. On the left-hand side, open the plugin set which contains the plugin you want to synchronise, then toggle the plugin. You can select as many plugins as you want this way.
Open the Dashboard and Pull (
CMD + P /
CTRL + P) the plugins. Depending on how many plugins you download or update this way, the process may take a few seconds to complete. If you download a file that has also been modified locally, your local file will be renamed and labeled as backup before the download, allowing you to reconcile the remote and local versions of the file. The renamed file will show up as an addition on the Dashboard.
After you have modified a plugin locally, you can Push (
CMD + U /
CTRL + U) the changes back to your plentymarkets system. Check the changes you have made on the Dashboard. Note that only changes of plugins toggled active will be pushed to the system. When working on a set that is not linked to a client, you can also trigger a faster, abbreviated version of the plugin build on Push. To do this, activate the plentyDevTool: build automatically toggle in the respective plugin set in the back end. This setting is set dependent, so you can choose to automatically build some sets, but not others.
For the differences between the regular build and the abbreviated build, refer to the following table:
|Step||Full build||Abbreviated build|
|Copy files to deployment directory||Yes||No|
|Check code of plugins||Yes||No|
|Copy files to build directory||Yes||Yes|
|Update plugin routes cache||Yes||No|
|Run database migrations||Yes||No|
You can not only work on plugins that already exist on your system, but also add new ones locally. Once you have created a plugin folder in one of your set folders and filled it with all relevant files, click Detect new local plugins (
CMD + D /
CTRL + D) to detect all new plugins. Plugins are not detected if the root namespace of the folder and the name and namespace in the plugin JSON differ.
Click Install to add a plugin for synchronisation.