refactor(js-api): remove the JSON-RPC backend and unimplemented methods #3831
Conversation
✅ Deploy Preview for docs-rometools canceled.
|
| }, | ||
| "peerDependencies": { | ||
| "rome": "^10.0.0", | ||
| "@rometools/wasm-bundler": "^10.0.0", |
There was a problem hiding this comment.
Any reason why rome was removed from here?
There was a problem hiding this comment.
The rome package isn't being imported in the JS API, it only serves to pull in the pre-built binaries but we're not making use of that anywhere
There was a problem hiding this comment.
Then it should be removed from the peerDependenciesMeta
| let isInitialized = { | ||
| [Distribution.BUNDLER]: false, | ||
| [Distribution.NODE]: false, | ||
| [Distribution.WEB]: false, | ||
| }; |
There was a problem hiding this comment.
This shape makes me think that more than one distribution can be initialized at the same time. Is it the case?
There was a problem hiding this comment.
Yes potentially someone could call Rome.create multiple times with different distribution, it's unclear why anyone would do that but I figured the modules should at least be initialized properly in that case ...
| @@ -1,6 +1,7 @@ | |||
| { | |||
| "compilerOptions": { | |||
| "target": "es2020", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ | |||
| "lib": ["ES2020", "ESNext.WeakRef"], | |||
There was a problem hiding this comment.
Is WeakRef used to enable the FinalizationRegistry feature?
There was a problem hiding this comment.
Yes FinalizationRegistry isn't part of the ES2020 specification
1bf09f3 to
3277027
Compare
2aa5104 to
8962d4e
Compare
Summary
This PR aims at improving the usability of the
@rometools/js-apipackage by cleaning up some unfinished features.I removed the JSON-RPC backend as it's unlikely to be useful in the short term while we don't have a long running development server (since this only leaves the WASM backend, the concept of backend has instead been replaced with "distributions" to let the user choose which of the
bundler,nodejsorwebversions of@rometools/wasmthey want to load).I also removed the
formatFilesandparseContentmethods since those were not implemented at the moment. On the other hand I added newlintContentandprintDiagnosticsmethods since those were mostly straightforward to implement and could provide additional value to the JS API. Finally I've added ashutdownmethod to manually free the WASM Workspace instance, as well as an experimental use of theFinalizationRegistryto automatically free some Workspace instances that are no longer reachable.Test Plan
I've updated the existing tests for the JS API to remove the daemon-specific tests and cover the new methods.