Switch to Preconstruct for building packages

[Andarist]

Description

The PR has been prompted by my conversation on Twitter with @jjenzz: https://twitter.com/jjenzz/status/1390973850716884994

Basically... with Preconstruct you don't need to run builds in topological order because it first just outputs dummy .d.ts that redirects requests to the respective src/index.ts. Thanks to that all builds can just happen in parallel.

[Andarist]

For some random reason, I couldn't install Preconstruct on a previous version because installs were failing with:

➤ YN0001: │ Error: fsevents@patch:fsevents@npm%3A2.3.2#builtin<compat/fsevents>::version=2.3.2&hash=495457: Cannot apply hunk #1
    at d (/radix-ui-primitives/.yarn/releases/yarn-2.1.1.cjs:2:190674)
    at async /radix-ui-primitives/.yarn/releases/yarn-2.1.1.cjs:2:189912
    at async h (/radix-ui-primitives/.yarn/releases/yarn-2.1.1.cjs:2:188524)
    at async g (/radix-ui-primitives/.yarn/releases/yarn-2.1.1.cjs:2:189885)
    at async q.fetchers.patchPackage (/radix-ui-primitives/.yarn/releases/yarn-2.1.1.cjs:2:204417)
    at async B (/radix-ui-primitives/.yarn/releases/yarn-2.1.1.cjs:2:226253)
    at async Q (/radix-ui-primitives/.yarn/releases/yarn-2.1.1.cjs:2:226716)
    at async v (/radix-ui-primitives/.yarn/releases/yarn-2.1.1.cjs:2:227192)
    at async C.fetchPackageFromCache (/radix-ui-primitives/.yarn/releases/yarn-2.1.1.cjs:2:227431)
    at async q.fetchers.fetch (/radix-ui-primitives/.yarn/releases/yarn-2.1.1.cjs:2:203286)

Upgrading Yarn has helped so I didn't dig deeper into this 🤷‍♂️

[Andarist]

to the best of my knowledge - you don't need this tsconfig dance anymore

[Andarist]

The current version of Yarn fails executing this postinstall with:

➤ YN0006: │ primitives@workspace:. lists build scripts, but is referenced through a soft link. Soft links don't support build scripts, so they'll be ignored.
➤ YN0007: │ primitives@workspace:. must be built because it never did before or the last one failed
➤ YN0009: │ primitives@workspace:. couldn't be built successfully (exit code 1, logs can be found here: /private/var/folders/ws/tlwxqvs5407f21nxy7w8bgr80000gp/T/xfs-e80184bd/build.log)
➤ YN0009: │ primitives@workspace:. couldn't be built successfully (exit code 1, logs can be found here: /private/var/folders/ws/tlwxqvs5407f21nxy7w8bgr80000gp/T/xfs-e80184bd/build.log)

From what I recall - at least this error message is a bug and it has already been fixed in Yarn so you could try switching to the version from their master/main branch.

[Andarist]

Technically the "types" field is not required so it could be removed but there are still some reasons to keep it around. See preconstruct/preconstruct#259

[jjenzz]

Hi @Andarist,

Thanks for submitting this. It looks exactly like what we had tried already but unfortunately doesn't solve the issue. You will see after a build in your branch that Menu.d.ts contains the following:

😢

If it helps, we've realised this only seems to happen for our components that use our extendPrimitive utility. It uses type inference to build out the return type. I wonder if that has anything to do with it? Perhaps preconstruct doesn't know how to generate dummy .d.ts files in this case?

If we build types manually with TS in topological order, TS is able to generate the correct imports for us here.

[Andarist]

@jjenzz could you describe what you are doing to get yourself into this situation on this branch? What commands do u run and what files are you inspecting?

[benoitgrelard]

• Start with a clean slate, so: yarn clean
• yarn build
• open packages/react/menu/dist/index.d.ts
• look for MenuAnchor

[jjenzz]

It will be in packages/react/menu/dist/declarations/src/Menu.d.ts in your preconstruct branch

[Andarist]

Okay - so the problem is not as much that this doesn't work but that the generated declarations contain references to the src directory which in turn would force you to publish those, right?

I think I understand the issue better now and I agree it's a slight problem. I have an idea how this could be fixed in Preconstruct - gonna be consulting that with Mitchell and I will let u know if we can fix this for you.

[benoitgrelard]

That sounds great @Andarist, thanks for you time!

[jjenzz]

the generated declarations contain references to the src directory

Yep. We would expect these imports to be import("@radix-ui/rect") which we get if we build the types in topological order.

Thank you for taking a look @Andarist 🙂 In the meantime, do you mind if we close this PR until preconstruct has a way to handle it?

[Andarist]

Yep. We would expect these imports to be import("@radix-ui/rect") which we get if we build the types in topological order.

I'll experiment with it more but I think there might be some cases when it's impossible to do generate import("@radix-ui/rect"). After all - a type might be internal and not exported from the root of the package. Luckily, this ain't that big of a problem given how Preconstruct generates declarations because we'll always be able to reference smth like import("@radix-ui/rect/dist/declarations/observeElementRect").

Thank you for taking a look @Andarist 🙂 In the meantime, do you mind if we close this PR until preconstruct has a way to handle it?

Sure thing - I'll close this myself now :)