more reorg as a monorepo

sagemathinc · Aug 25, 2023 · 8fa2dd2 · 8fa2dd2
1 parent 7320dd7
commit 8fa2dd2
Show file tree

Hide file tree

Showing 44 changed files with 21 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ and in another terminal:
 Welcome to Node.js v16.20.1.
 Type ".help" for more information.
 > // serve HOME and mount it at /tmp/mnt all over websocketfs
-> z = await require('.').bind(process.env.HOME,'/tmp/mnt'); null
+> await require('./websocketfs').bind(process.env.HOME,'/tmp/mnt'); null
 ```
 
 Then in another terminal, type `ls /tmp/mnt`:
@@ -101,6 +101,12 @@ without FUSE.
 **MacOS?:** I don't know if it will work or not. FUSE is weird on MacOS due to security constraints and commercial interests.
 _I'm developing this for Linux._
 
+### Installing just the sftp protocol
+
+You can install the module `websocket-sftp` alone, which doesn't depend
+on fuse-native, and provides the client and server for communicating over
+sftp, but not the FUSE bindings.
+
 ## Background
 
 I wish there was something like sshfs, but entirely over a websocket that doesn't use ssh at all. I found this [ancient and forgotten project from 8 years ago](https://github.com/lukaaash/vfs/tree/master), then rewrote it to not use sshfs at all and instead use libfuse2 bindings to nodejs. It is going to be like what sshfs provides, except entirely 100% using Typescript/Nodejs \+ a websocket for the transport and fuse bindings. This could also be extended to work in browser \(for WebAssembly with WASI\), providing basically "sshfs for the browser". The real work to make this possible is in [this also ancient forgotten implementation of the entire sftp protocol](https://github.com/lukaaash/sftp-ws) in Typescript from 8 years ago, as explained in [this blogpost](https://lukas.pokorny.eu/sftp-over-websockets/).

diff --git a/package.json b/package.json
@@ -0,0 +1,8 @@
+{
+  "scripts": {
+    "build": "pnpm --filter=* build",
+    "test": "pnpm --filter=* test",
+    "clean": "pnpm --filter=* clean",
+    "test-all": "pnpm --filter=* clean && pnpm install && pnpm --filter=* build && pnpm --filter=* test"
+  }
+}
diff --git a/packages/pnpm-workspace.yaml b/packages/pnpm-workspace.yaml
diff --git a/packages/pnpm-lock.yaml → pnpm-lock.yaml b/packages/pnpm-lock.yaml → pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
@@ -0,0 +1,3 @@
+packages:
+  - websocketfs
+  - websocket-sftp
diff --git a/packages/tsconfig.json → tsconfig.json b/packages/tsconfig.json → tsconfig.json
diff --git a/packages/websocket-sftp/README.md → websocket-sftp/README.md b/packages/websocket-sftp/README.md → websocket-sftp/README.md
diff --git a/...ages/websocket-sftp/lib/channel-stream.ts → websocket-sftp/lib/channel-stream.ts b/...ages/websocket-sftp/lib/channel-stream.ts → websocket-sftp/lib/channel-stream.ts
diff --git a/packages/websocket-sftp/lib/channel-ws.ts → websocket-sftp/lib/channel-ws.ts b/packages/websocket-sftp/lib/channel-ws.ts → websocket-sftp/lib/channel-ws.ts
diff --git a/packages/websocket-sftp/lib/channel.ts → websocket-sftp/lib/channel.ts b/packages/websocket-sftp/lib/channel.ts → websocket-sftp/lib/channel.ts
diff --git a/packages/websocket-sftp/lib/charsets.ts → websocket-sftp/lib/charsets.ts b/packages/websocket-sftp/lib/charsets.ts → websocket-sftp/lib/charsets.ts
diff --git a/packages/websocket-sftp/lib/fs-api.ts → websocket-sftp/lib/fs-api.ts b/packages/websocket-sftp/lib/fs-api.ts → websocket-sftp/lib/fs-api.ts
diff --git a/packages/websocket-sftp/lib/fs-glob.ts → websocket-sftp/lib/fs-glob.ts b/packages/websocket-sftp/lib/fs-glob.ts → websocket-sftp/lib/fs-glob.ts
diff --git a/packages/websocket-sftp/lib/fs-local.ts → websocket-sftp/lib/fs-local.ts b/packages/websocket-sftp/lib/fs-local.ts → websocket-sftp/lib/fs-local.ts
diff --git a/packages/websocket-sftp/lib/fs-misc.ts → websocket-sftp/lib/fs-misc.ts b/packages/websocket-sftp/lib/fs-misc.ts → websocket-sftp/lib/fs-misc.ts
diff --git a/packages/websocket-sftp/lib/fs-plus.ts → websocket-sftp/lib/fs-plus.ts b/packages/websocket-sftp/lib/fs-plus.ts → websocket-sftp/lib/fs-plus.ts
diff --git a/packages/websocket-sftp/lib/fs-safe.ts → websocket-sftp/lib/fs-safe.ts b/packages/websocket-sftp/lib/fs-safe.ts → websocket-sftp/lib/fs-safe.ts
diff --git a/packages/websocket-sftp/lib/fs-sources.ts → websocket-sftp/lib/fs-sources.ts b/packages/websocket-sftp/lib/fs-sources.ts → websocket-sftp/lib/fs-sources.ts
diff --git a/packages/websocket-sftp/lib/fs-targets.ts → websocket-sftp/lib/fs-targets.ts b/packages/websocket-sftp/lib/fs-targets.ts → websocket-sftp/lib/fs-targets.ts
diff --git a/packages/websocket-sftp/lib/sftp-client.ts → websocket-sftp/lib/sftp-client.ts b/packages/websocket-sftp/lib/sftp-client.ts → websocket-sftp/lib/sftp-client.ts
diff --git a/packages/websocket-sftp/lib/sftp-enums.ts → websocket-sftp/lib/sftp-enums.ts b/packages/websocket-sftp/lib/sftp-enums.ts → websocket-sftp/lib/sftp-enums.ts
diff --git a/packages/websocket-sftp/lib/sftp-misc.ts → websocket-sftp/lib/sftp-misc.ts b/packages/websocket-sftp/lib/sftp-misc.ts → websocket-sftp/lib/sftp-misc.ts
diff --git a/packages/websocket-sftp/lib/sftp-packet.ts → websocket-sftp/lib/sftp-packet.ts b/packages/websocket-sftp/lib/sftp-packet.ts → websocket-sftp/lib/sftp-packet.ts
diff --git a/packages/websocket-sftp/lib/sftp-server.ts → websocket-sftp/lib/sftp-server.ts b/packages/websocket-sftp/lib/sftp-server.ts → websocket-sftp/lib/sftp-server.ts
diff --git a/packages/websocket-sftp/lib/sftp.ts → websocket-sftp/lib/sftp.ts b/packages/websocket-sftp/lib/sftp.ts → websocket-sftp/lib/sftp.ts
diff --git a/.../websocket-sftp/lib/tests/charset.test.ts → websocket-sftp/lib/tests/charset.test.ts b/.../websocket-sftp/lib/tests/charset.test.ts → websocket-sftp/lib/tests/charset.test.ts
diff --git a/...ges/websocket-sftp/lib/tests/core.test.ts → websocket-sftp/lib/tests/core.test.ts b/...ges/websocket-sftp/lib/tests/core.test.ts → websocket-sftp/lib/tests/core.test.ts
diff --git a/...s/websocket-sftp/lib/tests/server.test.ts → websocket-sftp/lib/tests/server.test.ts b/...s/websocket-sftp/lib/tests/server.test.ts → websocket-sftp/lib/tests/server.test.ts
diff --git a/packages/websocket-sftp/lib/util.ts → websocket-sftp/lib/util.ts b/packages/websocket-sftp/lib/util.ts → websocket-sftp/lib/util.ts
diff --git a/packages/websocket-sftp/package.json → websocket-sftp/package.json b/packages/websocket-sftp/package.json → websocket-sftp/package.json
@@ -1,6 +1,6 @@
 {
   "name": "websocket-sftp",
-  "version": "0.1.0",
+  "version": "0.5.0",
   "description": "The sftp protocol, over a WebSocket",
   "exports": {
     ".": "./dist/lib/sftp.js",

diff --git a/packages/websocket-sftp/tsconfig.json → websocket-sftp/tsconfig.json b/packages/websocket-sftp/tsconfig.json → websocket-sftp/tsconfig.json
diff --git a/packages/websocketfs/bin/websocketfs-bind → websocketfs/bin/websocketfs-bind b/packages/websocketfs/bin/websocketfs-bind → websocketfs/bin/websocketfs-bind
diff --git a/packages/websocketfs/lib/bind.ts → websocketfs/lib/bind.ts b/packages/websocketfs/lib/bind.ts → websocketfs/lib/bind.ts
diff --git a/packages/websocketfs/lib/flags.ts → websocketfs/lib/flags.ts b/packages/websocketfs/lib/flags.ts → websocketfs/lib/flags.ts
diff --git a/packages/websocketfs/lib/index.ts → websocketfs/lib/index.ts b/packages/websocketfs/lib/index.ts → websocketfs/lib/index.ts
diff --git a/packages/websocketfs/lib/mount.ts → websocketfs/lib/mount.ts b/packages/websocketfs/lib/mount.ts → websocketfs/lib/mount.ts
diff --git a/packages/websocketfs/lib/serve.ts → websocketfs/lib/serve.ts b/packages/websocketfs/lib/serve.ts → websocketfs/lib/serve.ts
diff --git a/packages/websocketfs/lib/sftp-fuse.ts → websocketfs/lib/sftp-fuse.ts b/packages/websocketfs/lib/sftp-fuse.ts → websocketfs/lib/sftp-fuse.ts
diff --git a/packages/websocketfs/lib/tests/fs.test.ts → websocketfs/lib/tests/fs.test.ts b/packages/websocketfs/lib/tests/fs.test.ts → websocketfs/lib/tests/fs.test.ts
diff --git a/...s/websocketfs/lib/tests/sftp-fuse.test.ts → websocketfs/lib/tests/sftp-fuse.test.ts b/...s/websocketfs/lib/tests/sftp-fuse.test.ts → websocketfs/lib/tests/sftp-fuse.test.ts
diff --git a/...ages/websocketfs/lib/tests/stress.test.ts → websocketfs/lib/tests/stress.test.ts b/...ages/websocketfs/lib/tests/stress.test.ts → websocketfs/lib/tests/stress.test.ts
diff --git a/packages/websocketfs/lib/util.ts → websocketfs/lib/util.ts b/packages/websocketfs/lib/util.ts → websocketfs/lib/util.ts
diff --git a/packages/websocketfs/package.json → websocketfs/package.json b/packages/websocketfs/package.json → websocketfs/package.json
diff --git a/packages/websocketfs/tsconfig.json → websocketfs/tsconfig.json b/packages/websocketfs/tsconfig.json → websocketfs/tsconfig.json