Release v4 by streamich · Pull Request #926 · streamich/memfs

streamich · 2023-06-22T07:13:28Z

In-memory fs changes
- A number of in-memroy fs bugs were fixed.
- Type interfaces of methods and options objects for in-memory fs were improved.
- mkdirp and mkdripSync were removed, they were deprecated before. (You can pass the "recursive" flag to mkdir and mkdirSync, instead.)
- Many re-usable Node.js fs utilities now live in the /src/node folder.
- Promises API methods are now bound by default to their this object, just like in native fs module.
File System Access API
- Node fs to File System Access API adapter was added.
- File System Access API to Node fs adapter was added.
  - In browser, support for synchronous fs methods was added through WebWorker.
crudfs and casfs
- crudfs implementation on top of Node fs was added.
- crudfs implementation on top of File System Access API was added.
- casfs implementation on top of crudfs was added.
print utility was added which allows to recursively print a directory tree to terminal.
snapshot utility was added which allows to create recursive binary snapshots of folders and then load them back into some folder.
The /demo folder now contains multiple Webpack demos.
Build changes and deprecations
- TypeScript was upgraded from version 4 to 5.
- tslib is now included as peer dependency, instead of TypeScript helpers being emitted into distributable.
- TypeScript build target of the distributable is no es2017, instead of previously es5.
- The library is now tested on Node v18+ versions.
- BigInt shim is no longer shipped, memfs will rely on the BigInt provided by the JavaScript environment. You can shim that global, if necessary.
- fs-monkey dependemcy was removed.
New features in this major release are marked as experimental, which means those APIs are in preview, their public interface may have breaking changes even across minor releases.
CircleCI was removed, now GitHub actions power all builds and releases.
The next branch was tested, which deploys pre-releases.

# [4.1.0-next.3](v4.1.0-next.2...v4.1.0-next.3) (2023-06-22) ### Bug Fixes * 🐛 correctly handle directory paths ([ea909e8](ea909e8)) * 🐛 improve file opening and closing logic ([403c271](403c271)) ### Features * 🎸 add missing callback API methods and some sycn API ones ([956533a](956533a)) * 🎸 add missing promisees API types ([f6727f3](f6727f3)) * 🎸 add missing synchronous method types ([ac38b5d](ac38b5d)) * 🎸 implement crudfs on top of fs ([cb7ac4d](cb7ac4d)) * 🎸 make promises methods bound ([3010141](3010141)) * 🎸 setup NodeCrud implementation ([39073ce](39073ce))

[skip ci]

G-Rath · 2023-06-23T02:43:04Z

@streamich nothing springs to mind other than checking if we want to change the min. node version? Just as I'm not sure if we're completely compatible with Node 4 any more

streamich · 2023-06-23T09:16:05Z

@G-Rath cool, will merge it on Monday then.

Do not downlevel async/await

Print tree

# [4.1.0-next.4](v4.1.0-next.3...v4.1.0-next.4) (2023-06-25) ### Features * 🎸 add .toTree() to Volume ([2d5c4cb](2d5c4cb)) * 🎸 add sumlink printing support ([1850dae](1850dae)) * 🎸 implement toTreeSync() method ([09c9770](09c9770))

Snapshots

# [4.1.0-next.5](v4.1.0-next.4...v4.1.0-next.5) (2023-06-25) ### Bug Fixes * 🐛 add support for unknown nodes ([77786f1](77786f1)) ### Features * 🎸 add binary serialization to snapshots ([c1cd615](c1cd615)) * 🎸 add json encoding for snapshots ([41f9b8c](41f9b8c)) * 🎸 add snapshot creation utilities ([9fc8f13](9fc8f13)) * 🎸 implement async verions of snapshotting ([18912bf](18912bf))

[skip ci]

streamich · 2023-06-26T12:08:54Z

I've bumped compile target to es2017, as that emits native async/await.

streamich · 2023-06-26T12:12:40Z

Not sure how to test with which Node version memfs is compatible. It is tested on CI for v18, and v20. Maybe it is better to remove that engine setting altogether.

Regarding older versions, the only change that should require higher Node.js versions is the TypeScript build target change from es5 to es2017. I don't think there were any other changes that would require higher Node.js versions for the existing code. (Maybe BigInt removal.)

The new code added in v4 release, is imported through a separate path; big part of it requires the latest Node v20 to run; or a browser environment.

streamich added 30 commits June 21, 2023 01:07

feat: 🎸 add basenem() utility

8b27695

feat: 🎸 implement keys() method

33f9af0

feat: 🎸 introduce FSA context

f603262

feat: 🎸 implement .values() and .entries()

f13de3b

feat: 🎸 implement .getDirectoryHandle() method

b6b026a

feat: 🎸 add ability to create sub directories

8f15bd9

feat: 🎸 implement .getFileHandle() method

71567c9

feat: 🎸 add options to promises.rmdir() method

ce268bb

feat: 🎸 implement .removeEntry() method

48617aa

feat: 🎸 implement .resolve() method

bf47b96

feat: 🎸 implement .isSameEntry() method

f18d91e

style: 💄 run Prettier

77ebdc2

feat: 🎸 implement .getFile() method

b8601cc

test: 💍 add conditional testing based on node version

2b0d1e8

test: 💍 add .getFile() test

a7061eb

feat: 🎸 add initial writign implementation

2f9542c

style: 💄 run Prettier

23c8ad5

fix: 🐛 allow to seek in file

c04895b

feat: 🎸 improve writing at offset logic

71b6afc

feat: 🎸 improve writing to file

1de0e06

fix: 🐛 allow readin into various kinds of buffers

361812d

feat: 🎸 start synchronous file handle implementation

f9b0f73

feat: 🎸 throw exception on closed files

7adff27

feat: 🎸 add .truncate() method

038ab36

style: 💄 run Prettier

964a68b

test: 💍 remove test

6ab0edc

feat: 🎸 implement sync write method

3017ecd

feat: 🎸 add typed array view support to volume

a8bee73

feat: 🎸 include "writeSync" method for sync writer

b267f78

feat: 🎸 add createSwapFile() method

dfdb908

semantic-release-bot and others added 2 commits June 22, 2023 09:48

chore: 🤖 add todo comment

93f909b

[skip ci]

streamich and others added 22 commits June 25, 2023 11:26

refactor: 💡 make memfs() return a collection of things

2ce01b7

feat: 🎸 implement toTreeSync() method

09c9770

feat: 🎸 add sumlink printing support

1850dae

feat: 🎸 add .toTree() to Volume

2d5c4cb

docs: ✏️ add real fs printing demo

fbe25ef

docs: ✏️ add print utility docs

8f668ed

docs: ✏️ add .toTree() to volume docs

9ce09f4

style: 💄 run Prettier

c4a916d

docs: ✏️ typo

4f80799

Merge pull request #929 from streamich/print-tree

558c001

Print tree

feat: 🎸 add snapshot creation utilities

9fc8f13

fix: 🐛 add support for unknown nodes

77786f1

style: 💄 run Prettier

4296509

feat: 🎸 implement async verions of snapshotting

18912bf

feat: 🎸 add binary serialization to snapshots

c1cd615

feat: 🎸 add json encoding for snapshots

41f9b8c

style: 💄 run Prettier

eb3a62c

docs: ✏️ add snapshto docs

db54c49

Merge pull request #930 from streamich/snapshots

01381cf

Snapshots

chore: 🤖 bump compile target to es2017

491272b

[skip ci]

streamich merged commit 32dd55a into master Jun 26, 2023

G-Rath deleted the next branch February 17, 2024 18:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Release v4#926

Release v4#926
streamich merged 458 commits into
masterfrom
next

streamich commented Jun 22, 2023 •

edited

Loading

Uh oh!

G-Rath commented Jun 23, 2023

Uh oh!

streamich commented Jun 23, 2023 •

edited

Loading

Uh oh!

streamich commented Jun 26, 2023

Uh oh!

streamich commented Jun 26, 2023 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

streamich commented Jun 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

G-Rath commented Jun 23, 2023

Uh oh!

streamich commented Jun 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

streamich commented Jun 26, 2023

Uh oh!

streamich commented Jun 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

streamich commented Jun 22, 2023 •

edited

Loading

streamich commented Jun 23, 2023 •

edited

Loading

streamich commented Jun 26, 2023 •

edited

Loading