Merge pull request #1232 from streamich/finalize-monorepo

Finalize monorepo

Author: streamich

AGENTS.md

@@ -2,3 +2,4 @@
 - Use Angular style commits, e.g `feat: implemented xyz`.
 - Make sure tests (`yarn test`) pass.
 - In the end, make sure linter and formatter pass.
+- Do not every Git commit or push without explicit review by USER.

CONTRIBUTING.md

@@ -5,8 +5,8 @@ Yarn workspaces monorepo with packages:
 ## Packages
 
 - **memfs** - In-memory file system with Node.js `fs` API
-- **node-fs-dependencies** - Node.js standard library polyfills (fs, events, stream)
-- **node-fs-utils** - Utility types and helpers for `fs` operations
+- **fs-node-builtins** - Node.js standard library polyfills (fs, events, stream)
+- **fs-node-utils** - Utility types and helpers for `fs` operations
 
 ## Common Commands
 

packages/node-fs-dependencies/LICENSE packages/fs-core/LICENSEpackages/node-fs-dependencies/LICENSE renamed to packages/fs-core/LICENSE

@@ -0,0 +1,34 @@
+# @jsonjoy.com/fs-core
+
+Core filesystem primitives for building in-memory and virtual filesystems.
+
+## Overview
+
+This package provides the core data structures for representing a virtual filesystem:
+
+- **Node** - Represents an i-node (index node), containing file data and metadata
+- **Link** - Represents a hard link pointing to a Node
+- **File** - Represents an open file descriptor
+- **Superblock** - The root of a virtual filesystem, managing nodes and links
+
+## Installation
+
+```bash
+npm install @jsonjoy.com/fs-core
+```
+
+## Usage
+
+```typescript
+import { Superblock, DirectoryJSON } from '@jsonjoy.com/fs-core';
+
+// Create a new filesystem
+const fs = new Superblock();
+
+// Or create from a JSON structure
+const json: DirectoryJSON = {
+  '/file.txt': 'Hello, World!',
+  '/dir/nested.txt': 'Nested content',
+};
+const fs = Superblock.fromJSON(json);
+```

packages/fs-core/README.md

@@ -0,0 +1,87 @@
+{
+  "name": "@jsonjoy.com/fs-core",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "4.55.0",
+  "description": "Core filesystem primitives: Node, Link, File, Superblock",
+  "author": {
+    "name": "streamich",
+    "url": "https://github.com/streamich"
+  },
+  "homepage": "https://github.com/streamich/memfs/tree/master/packages/fs-core",
+  "repository": "streamich/memfs",
+  "license": "Apache-2.0",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/streamich"
+  },
+  "keywords": [
+    "node",
+    "fs",
+    "filesystem",
+    "inode",
+    "link",
+    "file",
+    "superblock",
+    "virtual",
+    "memory"
+  ],
+  "engines": {
+    "node": ">=10.0"
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "LICENSE",
+    "lib/"
+  ],
+  "scripts": {
+    "clean": "rimraf lib typedocs coverage gh-pages yarn-error.log",
+    "build": "tsc --project tsconfig.build.json --module commonjs --target es2020 --outDir lib",
+    "jest": "node -r ts-node/register ./node_modules/.bin/jest",
+    "test": "jest --maxWorkers 7",
+    "test:ci": "yarn jest --maxWorkers 3 --no-cache",
+    "coverage": "yarn test --collectCoverage",
+    "typedoc": "typedoc",
+    "typecheck": "tsc -p ."
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "moduleFileExtensions": [
+      "ts",
+      "js",
+      "tsx"
+    ],
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+    "transformIgnorePatterns": [
+      ".*/node_modules/.*"
+    ],
+    "testRegex": ".*/(__tests__|__jest__|demo)/.*\\.(test|spec)\\.tsx?$",
+    "rootDir": ".",
+    "testPathIgnorePatterns": [
+      "node_modules"
+    ]
+  },
+  "devDependencies": {
+    "@types/jest": "^29.0.0",
+    "@types/node": "^20.0.0",
+    "jest": "^29.0.0",
+    "rimraf": "^5.0.0",
+    "ts-jest": "^29.4.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "tslib": "2"
+  },
+  "dependencies": {
+    "@jsonjoy.com/fs-node-builtins": "workspace:*",
+    "@jsonjoy.com/fs-node-utils": "workspace:*",
+    "thingies": "^2.5.0"
+  }
+}

packages/node-fs-dependencies/SECURITY.md packages/fs-core/SECURITY.mdpackages/node-fs-dependencies/SECURITY.md renamed to packages/fs-core/SECURITY.md

@@ -1,5 +1,5 @@
-import { constants } from '../constants';
-import { Buffer } from '../vendor/node/internal/buffer';
+import { constants } from '@jsonjoy.com/fs-node-utils';
+import { Buffer } from '@jsonjoy.com/fs-node-builtins/lib/internal/buffer';
 import type { Link } from './Link';
 import type { Node } from './Node';
 

packages/fs-core/package.json

@@ -1,4 +1,4 @@
-import { constants, PATH } from '../constants';
+import { constants, PATH } from '@jsonjoy.com/fs-node-utils';
 import { FanOut } from 'thingies/lib/fanout';
 import type { Node } from './Node';
 import type { Superblock } from './Superblock';

packages/memfs/src/core/File.ts packages/fs-core/src/File.tspackages/memfs/src/core/File.ts renamed to packages/fs-core/src/File.ts

@@ -1,7 +1,7 @@
 import { FanOut } from 'thingies/lib/fanout';
-import process from '../process';
-import { Buffer, bufferAllocUnsafe, bufferFrom } from '../vendor/node/internal/buffer';
-import { constants, S } from '../constants';
+import process from './process';
+import { Buffer, bufferAllocUnsafe, bufferFrom } from '@jsonjoy.com/fs-node-builtins/lib/internal/buffer';
+import { constants, S } from '@jsonjoy.com/fs-node-utils';
 
 export type NodeEventModify = [type: 'modify'];
 

packages/memfs/src/core/Link.ts packages/fs-core/src/Link.tspackages/memfs/src/core/Link.ts renamed to packages/fs-core/src/Link.ts

@@ -1,15 +1,23 @@
-import { sep, relative, join, dirname, isAbsolute, basename, posix } from '../vendor/node/path';
+import { sep, relative, join, dirname, isAbsolute, basename, posix } from '@jsonjoy.com/fs-node-builtins/lib/path';
 import { Node } from './Node';
 import { Link } from './Link';
 import { File } from './File';
-import { Buffer } from '../vendor/node/internal/buffer';
-import process from '../process';
-import { constants } from '../constants';
-import { ERRSTR, FLAGS, MODE } from '../node/constants';
-import { pathToFilename, createError, createStatError } from '../node/util';
-import { dataToBuffer, filenameToSteps, isFd, resolve, validateFd } from './util';
+import { Buffer } from '@jsonjoy.com/fs-node-builtins/lib/internal/buffer';
+import process from './process';
+import { constants } from '@jsonjoy.com/fs-node-utils';
+import { ERRSTR, FLAGS, MODE } from '@jsonjoy.com/fs-node-utils';
+import {
+  pathToFilename,
+  createError,
+  createStatError,
+  dataToBuffer,
+  filenameToSteps,
+  isFd,
+  resolve,
+  validateFd,
+} from './util';
 import { DirectoryJSON, flattenJSON, NestedDirectoryJSON } from './json';
-import type { PathLike } from '../node/types/misc';
+import type { PathLike } from '@jsonjoy.com/fs-node-utils/lib/types/misc';
 import { ERROR_CODE } from './constants';
 import { TFileId, StatError } from './types';
 import { Err, Ok, Result } from './result';