feat(sync): Add a sync and CJS entrypoint for editor tooling

[Princesseuh]

Changes

TypeScript unfortunately does not support running async methods inside its LanguageService API, so our language server needs a sync version of the compiler. Since WASM instantiation is async only, you still need at least one async init call, but then you can use all the methods sync. It's not perfect, but it at leasts allows us to not rely on synckit, which makes things slow

Why the separate file? index.ts has a call to import.meta.url, which prevented my CJS-based application to even import the file. Annoying. ESM in VS Code extensions when 😠

Testing

Tested manually

Docs

N/A

[changeset-bot]

🦋 Changeset detected

Latest commit: be6c3b5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@astrojs/compiler	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[Princesseuh]

!preview sync

[github-actions]

 > root@0.0.0 release /home/runner/work/compiler/compiler > changeset publish "--tag" "next--sync" 🦋 warn ===============================IMPORTANT!=============================== 🦋 warn Packages will be released under the next--sync tag 🦋 warn ---------------------------------------------------------------------- 🦋 info npm info @astrojs/compiler 🦋 warn @astrojs/compiler is not being published because version 1.3.1 is already published on npm 🦋 warn No unpublished projects to publish

[Princesseuh]

!preview sync

[github-actions]

 > root@0.0.0 release /home/runner/work/compiler/compiler > changeset publish "--tag" "next--sync" 🦋 warn ===============================IMPORTANT!=============================== 🦋 warn Packages will be released under the next--sync tag 🦋 warn ---------------------------------------------------------------------- 🦋 info npm info @astrojs/compiler 🦋 info @astrojs/compiler is being published because our local version (0.0.0-sync-20230409173822) has not been published on npm 🦋 info Publishing "@astrojs/compiler" at "0.0.0-sync-20230409173822" 🦋 success packages published successfully: 🦋 @astrojs/compiler@0.0.0-sync-20230409173822 🦋 Creating git tag... 🦋 New tag: @astrojs/compiler@0.0.0-sync-20230409173822

[bluwy]

I believe es-module-lexer has this pattern too, where you can call await init so that the rest of the functions are sync. If init isn't called before, the first function call would return a promise as fallback. Maybe we can also have this same flow for both ESM and CJS.

[Princesseuh]

!preview sync

[github-actions]

 > root@0.0.0 release /home/runner/work/compiler/compiler > changeset publish "--tag" "next--sync" 🦋 warn ===============================IMPORTANT!=============================== 🦋 warn Packages will be released under the next--sync tag 🦋 warn ---------------------------------------------------------------------- 🦋 info npm info @astrojs/compiler 🦋 info @astrojs/compiler is being published because our local version (0.0.0-sync-20230418112509) has not been published on npm 🦋 info Publishing "@astrojs/compiler" at "0.0.0-sync-20230418112509" 🦋 success packages published successfully: 🦋 @astrojs/compiler@0.0.0-sync-20230418112509 🦋 Creating git tag... 🦋 New tag: @astrojs/compiler@0.0.0-sync-20230418112509

[Princesseuh]

!preview sync

[github-actions]

 > root@0.0.0 release /home/runner/work/compiler/compiler > changeset publish "--tag" "next--sync" 🦋 warn ===============================IMPORTANT!=============================== 🦋 warn Packages will be released under the next--sync tag 🦋 warn ---------------------------------------------------------------------- 🦋 info npm info @astrojs/compiler 🦋 info @astrojs/compiler is being published because our local version (0.0.0-sync-20230418114635) has not been published on npm 🦋 info Publishing "@astrojs/compiler" at "0.0.0-sync-20230418114635" 🦋 success packages published successfully: 🦋 @astrojs/compiler@0.0.0-sync-20230418114635 🦋 Creating git tag... 🦋 New tag: @astrojs/compiler@0.0.0-sync-20230418114635

[Princesseuh]

!preview sync

[github-actions]

 > root@0.0.0 release /home/runner/work/compiler/compiler > changeset publish "--tag" "next--sync" 🦋 warn ===============================IMPORTANT!=============================== 🦋 warn Packages will be released under the next--sync tag 🦋 warn ---------------------------------------------------------------------- 🦋 info npm info @astrojs/compiler 🦋 info @astrojs/compiler is being published because our local version (0.0.0-sync-20230418131144) has not been published on npm 🦋 info Publishing "@astrojs/compiler" at "0.0.0-sync-20230418131144" 🦋 success packages published successfully: 🦋 @astrojs/compiler@0.0.0-sync-20230418131144 🦋 Creating git tag... 🦋 New tag: @astrojs/compiler@0.0.0-sync-20230418131144