@flowscripter/io-plugin-filesystem 2.0.1 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -58,6 +58,20 @@
|
|
|
58
58
|
found without the consuming CLI needing a direct npm dependency on it -
|
|
59
59
|
also proven end to end in this repo's tests, not just type-checking.
|
|
60
60
|
|
|
61
|
+
## String and Structured Locations
|
|
62
|
+
|
|
63
|
+
A `file` location can be given in two forms:
|
|
64
|
+
|
|
65
|
+
- A string: a `file:` URL (`file:///foo` or `file:/foo`, no host) or a bare
|
|
66
|
+
path. `parseLocationString` returns only `{ path }`, so a string always
|
|
67
|
+
addresses the whole `path` as a `container` target. Strings are the
|
|
68
|
+
convenient form for code holding a path or URL, and the form other
|
|
69
|
+
providers use when they resolve a `file` location.
|
|
70
|
+
- A structured location object, `{ path, filename?, pattern? }`, validated
|
|
71
|
+
by `filesystemLocationSchema` directly. It is needed to address a single
|
|
72
|
+
file (`filename`, an `entry` target) or the files matching a glob
|
|
73
|
+
(`pattern`, a `pattern` target), which a string cannot express.
|
|
74
|
+
|
|
61
75
|
## Bundled Bun Module Usage
|
|
62
76
|
|
|
63
77
|
Loaded as a [dynamic-plugin-framework](https://github.com/flowscripter/dynamic-plugin-framework)
|