slither-doctor: PATH checks #1550
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
elopez
force-pushed
the
dev-doctor-paths
branch
4 times, most recently
from
e1c5bd5 to
9a14d41
Compare
This was used just for typing, and it was removed in a recent `packaging` version, so remove the LegacyVersion import. Also declare the missing `packaging` dependency in setup.py
This ensures PATH is correctly configured, and hints the user about what they might need to do to configure it correctly.
This avoids mixed output in e.g. CI outputs
elopez
force-pushed
the
dev-doctor-paths
branch
from
9a14d41 to
b01ba03
Compare
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.
This PR adds a new check to slither-doctor, that validates if
$PATHis set correctly in the system.When all looks good, it will print the following:
However, if the path is misconfigured it will print a red message and suggest a folder you should add to
$PATH(for this example I broke my PATH config on purpose). Users can run slither-doctor aspython3 -m slither.tools.doctoreven if their PATH is misconfigured:This will also warn if you somehow have another Slither installation earlier in PATH (exemplified here by running slither-doctor from a non-activated venv, while there's a system-wide installation of slither)