Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e993f6deb9 |
@@ -1,5 +1,12 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 2025-12-16 - 1.3.1 - fix(docs)
|
||||||
|
docs(readme): add "Directory Copy & Move" section with examples and options
|
||||||
|
|
||||||
|
- Adds README documentation for recursive directory copy and move with usage examples (basic copy/move, copy with filter, overwrite, preserve timestamps, applyFilter).
|
||||||
|
- Documents conflict handling modes for copy/move: merge (default), error, and replace.
|
||||||
|
- Documentation-only change — no code or API changes; recommended patch version bump.
|
||||||
|
|
||||||
## 2025-12-16 - 1.3.0 - feat(smartfs.directory)
|
## 2025-12-16 - 1.3.0 - feat(smartfs.directory)
|
||||||
feat(smartfs.directory): add directory copy/move with conflict handling and options
|
feat(smartfs.directory): add directory copy/move with conflict handling and options
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@push.rocks/smartfs",
|
"name": "@push.rocks/smartfs",
|
||||||
"version": "1.3.0",
|
"version": "1.3.1",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "a cross platform extendable fs module",
|
"description": "a cross platform extendable fs module",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
|
|||||||
47
readme.md
47
readme.md
@@ -135,6 +135,53 @@ await fs.directory('/path/to/dir')
|
|||||||
const exists = await fs.directory('/path/to/dir').exists();
|
const exists = await fs.directory('/path/to/dir').exists();
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### 📁 Directory Copy & Move
|
||||||
|
|
||||||
|
Copy or move entire directory trees with fine-grained control:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// Basic copy - copies all files recursively
|
||||||
|
await fs.directory('/source').copy('/destination');
|
||||||
|
|
||||||
|
// Basic move - moves directory to new location
|
||||||
|
await fs.directory('/old-location').move('/new-location');
|
||||||
|
|
||||||
|
// Copy with options
|
||||||
|
await fs.directory('/source')
|
||||||
|
.filter(/\.ts$/) // Only copy TypeScript files
|
||||||
|
.overwrite(true) // Overwrite existing files
|
||||||
|
.preserveTimestamps(true) // Keep original timestamps
|
||||||
|
.copy('/destination');
|
||||||
|
|
||||||
|
// Copy all files (ignore filter setting)
|
||||||
|
await fs.directory('/source')
|
||||||
|
.filter('*.ts')
|
||||||
|
.applyFilter(false) // Ignore filter, copy everything
|
||||||
|
.copy('/destination');
|
||||||
|
|
||||||
|
// Handle target directory conflicts
|
||||||
|
await fs.directory('/source')
|
||||||
|
.onConflict('merge') // Default: merge contents
|
||||||
|
.copy('/destination');
|
||||||
|
|
||||||
|
await fs.directory('/source')
|
||||||
|
.onConflict('error') // Throw if target exists
|
||||||
|
.copy('/destination');
|
||||||
|
|
||||||
|
await fs.directory('/source')
|
||||||
|
.onConflict('replace') // Delete target first, then copy
|
||||||
|
.copy('/destination');
|
||||||
|
```
|
||||||
|
|
||||||
|
**Configuration Options:**
|
||||||
|
| Method | Default | Description |
|
||||||
|
|--------|---------|-------------|
|
||||||
|
| `filter(pattern)` | none | Filter files by glob, regex, or function |
|
||||||
|
| `applyFilter(bool)` | `true` | Whether to apply filter during copy/move |
|
||||||
|
| `overwrite(bool)` | `false` | Overwrite existing files at destination |
|
||||||
|
| `preserveTimestamps(bool)` | `false` | Preserve original file timestamps |
|
||||||
|
| `onConflict(mode)` | `'merge'` | `'merge'`, `'error'`, or `'replace'` |
|
||||||
|
|
||||||
### 🔐 Tree Hashing (Cache-Busting)
|
### 🔐 Tree Hashing (Cache-Busting)
|
||||||
|
|
||||||
Compute a deterministic hash of all files in a directory - perfect for cache invalidation:
|
Compute a deterministic hash of all files in a directory - perfect for cache invalidation:
|
||||||
|
|||||||
@@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@push.rocks/smartfs',
|
name: '@push.rocks/smartfs',
|
||||||
version: '1.3.0',
|
version: '1.3.1',
|
||||||
description: 'a cross platform extendable fs module'
|
description: 'a cross platform extendable fs module'
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user