Skip to content

Commit 1a28354

Browse files
committed
docs: clarification for followSymbolicLinks option
1 parent 190e6bf commit 1a28354

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,9 @@ fg.sync('**', { onlyFiles: false, cwd: 'dir', deep: 2 }); // ['one', 'one/two']
333333
* Type: `boolean`
334334
* Default: `true`
335335

336-
Indicates whether to traverse descendants of symbolic link directories.
336+
Indicates whether to traverse descendants of symbolic link directories when expanding `**` patterns.
337+
338+
> :book: Note that this option does not affect the base directory of the pattern. For example, if `./a` is a symlink to directory `./b` and you specified `['./a**', './b/**']` patterns, then directory `./a` will still be read.
337339
338340
> :book: If the [`stats`](#stats) option is specified, the information about the symbolic link (`fs.lstat`) will be replaced with information about the entry (`fs.stat`) behind it.
339341

0 commit comments

Comments
 (0)