readme GOTCHA for .gitIgnore scenarios #245
Open
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
yuri-scarbaci-lenio
changed the title
jonschlinkert
requested changes
Mar 28, 2024
| @@ -122,6 +122,13 @@ console.log(micromatch.isMatch('foo', ['b*', 'f*'])) //=> true | |||
|
|
|||
| You can mix and match these features to create whatever patterns you need! | |||
|
|
|||
| ## When you SHOULD NOT use micromatch? | |||
There was a problem hiding this comment.
Change to "Why NOT use micromatch?" to be consistent with previous title.
| @@ -122,6 +122,13 @@ console.log(micromatch.isMatch('foo', ['b*', 'f*'])) //=> true | |||
|
|
|||
| You can mix and match these features to create whatever patterns you need! | |||
|
|
|||
| ## When you SHOULD NOT use micromatch? | |||
| If you are trying to accomplish the same filtering that the `.gitIgnore` `git` does, this library is NOT going to accomplish 1-1 javascript transposition of the matching algorithm. | |||
There was a problem hiding this comment.
change gitIgnore to gitignore (all lowercase) to be consistent with Git's casing and conventions: gitignore docs.
| ## When you SHOULD NOT use micromatch? | ||
| If you are trying to accomplish the same filtering that the `.gitIgnore` `git` does, this library is NOT going to accomplish 1-1 javascript transposition of the matching algorithm. | ||
|
|
||
| This library is meant to be a functionally drop-in replacement for minimatch and multimatch and neither of them are conforming to https://man7.org/linux/man-pages/man7/glob.7.html. |
There was a problem hiding this comment.
Remove this line, since the glob(3) linux man page is not a specification or idiomatic reference for .gitignore.
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.
Description
#244
Checklist