glob pattern in except option of the no-restricted-paths rule
#1708
Conversation
5 similar comments
This comment has been minimized.
This comment has been minimized.
| ``` | ||
|
|
||
| The following patterns are not considered problems when configuration set to `{ "zones": [ { "target": "./client", "from": "./server" } ] }`: |
There was a problem hiding this comment.
The "The following patterns" wording follows eslint's own docs; please restore it in both places.
| let exceptionGlobs = [] | ||
|
|
||
| exceptions.forEach(exception => { | ||
| if (isGlob(exception)) { |
There was a problem hiding this comment.
is this not something minimatch can validate?
There was a problem hiding this comment.
I just looked into it, but unfortunately minimatch is not enough here. It would just tell me that it does not match, but it doesn't tell me if it is because the glob is not matching or because it cannot handle relative paths. If I don't know that I would also not know when to call reportInvalidExceptionPath.
So I guess we have to use isGlob here.
There was a problem hiding this comment.
what do you mean by "cannot handle relative paths"? is there a need for a different error message between globs and paths?
There was a problem hiding this comment.
Sorry, maybe I wasn't clear enough.
isGlob checks if it is a glob and thus a relative path like "./server" will be marked as non-glob ("exceptionPaths"). Otherwise if I would check for example "./server" with minimatch it will tell me this path doesn't match, no matter if this path would actually match, because minimatch only works with globs.
Also the check if you have an invalid exception path is done by path.relative(), which also does not work with globs. That's why you will currently not see the "Restricted path exceptions must be descendants of the configured from path for that zone." error message for any glob you provide.
And I think it is totally ok, because you would use globs for different reasons anyways. For example if you want to exclude all "**/types.js", you cannot really check if this is a descendant (you could check if there is any file that matches, but this would take a lot of resources and wouldn't make sense to me).
|
To be honest I'm a bit lost now and don't really understand why the tests are failing. The error messages are not really helpful for me. Help from someone else is much appreciated. |
|
@KevinHerklotz sorry for the delay. i've partially rebased this, and tests seem to be passing locally :-) but it'll need another rebase onto latest master. |
ljharb
force-pushed
the
add-glob-to-except
branch
from
888443e
to
0096b9f
Compare
Allow to also pass a glob pattern to the
exceptoption of theno-restricted-pathsrule.Before you could only add a relative path. This is still working and the new glob pattern is also only working in the relative path.
I also improved the documentation in general.
Fixes #1701