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
Chore: Adding debug logs on successful plugin loads #10100
Merged
Merged
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
not-an-aardvark
approved these changes
Mar 19, 2018
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Should we also include the absolute path of the plugin?
@not-an-aardvark Good call, I've added the resolved path. Here's how the output looks now:
|
gyandeeps
approved these changes
Mar 19, 2018
not-an-aardvark
approved these changes
Mar 19, 2018
This was referenced Mar 22, 2018
Merged
This was referenced Mar 22, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
accepted
There is consensus among the team that this change meets the criteria for inclusion
archived due to age
This issue has been archived; please open a new issue for any further discussion
chore
This change is not user-facing
core
Relates to ESLint's core APIs and features
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.
What is the purpose of this pull request? (put an "X" next to item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain: Adding some debug logs for successful plugin loads, to help users detect if plugin versions don't match expectations.
What changes did you make? (Give an overview)
Added some debug logging to lib/config/plugins.js on successful plugin load. These statements note the plugin name (as specified in config), the resolved plugin name, and the version of the loaded plugin (if we can determine it).
This logic is only executed if debug is actually enabled. This is because the most reliable way I know of for finding a plugin version is to
require
thepackage.json
file within the plugin package and read theversion
property. There's no point in resolving, loading, and reading that file if debug isn't enabled, hence the extra if check.Is there anything you'd like reviewers to focus on?
Example output when running
DEBUG=eslint:plugins node ./bin/eslint.js lib
(from root of ESLint project):(Note: Looks a bit different than when run on console due to output redirect. Just ignore the timestamps.)
Inspired by #10090. This output could be useful for users who expect a certain plugin version to be loaded, but they get a different version due to either global/local mismatching or npm/yarn shenanigans.