.github/workflows/checks.yml

@@ -110,5 +110,5 @@ jobs:
       - name: Release
         run: npx semantic-release
         env:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/gh-pages.yml

@@ -0,0 +1,28 @@
+name: GitHub Pages
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  gh-pages:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20.x]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: yarn
+      - run: yarn install --frozen-lockfile
+      - run: yarn typedoc
+      - run: yarn coverage
+      - run: yarn build:pages
+      - name: Publish to gh-pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./gh-pages

.gitignore

@@ -2,9 +2,10 @@
 node_modules
 /.idea
 .nyc_output
-coverage
+/coverage/
 package-lock.json
 /lib/
-/gh-pages
+/gh-pages/
 /dist
 /fs-test/
+/typedocs/

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [4.9.1](https://github.com/streamich/memfs/compare/v4.9.0...v4.9.1) (2024-04-27)
+
+
+### Bug Fixes
+
+* 🐛 use latest json-pack implementation ([de54ab5](https://github.com/streamich/memfs/commit/de54ab53a5df3b857975094ce4c59d760240a6d6))
+
 # [4.9.0](https://github.com/streamich/memfs/compare/v4.8.2...v4.9.0) (2024-04-27)
 
 

README.md

@@ -15,15 +15,18 @@ JavaScript file system utilities for Node.js and browser.
 npm i memfs
 ```
 
-## Docs
-
-- [In-memory Node.js `fs` API](./docs/node/index.md)
-- `experimental` [`fs` to File System Access API adapter](./docs/fsa/fs-to-fsa.md)
-- `experimental` [File System Access API to `fs` adapter](./docs/fsa/fsa-to-fs.md)
-- `experimental` [`crudfs` a CRUD-like file system abstraction](./docs/crudfs/index.md)
-- `experimental` [`casfs` Content Addressable Storage file system abstraction](./docs/casfs/index.md)
-- [Directory `snapshot` utility](./docs/snapshot/index.md)
-- [`print` directory tree to terminal](./docs/print/index.md)
+## Resources
+
+- Documentation
+  - [In-memory Node.js `fs` API](./docs/node/index.md)
+  - `experimental` [`fs` to File System Access API adapter](./docs/fsa/fs-to-fsa.md)
+  - `experimental` [File System Access API to `fs` adapter](./docs/fsa/fsa-to-fs.md)
+  - `experimental` [`crudfs` a CRUD-like file system abstraction](./docs/crudfs/index.md)
+  - `experimental` [`casfs` Content Addressable Storage file system abstraction](./docs/casfs/index.md)
+  - [Directory `snapshot` utility](./docs/snapshot/index.md)
+  - [`print` directory tree to terminal](./docs/print/index.md)
+- [Code reference](https://streamich.github.io/memfs/)
+- [Test coverage](https://streamich.github.io/memfs/coverage/lcov-report/)
 
 ## Demos
 

docs/node/usage.md

@@ -39,6 +39,16 @@ vol.writeFileSync('/foo', 'bar');
 expect(vol.toJSON()).toEqual({ '/foo': 'bar' });
 ```
 
+Construct new `memfs` volumes:
+
+```js
+import { memfs } from 'memfs';
+
+const { fs, vol } = memfs({ '/foo': 'bar' });
+
+fs.readFileSync('/foo', 'utf8'); // bar
+```
+
 Create as many filesystem volumes as you need:
 
 ```js

package.json

@@ -1,6 +1,6 @@
 {
   "name": "memfs",
-  "version": "4.9.0",
+  "version": "4.9.1",
   "description": "In-memory file-system with Node's fs API.",
   "keywords": [
     "fs",
@@ -52,7 +52,7 @@
   "scripts": {
     "build": "tsc -p . && rimraf --glob lib/__tests__ 'lib/**/__tests__'",
     "build:webfs": "NODE_ENV=production webpack --config ./src/webfs/webpack.config.js",
-    "clean": "rimraf lib types",
+    "clean": "rimraf lib types typedocs gh-pages coverage",
     "demo:crud-and-cas": "webpack serve --config ./demo/crud-and-cas/webpack.config.js",
     "demo:fsa-to-node-sync-tests": "webpack serve --config ./demo/fsa-to-node-sync-tests/webpack.config.js",
     "demo:fsa-to-node-zipfile": "webpack serve --config ./demo/fsa-to-node-zipfile/webpack.config.js",
@@ -66,7 +66,10 @@
     "test:watch": "jest --watch",
     "tslint": "tslint \"src/**/*.ts\" -t verbose",
     "typecheck": "tsc -p .",
-    "watch": "watch \"npm run build\" ./src"
+    "watch": "watch \"npm run build\" ./src",
+    "coverage": "yarn test --collectCoverage",
+    "typedoc": "npx typedoc@0.25.13 --tsconfig tsconfig.json",
+    "build:pages": "npx rimraf@5.0.5 gh-pages && mkdir -p gh-pages && cp -r typedocs/* gh-pages && cp -r coverage gh-pages/coverage"
   },
   "commitlint": {
     "extends": [
@@ -121,15 +124,18 @@
     }
   },
   "dependencies": {
+    "@jsonjoy.com/json-pack": "^1.0.2",
+    "@jsonjoy.com/util": "^1.1.0",
+    "sonic-forest": "^1.0.0",
     "tslib": "^2.0.0"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/npm": "^9.0.1",
     "@types/jest": "^29.0.0",
-    "@types/node": "^10.17.60",
     "@types/mime": "^3.0.0",
+    "@types/node": "^10.17.60",
     "app-root-path": "^3.1.0",
     "assert": "^2.0.0",
     "buffer": "^6.0.3",

src/fsa-to-node/json.ts

@@ -1,5 +1,5 @@
-import { CborEncoder } from '../json-joy/json-pack/cbor/CborEncoder';
-import { CborDecoder } from '../json-joy/json-pack/cbor/CborDecoder';
+import { CborEncoder } from '@jsonjoy.com/json-pack/lib/cbor/CborEncoder';
+import { CborDecoder } from '@jsonjoy.com/json-pack/lib/cbor/CborDecoder';
 
 export const encoder = new CborEncoder();
 export const decoder = new CborDecoder();