fs-extra VS jest

I haven't seen fs-extra mentioned yet. For my work it involves a fair bit of reading/writing to the filesystem, so this makes it quite nice to deal with everything in an async way.

There are a number of these modules, https://github.com/jprichardson/node-fs-extra being probably the most famous / popular. It does a better job of explaining the why.

Since updating nodejs@18 and switching to esm only, many libraries have been replaced to support esm import, but fs-extra has not been The use of esm is correctly supported, and no suitable replacement has been found. After the a PR proposed by us was rejected, I decided to re-release a [fs-extra-unified] that correctly supports the use of esm (https://www.npmjs.com/package/fs-extra-unified) module.

Are you seriously suggesting the creators of the software can't write a "save elsewhere" function using Electron and JavaScript? The system has versioning so it would be easy to ask the user to create a backup on first loading with a new version of the software, and the copySync function to make a backup. Foundry uses Node.js already.

We are dealing with a file that is far too large to be loaded into memory at once. Node cannot buffer the file for us because of the size of it.

Implementing those 3 features was quite simple. For metadata and markdown file, I mainly used an external library: showdown to convert from markdown files to html files as well as parsing metadata from markdown files. However, implementing the support for static assets such as images is a bit more interesting. I had to use another external library called fs-extra to copy assets folder from user to the dist folder. I also had to create another new class called CopyFolder where I used fs.copy method to copy assets folder

The zx project implements a shell script executor similar to Bash but using JavaScript modules. It provides an inbuilt asynchronous JavaScript API to call other commands similar to Bash. Besides that, it provides wrapper functions for several Node.js-based command-line helpers such as chalk, minimist, fs-extra, OS, and Readline.

Node.js has the built-in fs module (fs/promises with async/await) which makes it easy to interact with the file system. On top of that, there are a few convenient libraries such as fs-extra and findit that make common tasks straightforward.

For this purpose we'll use fs-extra since copy/paste seems like not supported by fs API.

GitHub | Website

Jest

you have selected a testing framework. In my case, it's Jest with Supertest

Jest, created and maintained by Facebook, is a JavaScript testing framework with a focus on simplicity. It is often recognized for its zero-configuration setup and seamless integration, especially with React applications, making it a favored choice for developers in both small-scale projects and large enterprise applications.

Jest (https://jestjs.io/)

console.error Jest encountered an unexpected token Jest failed to parse a file. This happens e.g. when your code or its dependencies use non-standard JavaScript syntax, or when Jest is not configured to support such syntax. Out of the box Jest supports Babel, which will be used to transform your files into valid JS based on your Babel configuration. By default "node\_modules" folder is ignored by transformers. Here's what you can do: • If you are trying to use ECMAScript Modules, see https://jestjs.io/docs/ecmascript-modules for how to enable it. • If you are trying to use TypeScript, see https://jestjs.io/docs/getting-started#using-typescript • To have some of your "node\_modules" files transformed, you can specify a custom "transformIgnorePatterns" in your config. • If you need a custom transformation specify a "transform" option in your config. • If you simply want to mock your non-JS modules (e.g. binary assets) you can stub them out with the "moduleNameMapper" config option. You'll find more details and examples of these config options in the docs: https://jestjs.io/docs/configuration For information about custom transformations, see: https://jestjs.io/docs/code-transformation

Note: I will be using Jest as testing framework throughout the examples.

We use Jest Framework for testing. Jest is not a dogma, and, of course, in its place can be any other test runner, such as Mocha or Ava. Let's focus on tests. I'll provide a short example because I don’t want to waste your time. You can find the full version here. It's crucial to read the comments in the code below. Let's go!

Jest has long been my favorite got to test runner when it comes to UI unit and integration testing. With tools like React Testing Library (Testing Library framework for React) you get the benefit of very easy to write and maintain tests, as well as a quick and efficient way to run our tests.

Jest is a well-regarded JavaScript testing framework primarily designed for React applications, although its utility extends to projects using Babel, JavaScript, Node, Angular, and Vue. Created by Facebook, Jest emphasizes ensuring the correctness of JavaScript codebases. It allows developers to write tests with a familiar, feature-rich API, making the testing process swift and enjoyable​​.