From 1a28354204a3d3d42502a059ba4b71f30cb9cc4c Mon Sep 17 00:00:00 2001 From: mrmlnc Date: Sun, 27 Jun 2021 15:49:39 +0300 Subject: [PATCH] docs: clarification for `followSymbolicLinks` option --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5a913a64..8f8469bb 100644 --- a/README.md +++ b/README.md @@ -333,7 +333,9 @@ fg.sync('**', { onlyFiles: false, cwd: 'dir', deep: 2 }); // ['one', 'one/two'] * Type: `boolean` * Default: `true` -Indicates whether to traverse descendants of symbolic link directories. +Indicates whether to traverse descendants of symbolic link directories when expanding `**` patterns. + +> :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. > :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.