Promyze's IDE plugins use cases
As we do our best to keep plugins aligned and consistent in terms of features, this article lists the common use cases of Promyze's IDE plugins. You'll find dedicated articles for:
All plugins need to be configured with your Promyze API Key available in your personal account. The key encompasses the URL of Promyze as well as your identity. If you use the self-hosted version, make sure your public URL is correctly configured.
From any file, select some code, right-click and access the Promyze plugin menu, and indicate whether you're identifying a new practice or an existing one. Indicate also if it's related to:
- A positive example: a source code compliant with the best practice
- A negative example: a source code not compliant with the best practice
Fill the required fields, and this will be sent in the provided space in Promyze. This contribution will be waiting for discussion until the next Craft Workshop.
Example with VSCode
When you identify a negative example, you can then modify this code to improve it or show how to follow a best practice.
Right-click again on the editor and select Promyze -> Send as a correction to the previous negative tag to indicate you suggest modifications related to the previously identified practice. The negative tag and its associated fix will be presented in the next Craft Workshop. This way, each developer can present the improvements made to the code.
As you code, Promyze identifies automatically pieces of code where best practices are not applied:
Automatic suggestions in JetBrains
Only negative suggestions (best practices not applied) are listed. If you open the Promyze pane in your IDE, all the positive and negative suggestions will appear.
Suggestions are computed based on the content of your source code file displayed in the editor. It does not scan the entire file nor the entire project.
You can view all your team's practices as well as those available in the catalogs you subscribe to by opening the Promyze dedicated pane in your IDE. For example, It is also possible to access your current Craft Workshop sessions as well as the current battles on current practices from this tab. here is a simple illustration with Visual Studio:
You'd like to review a file during a Craft Workshop, but don't know yet what kind of best practices to identify?
From any file, you can access the Promyze plugin menu by right-clicking in the editor. You then have the option to send the complete file or your selection only to Promyze.
This file will then appear in the current workshop, and you can start identify practices from the workshop.