@kexi/vibe-native 0.17.0 → 0.18.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 +9 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,10 +20,10 @@ pnpm add @kexi/vibe-native
|
|
|
20
20
|
|
|
21
21
|
## Platform Support
|
|
22
22
|
|
|
23
|
-
| Platform | Architecture | Filesystem
|
|
24
|
-
|
|
25
|
-
| macOS
|
|
26
|
-
| Linux
|
|
23
|
+
| Platform | Architecture | Filesystem |
|
|
24
|
+
| -------- | ------------ | ------------------------- |
|
|
25
|
+
| macOS | x64, arm64 | APFS |
|
|
26
|
+
| Linux | x64, arm64 | Btrfs, XFS (with reflink) |
|
|
27
27
|
|
|
28
28
|
## Usage
|
|
29
29
|
|
|
@@ -70,6 +70,7 @@ Check if native clone operations are available on the current platform.
|
|
|
70
70
|
### `supportsDirectory(): boolean`
|
|
71
71
|
|
|
72
72
|
Check if directory cloning is supported:
|
|
73
|
+
|
|
73
74
|
- macOS (`clonefile`): `true`
|
|
74
75
|
- Linux (`FICLONE`): `false` (files only)
|
|
75
76
|
|
|
@@ -82,6 +83,7 @@ Get the current platform identifier.
|
|
|
82
83
|
### File Type Validation
|
|
83
84
|
|
|
84
85
|
Only regular files and directories are allowed. The following are rejected:
|
|
86
|
+
|
|
85
87
|
- Symlinks (to prevent path traversal)
|
|
86
88
|
- Device files (block/character devices)
|
|
87
89
|
- Sockets
|
|
@@ -90,6 +92,7 @@ Only regular files and directories are allowed. The following are rejected:
|
|
|
90
92
|
### Path Handling
|
|
91
93
|
|
|
92
94
|
This library does not perform path normalization or validation. Callers should:
|
|
95
|
+
|
|
93
96
|
- Validate paths before calling clone functions
|
|
94
97
|
- Use `path.resolve()` to normalize relative paths
|
|
95
98
|
- Check for symlinks if path traversal is a concern
|
|
@@ -131,10 +134,12 @@ try {
|
|
|
131
134
|
## Filesystem Requirements
|
|
132
135
|
|
|
133
136
|
### macOS
|
|
137
|
+
|
|
134
138
|
- **APFS** is required for `clonefile()` to work
|
|
135
139
|
- HFS+ and other filesystems will return `ENOTSUP`
|
|
136
140
|
|
|
137
141
|
### Linux
|
|
142
|
+
|
|
138
143
|
- **Btrfs** or **XFS** (with reflink support) is required
|
|
139
144
|
- ext4 and other filesystems will return `EOPNOTSUPP`
|
|
140
145
|
|