feat(harper.js): export both binary and inlinedBinary for different runtimes

[Asuka109]

This pull request includes several changes to improve the Harper.js project, focusing on updating dependencies, modifying test configurations, and refactoring the code to use the new harper-wasm package. The most important changes include updating the package.json dependencies, modifying the test scripts, and refactoring the Linter and LocalLinter classes to use the new binary module.

Dependency and configuration updates:

• packages/harper.js/package.json: Updated dependencies to use harper-wasm instead of wasm, added new test scripts, and updated the versions of several development dependencies. Added sideEffects field so that all the exports can be removed by bundler treeshaking.

Refactoring and code improvements:

• packages/harper.js/src/binary.ts: Migrated from src/WorkerLinter/communication.ts and src/loadWasm.ts, it provides BinaryModule as a wrapper for the raw WebAssembly module, bringing more readable method names and additional features. It also exports binary and binaryInlined to load the WebAssembly file in different ways.
• packages/harper.js/src/Linter.ts: Updated imports to use harper-wasm and added a new LinterInit interface that includes the binary module. [1] [2]
• packages/harper.js/src/LocalLinter.ts: Refactored the LocalLinter class to use the new binary module for WebAssembly operations, removing the old loadWasm method. Now it should be initialized with passing a BinaryModule.
• packages/harper.js/src/WorkerLinter/index.ts: Updated the WorkerLinter class to use the new binary module and refactored the worker communication setup.

Testing improvements:

• packages/harper.js/src/Linter.test.ts: Modified tests to use the new binary module when initializing Linter instances. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]

[elijah-potter]

Hey @Asuka109, just a heads up. If you want the precommit job to ✔️, you need to run just format and commit the results.

[Asuka109]

@elijah-potter Got it. I missed your comment last week. I tried it just now, but it seems it won't resolve the ESLint issues. Also, I noticed that VSCode cannot resolve the .eslintrc file and isn't linting the problems. I can improve that in the next PR.

[Asuka109]

@elijah-potter It seems like there is something wrong with the cases running in Firefox. I will handle it later. There are quite a lot of changes to the API. Could you please take a look at the changes and let me know if anything needs to be changed?

[elijah-potter]

You've made a lot of changes here. Some of the reasoning needs a bit more explanation.

[Asuka109]

@elijah-potter I think everything is ready now.

[Asuka109]

@elijah-potter I found that initializing binary makes Node.js programs panic, even when only binaryInlined is used. Please hold off on reviewing this until I fix it.

[elijah-potter]

Would it be alright if I took a look at it? Is there a reproducible example I can work off?

[Asuka109]

@elijah-potter It just happened when I tried to require harper.js in a Node.js script. I will go back and work on this MR.

[Asuka109]

@elijah-potter Sorry for keeping you waiting. I've made some commits, and now it's ready for review!

[Asuka109]

When exporting both binary and binaryInlined, treeshaking can only remove the unused one when using a bundler. However, I forgot that Node.js runtime doesn't execute treeshaking. It caused an error in the binary constructor when harper_wasm.js attempted to fetch the wasm module from the binary URL. So in the latest commit, binary has been changed to initialize lazily.

[Asuka109]

harper/packages/harper.js/src/binary.ts

Lines 9 to 27 in c99168d

	export const loadBinary = pMemoize(async (binary: string) => {
	const exports = await import('harper-wasm');
	let input: InitInput;
	if (typeof process !== 'undefined' && binary.startsWith('file://')) {
	const fs = await import(/* webpackIgnore: true */ /* @vite-ignore */ 'fs');
	input = new Promise((resolve, reject) => {
	fs.readFile(new URL(binary).pathname, (err, data) => {
	if (err) reject(err);
	resolve(data);
	});
	});
	} else {
	input = binary;
	}
	await exports.default({ module_or_path: input });
	return exports;
	});

In the implementation of loadBinary, I had to use the typeof process expression to determine if it's a Node.js environment to prevent harper_wasm.js executing fetch(module_or_path). It's hard to find a better way because I've noticed that many JavaScript libraries using wasm don't support both Node.js and web platforms. As for the binary parameter in new Linter({ binary }), I've thought of a way to make it optional, which I'll introduce in a later PR.

[elijah-potter]

It's hard to find a better way because I've noticed that many JavaScript libraries using wasm don't support both Node.js and web platforms.

Yeah, it's an unfortunate circumstance to find ourselves in. Do you think

As for the binary parameter in new Linter({ binary }), I've thought of a way to make it optional, which I'll introduce in a later PR.

Nice! Keep me updated.

I can't take a look at this PR right now. I'll circle back later today.

[Asuka109]

@elijah-potter I found the way to load binary in different ways according to the platform. Here's the demo: https://github.com/Asuka109/binary-mutiple-platform

[elijah-potter]

@elijah-potter I found the way to load binary in different ways according to the platform. Here's the demo: https://github.com/Asuka109/binary-mutiple-platform

Good idea! Let's make that part of a different PR though. I've gone ahead and fixed the WordPress plugin to use the API changes. I think this is ready to merge!