[no-restricted-path] Custom error message#1802
Merged
ljharb merged 1 commit intoJun 7, 2020
Merged
Conversation
malykhinvi
marked this pull request as ready for review
June 6, 2020 10:43
2 similar comments
ljharb
approved these changes
Jun 6, 2020
ljharb
left a comment
Member
There was a problem hiding this comment.
Straightforward, looks good. Thanks!
ljharb
force-pushed
the
no-resticted-path-custom-message
branch
2 times, most recently
from
June 6, 2020 21:15
0dfd086 to
0b81052
Compare
This was referenced Mar 18, 2021
Merged
This file contains hidden or 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
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.
Main change
Adds a
messageconfiguration param for everyzone, that will be displayed in case of the rule violation.The logic is pretty similar to eslint's no-restricted-imports
Background
Sometimes, it is not very clear, why you can not import certain modules in certain scenarios. This is especially the case for newcomers. To be more user friendly, we could display additional info, right in the error message. It would look something like this:
Then VSCode would display it like that:
