How do I handle JSON files with fs-jetpack?

Use write() with an object to automatically serialize to JSON, and read() with 'json' or 'jsonWithDates' to parse it back. For example, jetpack.write('data.json', { key: 'value' }) creates a JSON file.

fs-jetpack vs fs-extra: which is better?

Choose fs-jetpack for its cleaner API, automatic error handling, and JSON support. Opt for fs-extra if you need more comprehensive fs methods or prefer a closer drop-in replacement for native fs with additional utilities.

How to copy files using glob patterns in fs-jetpack?

Use the copy() method with the matching option, which supports glob patterns. For instance, jetpack.copy('src', 'dest', { matching: '*.md' }) copies all Markdown files, and you can add negated patterns like '!secret.md'.

Does fs-jetpack support file watching?

No, fs-jetpack does not include file system watchers. For monitoring changes, you need to use native fs.watch or a separate library like chokidar, which adds another dependency.

How to create and clean up temporary directories?

Use tmpDir() to create a unique temporary directory, which returns a new jetpack context. Clean up with remove() when done, as shown in examples like dir.remove() after operations.

Can I chain operations fluently in fs-jetpack?

Yes, methods like dir(), file(), and cwd() return jetpack objects, allowing fluent chaining. For example, jetpack.dir('foo').file('bar.txt', { content: 'text' }) creates a directory and file in one chain.

Open-Awesome

fs-jetpack

MITTypeScript5.1.0

A more convenient and powerful file system API for Node.js, designed for scripting, tooling, and build pipelines.

GitHub

786 stars46 forks0 contributors

What is fs-jetpack?

fs-jetpack is a Node.js library that provides a more convenient and powerful API for file system operations compared to the native `fs` module or `fs-extra`. It simplifies tasks like reading/writing JSON, managing directories, copying files with glob patterns, and handling errors automatically, making it especially useful for scripting, tooling, and build pipelines.

Target Audience

Node.js developers working on build tools, automation scripts, CLI applications, or any project requiring frequent and reliable file system manipulations.

Value Proposition

Developers choose fs-jetpack for its intuitive API, automatic error recovery, clear sync/async method naming, and powerful features like JSON handling and glob-based file operations, which significantly reduce boilerplate code and improve productivity.

Overview

Better file system API for Node.js

Use Cases

Best For

Automating file copy and transformation tasks in build pipelines
Writing configuration files or data stores that use JSON
Creating and cleaning up temporary directories for data processing
Scripting complex file system operations with fluent chaining
Filtering and manipulating files using glob patterns
Simplifying error handling for missing files or directories

Not Ideal For

Applications requiring real-time file system event monitoring (watchers)
High-performance server code where native fs module overhead is critical
Projects deeply integrated with callback-based async patterns
Environments where minimizing dependencies is a top priority

Pros & Cons

Pros

Object-Oriented CWD Management

Allows creating multiple independent working directory contexts with cwd(), enabling organized, modular file operations without affecting process.cwd().

Seamless JSON Integration

Automatically serializes objects to JSON on write() and parses them back with read('json'), eliminating manual JSON.stringify/parse calls.

Automatic Error Recovery

Handles missing files by creating parent directories on write and returning undefined for reads, reducing boilerplate ENOENT error handling.

Clear Async/Sync Naming

Uses method() for sync and methodAsync() for async, providing immediate clarity without standard 'Sync' suffixes, though it flips Node.js conventions.

Cons

Missing Advanced Features

Lacks built-in file system watchers and some fs-extra utilities like ensureLink, limiting it to basic operations despite its convenience.

Non-Standard Naming Convention

Flips typical Node.js naming by using method() for sync and methodAsync() for async, which can confuse developers accustomed to the standard pattern.

TypeScript Import Complexity

Requires importing types from a special path 'fs-jetpack/types', adding an extra step for TypeScript users compared to more integrated libraries.

Frequently Asked Questions

Related Projects

chokidar

Minimal and efficient cross-platform file watching library

Stars12,188

Forks630

Last commit3 days ago

fs-extra

Node.js: extra methods for the fs object like copy(), remove(), mkdirs()

User-friendly glob matching

Stars2,647

Forks137

Last commit9 days ago

del

Delete files and directories

Stars1,345

Forks69