Document the unusual behaviour of ** in glob option #941
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
I had assumed that glob patterns work like they do with the *nix `ls` command, or in tools like lint-staged. It seems that ** is interpreted as a single asterisk for 1+ directories, rather than "0 or more directories deep" as in `ls`. Whilst there is a link to the Go glob library used, and it mentions double asterisks, I was mainly left confused by the line in the README: > Syntax is inspired by [standard > wildcards](http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm), > except that ** is aka super-asterisk, that do not sensitive for separators. Whilst the glob library README could be improved, I think it's natural to use `ls` to try and test what would be matched (or copy config from tools like lint-staged or pre-commit), so it would be great to call out this difference in the lefthook documentation. It might be quite useful to provide a means of testing/listing what files would be matched for different commands - I found it necessary to do the below. Example ======= Let's say you have a directory structure like: ``` - src - foo - bar - nestedTwice.js - nestedOnce.js - topLevel.js ``` If you run `ls -1`, you get all three files: ``` ls -1 src/**/*.js src/foo/bar/nestedTwice.js src/foo/nestedOnce.js src/topLevel.js ``` Given this lefthook config ```yaml pre-commit: commands: eslint: run: ls -1 {staged_files} glob: "src/**/*.js" ``` And you run: ```sh git add src lefthook run pre-commit ``` The output is missing `src/topLevel.js`: ``` src/foo/bar/nestedTwice.js src/foo/nestedOnce.js ```
|
I've also noticed that if you use the If that's correct, I'm happy to add an explanation to the docs that to this PR, or open a separate one. |
jamiecobbett
commented
Jan 31, 2025
| You'll need something like: | ||
|
|
||
| ```yaml | ||
| glob: "{src/*.js,src/**/*.js}" |
There was a problem hiding this comment.
On further testing, I'm fairly sure you just need glob: "src/*.js"
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.
⚡ Summary
I had assumed that glob patterns work like they do with the *nix
lscommand, or in tools like lint-staged. I can imagine people expecting it to behave the same.It seems that
**is interpreted as a single asterisk, ie meaning "1+ directories deep", rather than "0 or more directories deep".Whilst there is a link to the Go glob library used, and that README mentions double asterisks, I was mainly left confused by it:
I don't think this covers the difference I'm bringing up. I also don't know what is meant by "super-asterisk" here - I'd love to know!
More details, including an example are in the commit message.
Thanks for making such an awesome tool!