Skip to content

Commit 073c11d

Browse files
sohkaiskipjack
authored andcommitted
docs(config): add details on resolve.symlink and npm link (#1771)
1 parent 5e86e4e commit 073c11d

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

src/content/configuration/module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ In a Rule the properties [`test`](#rule-test), [`include`](#rule-include), [`exc
5656

5757
When using multiple conditions, all conditions must match.
5858

59-
W> Be careful! The resource is the _resolved_ path of the file, which means symlinked resources are the real path _not_ the symlink location. This is good to remember when using tools that symlink packages (like `npm link`), common conditions like `/node_modules/` may inadvertently miss symlinked files.
59+
W> Be careful! The resource is the _resolved_ path of the file, which means symlinked resources are the real path _not_ the symlink location. This is good to remember when using tools that symlink packages (like `npm link`), common conditions like `/node_modules/` may inadvertently miss symlinked files. Note that you can turn off symlink resolving (so that resources are resolved to the symlink path) via [`resolve.symlinks`](/configuration/resolve#resolve-symlinks).
6060

6161

6262
### Rule results

src/content/configuration/resolve.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,11 @@ plugins: [
258258

259259
`boolean`
260260

261-
Whether to resolve symlinks to their symlinked location. Default:
261+
Whether to resolve symlinks to their symlinked location.
262+
263+
When enabled, symlinked resources are resolved to their _real_ path, not their symlinked location. Note that this may cause module resolution to fail when using tools that symlink packages (like `npm link`).
264+
265+
`resolve.symlinks` defaults to:
262266

263267
```js
264268
symlinks: true

0 commit comments

Comments
 (0)