Add a note about being careful with using the plugin events - In the "After" events mostly but also in the "Before" ones

[GreenMachine01]

In the documentation for the plugin developers, we need to add a note that the developer should be careful when using the After events let's also mention what to be careful about for the Before events.

[GreenMachine01]

@yuval-hazaz Please you add the relevant information about what the plugin developer needs to be careful about regarding the After events

[dericksozo]

Hi @yuval-hazaz @abrl91 , is this information available somewhere on the Notion? Can you please copt that page into the Docs folder?

[mulygottlieb]

@dericksozo, the issue to warn about is as follows:

• In the "After" events, you get the result of the generated files from the DSG, and you can make any changes you like. If you are not careful, you can easily do something like completely overriding the file(s) that was generated and running it over. In some cases, perhaps that's what the plugin author meant, but usually, plugins make smaller changes to generated files / are adding new files - so a plugin developer needs to be careful not to run over the generated file if it was not intended (the generated file contains code generated by logic and configuration that the plugin cannot be aware of, let alone that other plugins in the "chain" might have made other changes to the file that will get run over)
• In the "Before" events, you can make a mistake by editing the templates, which are later used to generate the code - so you should be careful not to make unintended changes to the file templates in the "Before" phase
• In the "Before" events, you can choose to do "skipDefaultBehavior," but then the DSG does not do the part of the default generation for this event at all - again, this can be what you meant in some cases, but you should be careful to see that this is what you really meant.

AFAIK, this ticket was originally opened for the first item - running over generated code in the "After" events instead of making subtle changes to the already-generated files.

[GreenMachine01]

lets handle all the warnings

[dericksozo]

This issue is being taken care of in PR #369.