-
-
Notifications
You must be signed in to change notification settings - Fork 36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Verify the installed_paths
after save
#97
Conversation
I know that goes against the principle of only reporting errors in output, but as this is in verbose mode, I would say Yes, definitely.
Fully agree. Should make life easier for all. |
Oh dear ... while debugging why the build was failing, I've discovered a pretty interesting bug, which could well be the cause of some reported mystery issues. Win! I'll work on a fix and send it in as a separate PR which will need to be merged before this PR as this PR will be dependent on it. |
PR #98 has been merged. |
Thanks, I'll update this PR in a moment and will make it mergable if the build then passes. |
As most problems reported are to do with paths not being set correctly, let's verify success within the plugin, independently of PHPCS. To that end, a new function `verifySaveSuccess()` has been added. This function takes the paths which were to be saved and compares then to the paths which are actually set in PHPCS after the save to determine whether or not the plugin was successful and changes the exit code if this is not the case. If there was a mismatch in paths and `verbose` mode is turned on, an information message will be displayed to help debugging. At this moment I don't have a test case for this new functionality, however, I imagine it will come in useful with future bug reports.
1ca8c0d
to
5277f67
Compare
Marking this ready for review. I've updated the PR for:
|
Just now thinking: this should probably also run |
Oh second thought: no, as Hmm.. let's see how we fare for now. If needs be, this can be revisited later. |
Proposed Changes
As most problems reported are to do with paths not being set correctly, let's verify success within the plugin, independently of PHPCS.
To that end, a new function
verifySaveSuccess()
has been added.This function takes the paths which were to be saved and compares them to the paths which are actually set in PHPCS after the save to determine whether or not the plugin was successful and changes the exit code if this is not the case.
Open questions:
verbose
mode is turned on ? Something likeExpected paths to be set to: %s, found: %s
.This could also come in handy to verify that all paths which should be set were found by the plugin.
At this moment I don't have a test case for this new functionality, however, I imagine it will come in useful with future bug reports.