@zenfs/core 0.3.5 → 0.4.1

package/readme.md

@@ -1,6 +1,10 @@
 # ZenFS
 
-ZenFS is an in-browser file system that emulates the [Node JS file system API](http://nodejs.org/api/fs.html) and supports storing and retrieving files from various backends. ZenFS also integrates nicely with other tools.
+ZenFS is a file system that emulates the [Node JS file system API](http://nodejs.org/api/fs.html).
+
+It works using a system of backends, which are used by ZenFS to store and retrieve data. ZenFS can also integrate nicely with other tools.
+
+ZenFS is a fork of [BrowserFS](https://github.com/jvilk/BrowserFS).
 
 ## Backends
 
@@ -33,13 +37,13 @@ npm install @zenfs/core
 ```js
 import fs from '@zenfs/core';
 
-fs.writeFileSync('/test.txt', 'Cool, I can do this in the browser!');
+fs.writeFileSync('/test.txt', 'Cool, I can do this in any JS environment (including browsers)!');
 
 const contents = fs.readFileSync('/test.txt', 'utf-8');
 console.log(contents);
 ```
 
-#### Using different and/or different backends
+#### Using different and/or multiple backends
 
 A single `InMemory` backend is created by default, mounted on `/`.
 
@@ -50,7 +54,7 @@ You can use multiple backends by passing an object to `configure` which maps pat
 The following example mounts a zip file to `/zip`, in-memory storage to `/tmp`, and IndexedDB to `/home`. Note that `/` has the default in-memory backend.
 
 ```js
-import { configure } from '@zenfs/core';
+import { configure, InMemory } from '@zenfs/core';
 import { IndexedDB } from '@zenfs/dom';
 import { Zip } from '@zenfs/zip';
 
@@ -58,13 +62,17 @@ const zipData = await (await fetch('mydata.zip')).arrayBuffer();
 
 await configure({
 	'/mnt/zip': { backend: Zip, zipData },
-	'/tmp': 'InMemory',
+	'/tmp': InMemory,
 	'/home': IndexedDB,
 };
 ```
 
 > [!TIP]
-> When configuring a mount point, you can pass in 1. A string that maps to a built-in backend 2. A `Backend` object, if the backend has no required options 3. An object that has a `backend` property which is a `Backend` or a string that maps to a built-in backend and the options accepted by the backend
+> When configuring a mount point, you can pass in
+>
+> 1. A `Backend` object, if the backend has no required options
+> 2. An object that has the options accepted by the backend and a `backend` property which is a `Backend` object
+> 3. A `FileSystem` instance (_not recommended_)
 
 Here is an example that mounts the `Storage` backend from `@zenfs/dom` on `/`:
 
@@ -109,13 +117,13 @@ if (!exists) {
 You may have noticed that attempting to use a synchronous function on an asynchronous backend (e.g. `IndexedDB`) results in a "not supplied" error (`ENOTSUP`). If you would like to use an asynchronous backend synchronously you need to wrap it in an `AsyncMirror`:
 
 ```js
-import { configure, fs } from '@zenfs/core';
+import { configure, fs, AsyncMirror, InMemory } from '@zenfs/core';
 import { IndexedDB } from '@zenfs/dom';
 
 await configure({
 	'/': {
-		backend: 'AsyncMirror',
-		sync: 'InMemory',
+		backend: AsyncMirror,
+		sync: InMemory,
 		async: IndexedDB,
 	},
 });
@@ -130,12 +138,12 @@ If you would like to create backends without configure (e.g. to do something dyn
 You can then mount and unmount the backend instance by using `mount` and `umount`.
 
 ```js
-import { configure, createBackend } from '@zenfs/core';
+import { configure, createBackend, InMemory } from '@zenfs/core';
 import { IndexedDB  } from '@zenfs/dom';
 import { Zip } from '@zenfs/zip';
 
 await configure({
-	'/tmp': 'InMemory',
+	'/tmp': InMemory,
 	'/home': IndexedDB,
 };
 

package/scripts/make-index.js

@@ -0,0 +1,100 @@
+#!/usr/bin/env node
+import { parseArgs } from 'util';
+import { statSync, readdirSync, writeFileSync } from 'fs';
+import { join } from 'path/posix';
+import { resolve } from 'path';
+import { minimatch } from 'minimatch';
+
+const {
+	values: options,
+	positionals: [root],
+} = parseArgs({
+	options: {
+		help: { short: 'h', type: 'boolean', default: false },
+		ignore: { short: 'i', type: 'string', multiple: true, default: [] },
+		output: { short: 'o', type: 'string', default: 'index.json' },
+		quiet: { short: 'q', type: 'boolean', default: false },
+		verbose: { type: 'boolean', default: false },
+	},
+	allowPositionals: true,
+	strict: true,
+});
+
+if (options.help) {
+	console.log(`make-index <path> [...options]
+	path: The path to create a listing for
+
+	options:
+		--help, -h				Outputs this help message
+		--quiet, -q 			Do not output messages about individual files
+		--verbose				Output verbose messages
+
+		--output, -o <path>		Path to the output file. Defaults to listing.
+		--ignore, -i <pattern>	Ignores files which match the glob <pattern>. Can be passed multiple times.
+	`);
+	process.exit();
+}
+
+if (options.quiet && options.verbose) {
+	console.log('Can not use both --verbose and --quiet.');
+	process.exit();
+}
+
+function pathToPosix(path) {
+	return path.replaceAll('\\', '/');
+}
+
+const colors = {
+	reset: 0,
+	black: 30,
+	red: 31,
+	green: 32,
+	yellow: 33,
+	blue: 34,
+	magenta: 35,
+	cyan: 36,
+	white: 37,
+	bright_black: 90,
+	bright_red: 91,
+	bright_green: 92,
+	bright_yellow: 93,
+	bright_blue: 94,
+	bright_magenta: 95,
+	bright_cyan: 96,
+	bright_white: 97,
+};
+
+function color(color, text) {
+	return `\x1b[${colors[color]}m${text}\x1b[0m`;
+}
+
+function makeListing(path, seen = new Set()) {
+	try {
+		const stats = statSync(path);
+
+		if (stats.isFile()) {
+			return null;
+		}
+
+		let entries = {};
+		for (const file of readdirSync(path)) {
+			const full = join(path, file);
+			if (options.ignore.some(pattern => minimatch(full, pattern))) {
+				if (!options.quiet) console.log(`${color('yellow', 'skip')} ${full}`);
+				continue;
+			}
+
+			entries[file] = makeListing(full, seen);
+		}
+		return entries;
+	} catch (e) {
+		if (!options.quiet) {
+			console.log(`${color('red', 'fail')} ${path}: ${e.message}`);
+		}
+	}
+}
+
+const listing = makeListing(pathToPosix(root));
+if (!options.quiet) console.log('Generated listing for ' + pathToPosix(resolve(root)));
+
+writeFileSync(options.output, JSON.stringify(listing));

package/dist/backends/index.d.ts

@@ -1,10 +0,0 @@
-import { AsyncMirror } from './AsyncMirror.js';
-import { InMemory } from './InMemory.js';
-import { Overlay } from './Overlay.js';
-import { Backend } from './backend.js';
-export declare const backends: {
-    [backend: string]: Backend;
-};
-export default backends;
-export { AsyncMirror, InMemory, Overlay };
-export declare function registerBackend(..._backends: Backend[]): void;

package/dist/backends/index.js

@@ -1,12 +0,0 @@
-import { AsyncMirror } from './AsyncMirror.js';
-import { InMemory } from './InMemory.js';
-import { Overlay } from './Overlay.js';
-export const backends = {};
-export default backends;
-export { AsyncMirror, InMemory, Overlay };
-export function registerBackend(..._backends) {
-    for (const backend of _backends) {
-        backends[backend.name] = backend;
-    }
-}
-registerBackend(AsyncMirror, InMemory, Overlay);