#27 [Inspection] Observer declaration check for duplicates #59
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…hpstorm-plugin into observer-declaration-check � Conflicts: � resources/META-INF/plugin.xml
vasilii-b
changed the title
vasilii-b
changed the title
…hpstorm-plugin into observer-declaration-check
VitaliyBoyko
requested changes
Mar 25, 2020
src/com/magento/idea/magento2plugin/inspections/xml/ObserverDeclarationInspection.java
Show resolved
Hide resolved
src/com/magento/idea/magento2plugin/inspections/xml/ObserverDeclarationInspection.java
Show resolved
Hide resolved
| return new XmlElementVisitor() { | ||
| private final String moduleXmlFileName = ModuleXml.getInstance().getFileName(); | ||
| private static final String eventsXmlFileName = "events.xml";//todo: move to separate file as done to ModuleXml | ||
| private static final String duplicatedObserverNameSameFileProblemDescription = "Observer name already used in this file. For more details see Inspection Description."; |
There was a problem hiding this comment.
The observer name already used in this file. For more details see Inspection Description.
| private static final String eventsXmlFileName = "events.xml";//todo: move to separate file as done to ModuleXml | ||
| private static final String duplicatedObserverNameSameFileProblemDescription = "Observer name already used in this file. For more details see Inspection Description."; | ||
| private static final String duplicatedObserverNameProblemDescription = | ||
| "Observer name \"%s\" for event \"%s\" is already used in the module \"%s\" (%s scope). For more details see Inspection Description."; |
There was a problem hiding this comment.
The observer name...
|
One more thing. Don't forget to update CHANGELOG.md with the new functionality. |
added 2 commits
March 26, 2020 19:07
|
Hi @VitaliyBoyko, |
VitaliyBoyko
requested changes
Mar 26, 2020
src/com/magento/idea/magento2plugin/inspections/xml/ObserverDeclarationInspection.java
Outdated
Show resolved
Hide resolved
|
Hi @VitaliyBoyko, |
VitaliyBoyko
approved these changes
Mar 27, 2020
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a new code inspection to avoid accidentally overriding an observer.
This PR solves next issues
More details
ℹ️ The Observer Inspections adds warnings with the following information
1. Observer name already used in the same file
2. Observer name already used in the scope of other modules
(see screenshot from #3)
3. Information about the duplicated name scope:
Vendor_Module/etc,Vendor_Module/etc/adminhtmlorVendor_Module/etc/frontend4. 🙅♂ No warning for the disabled observer
5. 📖Details of why such situation occurs and how to handle it
