@zenfs/core 1.0.0 → 1.0.2

package/dist/emulation/async.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import { Buffer } from 'buffer';
 import type * as fs from 'node:fs';
 import type { FileContents } from '../filesystem.js';

package/dist/emulation/promises.d.ts

@@ -5,6 +5,7 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import { Buffer } from 'buffer';
 import type * as fs from 'node:fs';
 import type * as promises from 'node:fs/promises';

package/dist/emulation/streams.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import type * as Node from 'fs';
 import { Readable, Writable } from 'readable-stream';
 import type { Callback } from '../utils.js';

package/dist/emulation/sync.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import { Buffer } from 'buffer';
 import type * as fs from 'node:fs';
 import type { FileContents } from '../filesystem.js';

package/dist/emulation/watchers.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
 import { EventEmitter } from 'eventemitter3';
 import type { EventEmitter as NodeEventEmitter } from 'node:events';
 import type * as fs from 'node:fs';

package/eslint.shared.js

@@ -1,53 +1,63 @@
-/*
-	Shared eslint rules
-*/
-
+/* Shared eslint rules */
 import eslint from '@eslint/js';
 import stylistic from '@stylistic/eslint-plugin';
 import globals from 'globals';
 import tseslint from 'typescript-eslint';
 
-export default {
-	name: 'ZenFS',
-	extends: [eslint.configs.recommended, ...tseslint.configs.recommendedTypeChecked],
-	files: ['src/**/*.ts', 'tests/**/*.ts'],
-	languageOptions: {
-		globals: { ...globals.browser, ...globals.node },
-		ecmaVersion: 'latest',
-		sourceType: 'module',
+export default [
+	{
+		name: 'ZenFS',
+		extends: [eslint.configs.recommended, ...tseslint.configs.recommendedTypeChecked],
+		files: ['src/**/*.ts', 'tests/**/*.ts'],
+		languageOptions: {
+			globals: { ...globals.browser, ...globals.node },
+			ecmaVersion: 'latest',
+			sourceType: 'module',
+		},
+		plugins: { stylistic },
+		rules: {
+			'no-useless-escape': 'warn',
+			'stylistic/no-mixed-spaces-and-tabs': 'warn',
+			'no-unreachable': 'warn',
+			'stylistic/no-extra-semi': 'warn',
+			'no-fallthrough': 'warn',
+			'no-empty': 'warn',
+			'no-case-declarations': 'warn',
+			'prefer-const': 'warn',
+			'prefer-rest-params': 'warn',
+			'prefer-spread': 'warn',
+			'no-unused-vars': 'off',
+			'@typescript-eslint/no-unused-vars': 'warn',
+			'@typescript-eslint/no-inferrable-types': 'off',
+			'@typescript-eslint/no-this-alias': 'off',
+			'@typescript-eslint/no-unsafe-function-type': 'warn',
+			'@typescript-eslint/no-wrapper-object-types': 'warn',
+			'@typescript-eslint/triple-slash-reference': 'warn',
+			'@typescript-eslint/no-non-null-assertion': 'off',
+			'@typescript-eslint/no-namespace': 'warn',
+			'@typescript-eslint/prefer-as-const': 'warn',
+			'@typescript-eslint/no-explicit-any': 'warn',
+			'@typescript-eslint/consistent-type-assertions': 'warn',
+			'@typescript-eslint/consistent-type-imports': 'warn',
+			'@typescript-eslint/no-unnecessary-type-assertion': 'warn',
+			'@typescript-eslint/require-await': 'warn',
+			'@typescript-eslint/no-unsafe-return': 'warn',
+			'@typescript-eslint/no-unsafe-assignment': 'warn',
+			'@typescript-eslint/no-unsafe-member-access': 'warn',
+			'@typescript-eslint/no-unsafe-argument': 'warn',
+			'@typescript-eslint/no-redundant-type-constituents': 'warn',
+			'@typescript-eslint/no-unsafe-call': 'warn',
+		},
 	},
-	plugins: { stylistic },
-	rules: {
-		'no-useless-escape': 'warn',
-		'stylistic/no-mixed-spaces-and-tabs': 'warn',
-		'no-unreachable': 'warn',
-		'stylistic/no-extra-semi': 'warn',
-		'no-fallthrough': 'warn',
-		'no-empty': 'warn',
-		'no-case-declarations': 'warn',
-		'prefer-const': 'warn',
-		'prefer-rest-params': 'warn',
-		'prefer-spread': 'warn',
-		'no-unused-vars': 'off',
-		'@typescript-eslint/no-unused-vars': 'warn',
-		'@typescript-eslint/no-inferrable-types': 'off',
-		'@typescript-eslint/no-this-alias': 'off',
-		'@typescript-eslint/no-unsafe-function-type': 'warn',
-		'@typescript-eslint/no-wrapper-object-types': 'warn',
-		'@typescript-eslint/triple-slash-reference': 'warn',
-		'@typescript-eslint/no-non-null-assertion': 'off',
-		'@typescript-eslint/no-namespace': 'warn',
-		'@typescript-eslint/prefer-as-const': 'warn',
-		'@typescript-eslint/no-explicit-any': 'warn',
-		'@typescript-eslint/consistent-type-assertions': 'warn',
-		'@typescript-eslint/consistent-type-imports': 'warn',
-		'@typescript-eslint/no-unnecessary-type-assertion': 'warn',
-		'@typescript-eslint/require-await': 'warn',
-		'@typescript-eslint/no-unsafe-return': 'warn',
-		'@typescript-eslint/no-unsafe-assignment': 'warn',
-		'@typescript-eslint/no-unsafe-member-access': 'warn',
-		'@typescript-eslint/no-unsafe-argument': 'warn',
-		'@typescript-eslint/no-redundant-type-constituents': 'warn',
-		'@typescript-eslint/no-unsafe-call': 'warn',
+	{
+		name: 'Tests overrides',
+		files: ['tests/**/*.ts'],
+		rules: {
+			'@typescript-eslint/no-unsafe-member-access': 'off',
+			'@typescript-eslint/no-unsafe-argument': 'off',
+			'@typescript-eslint/no-unsafe-assignment': 'off',
+			'@typescript-eslint/no-floating-promises': 'off',
+			'@typescript-eslint/no-explicit-any': 'off',
+		},
 	},
-};
+];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "1.0.0",
+	"version": "1.0.2",
 	"description": "A filesystem, anywhere",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -41,13 +41,14 @@
 		".": "./dist/index.js",
 		"./*": "./dist/*",
 		"./promises": "./dist/emulation/promises.js",
-		"./mixins": "./dist/mixins/index.js"
+		"./mixins": "./dist/mixins/index.js",
+		"./eslint": "./eslint.shared.js"
 	},
 	"scripts": {
 		"format": "prettier --write .",
 		"format:check": "prettier --check .",
 		"lint": "tsc -p tsconfig.json --noEmit && eslint src tests",
-		"test": "tsc -p tests/tsconfig.json && cross-env NODE_OPTIONS=--experimental-vm-modules npx jest",
+		"test": "tsx --test --experimental-test-coverage",
 		"build": "node scripts/build.js --globalName=ZenFS --entry src/index.ts",
 		"build:docs": "typedoc",
 		"dev": "npm run build -- --watch",
@@ -59,29 +60,25 @@
 		]
 	},
 	"dependencies": {
-		"@types/node": "^20.12.12",
+		"@types/node": "^20.16.10",
 		"@types/readable-stream": "^4.0.10",
 		"buffer": "^6.0.3",
 		"eventemitter3": "^5.0.1",
 		"minimatch": "^9.0.3",
 		"readable-stream": "^4.5.2",
-		"utilium": ">=0.4.0"
+		"utilium": "^0.7.0"
 	},
 	"devDependencies": {
 		"@eslint/js": "^9.8.0",
 		"@fal-works/esbuild-plugin-global-externals": "^2.1.2",
-		"@jest/globals": "^29.5.0",
 		"@stylistic/eslint-plugin": "^2.6.1",
 		"@types/eslint__js": "^8.42.3",
-		"@types/jest": "^29.5.1",
-		"cross-env": "^7.0.3",
 		"esbuild": "^0.21.0",
 		"eslint": "^9.8.0",
 		"globals": "^15.9.0",
-		"jest": "^29.7.0",
 		"lint-staged": "^15.2.7",
 		"prettier": "^3.2.5",
-		"ts-jest": "^29.1.5",
+		"tsx": "^4.19.1",
 		"typedoc": "^0.25.13",
 		"typedoc-plugin-remove-references": "^0.0.6",
 		"typescript": "^5.4.0",

package/src/backends/fetch.ts

@@ -94,7 +94,7 @@ export class FetchFS extends IndexFS {
 		}
 	}
 
-	constructor({ index = 'index.json', baseUrl = '' }: FetchOptions) {
+	public constructor({ index = 'index.json', baseUrl = '' }: FetchOptions) {
 		super(typeof index != 'string' ? index : fetchFile<IndexData>(index, 'json'));
 
 		// prefix url must end in a directory separator.

package/src/backends/file_index.ts

@@ -118,7 +118,7 @@ export abstract class IndexFS extends Readonly(FileSystem) {
 		this._isInitialized = true;
 	}
 
-	constructor(private indexData: IndexData | Promise<IndexData>) {
+	public constructor(private indexData: IndexData | Promise<IndexData>) {
 		super();
 	}
 

package/src/backends/overlay.ts

@@ -57,7 +57,7 @@ export class UnmutexedOverlayFS extends FileSystem {
 
 	private _ready: Promise<void>;
 
-	constructor({ writable, readable }: OverlayOptions) {
+	public constructor({ writable, readable }: OverlayOptions) {
 		super();
 		this.writable = writable;
 		this.readable = readable;

package/src/backends/port/fs.ts

@@ -21,7 +21,7 @@ interface FileRequest<TMethod extends FileMethod = FileMethod> extends RPC.Reque
 }
 
 export class PortFile extends File {
-	constructor(
+	public constructor(
 		public fs: PortFS,
 		public readonly fd: number,
 		path: string,
@@ -194,27 +194,35 @@ export class PortFS extends Async(FileSystem) {
 	public sync(path: string, data: Uint8Array, stats: Readonly<Stats>): Promise<void> {
 		return this.rpc('sync', path, data, stats);
 	}
+
 	public openFile(path: string, flag: string): Promise<File> {
 		return this.rpc('openFile', path, flag);
 	}
+
 	public createFile(path: string, flag: string, mode: number): Promise<File> {
 		return this.rpc('createFile', path, flag, mode);
 	}
+
 	public unlink(path: string): Promise<void> {
 		return this.rpc('unlink', path);
 	}
+
 	public rmdir(path: string): Promise<void> {
 		return this.rpc('rmdir', path);
 	}
+
 	public mkdir(path: string, mode: number): Promise<void> {
 		return this.rpc('mkdir', path, mode);
 	}
+
 	public readdir(path: string): Promise<string[]> {
 		return this.rpc('readdir', path);
 	}
+
 	public exists(path: string): Promise<boolean> {
 		return this.rpc('exists', path);
 	}
+
 	public link(srcpath: string, dstpath: string): Promise<void> {
 		return this.rpc('link', srcpath, dstpath);
 	}

package/src/backends/store/fs.ts

@@ -30,7 +30,7 @@ export class StoreFS<T extends Store = Store> extends FileSystem {
 		this._initialized = true;
 	}
 
-	constructor(protected store: T) {
+	public constructor(protected store: T) {
 		super();
 	}
 

package/src/backends/store/simple.ts

@@ -82,10 +82,6 @@ export class SimpleTransaction extends SyncTransaction<SimpleSyncStore> {
 
 	protected declare store: SimpleSyncStore;
 
-	constructor(store: SimpleSyncStore) {
-		super(store);
-	}
-
 	public getSync(ino: Ino): Uint8Array {
 		const val = this.store.get(ino);
 		this.stashOldValue(ino, val);

package/src/backends/store/store.ts

@@ -36,7 +36,7 @@ export interface Store {
  * A transaction for a store.
  */
 export abstract class Transaction<T extends Store = Store> {
-	constructor(protected store: T) {}
+	public constructor(protected store: T) {}
 
 	/**
 	 * Whether the transaction was commited or aborted
@@ -134,15 +134,19 @@ export abstract class SyncTransaction<T extends Store = Store> extends Transacti
 	public async get(ino: Ino): Promise<Uint8Array> {
 		return this.getSync(ino);
 	}
+
 	public async set(ino: bigint, data: Uint8Array): Promise<void> {
 		return this.setSync(ino, data);
 	}
+
 	public async remove(ino: Ino): Promise<void> {
 		return this.removeSync(ino);
 	}
+
 	public async commit(): Promise<void> {
 		return this.commitSync();
 	}
+
 	public async abort(): Promise<void> {
 		return this.abortSync();
 	}

package/src/emulation/dir.ts

@@ -11,7 +11,7 @@ export class Dirent implements _Dirent {
 		return basename(this.path);
 	}
 
-	constructor(
+	public constructor(
 		public path: string,
 		protected stats: Stats
 	) {}

package/src/error.ts

@@ -272,7 +272,7 @@ export class ErrnoError extends Error implements NodeJS.ErrnoException {
 	 * @param type The type of the error.
 	 * @param message A descriptive error message.
 	 */
-	constructor(
+	public constructor(
 		public errno: Errno,
 		message: string = errorMessages[errno],
 		public path?: string,

package/src/file.ts

@@ -146,7 +146,7 @@ export function isExclusive(flag: string): boolean {
 }
 
 export abstract class File {
-	constructor(
+	public constructor(
 		/**
 		 * @internal
 		 * The file system that created the file
@@ -359,7 +359,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
 	 *   contents of the file. PreloadFile will mutate this buffer. If not
 	 *   specified, we assume it is a new file.
 	 */
-	constructor(
+	public constructor(
 		/**
 		 * The file system that created the file.
 		 * @internal
@@ -765,7 +765,7 @@ export class PreloadFile<FS extends FileSystem> extends File {
  * For the filesystems which do not sync to anything..
  */
 export class NoSyncFile<T extends FileSystem> extends PreloadFile<T> {
-	constructor(fs: T, path: string, flag: string, stats: Stats, contents?: Uint8Array) {
+	public constructor(fs: T, path: string, flag: string, stats: Stats, contents?: Uint8Array) {
 		super(fs, path, flag, stats, contents);
 	}
 	/**

package/src/inode.ts

@@ -81,7 +81,7 @@ export class Inode implements StatsLike {
 
 	protected view: DataView;
 
-	constructor(buffer?: ArrayBufferLike) {
+	public constructor(buffer?: ArrayBufferLike) {
 		const setDefaults = !buffer;
 		buffer ??= new ArrayBuffer(offsets.end);
 		if (buffer?.byteLength < offsets.end) {

package/src/stats.ts

@@ -174,7 +174,7 @@ export abstract class StatsCommon<T extends number | bigint> implements Node.Sta
 	/**
 	 * Creates a new stats instance from a stats-like object. Can be used to copy stats (note)
 	 */
-	constructor({ atimeMs, mtimeMs, ctimeMs, birthtimeMs, uid, gid, size, mode, ino }: Partial<StatsLike> = {}) {
+	public constructor({ atimeMs, mtimeMs, ctimeMs, birthtimeMs, uid, gid, size, mode, ino }: Partial<StatsLike> = {}) {
 		const now = Date.now();
 		this.atimeMs = this._convert(atimeMs ?? now);
 		this.mtimeMs = this._convert(mtimeMs ?? now);
@@ -290,12 +290,15 @@ export abstract class StatsCommon<T extends number | bigint> implements Node.Sta
 	public get atimeNs(): bigint {
 		return BigInt(this.atimeMs) * 1000n;
 	}
+
 	public get mtimeNs(): bigint {
 		return BigInt(this.mtimeMs) * 1000n;
 	}
+
 	public get ctimeNs(): bigint {
 		return BigInt(this.ctimeMs) * 1000n;
 	}
+
 	public get birthtimeNs(): bigint {
 		return BigInt(this.birthtimeMs) * 1000n;
 	}