build: bundle dts via api-extractor and move deps to dev only by yue4u · Pull Request #1293 · pixiv/three-vrm

yue4u · 2023-09-22T10:02:37Z

close #1289

OPTIONS:

`@microsoft/api-extractor`

adopters:
- vite, angular, puppeteer
pros:
- actively developed
- can be used as interface checker
cons:
- needs configuration
- heavy / maybe over complicated for us

`rollup-plugin-dts`

adopters:
- vue, tsup
pros:
- less configuration
- faster? (no tested)
  - vue switched from @microsoft/api-extractor to rollup-plugin-dts from after 3.3
cons:
- generates wrong code in certain conditions https://github.com/egoist/tsup/issues?q=dts
- currently in maintenance-mode

do not bundle at all

pros:
- less configuration
- fast?
- tree shaking support?
  - if we go esm only it's actually not bad to not bundle at all
cons:
- esm/cjs support
- cdn may break/hard to try out
- large install size

Needs discussion:

do we need api.md?

yue4u · 2023-09-29T05:39:07Z

-  resolved "https://registry.yarnpkg.com/@types/webxr/-/webxr-0.5.0.tgz#aae1cef3210d88fd4204f8c33385a0bbc4da07c9"
-  integrity sha512-IUMDPSXnYIbEO2IereEFcgcqfDREOgmbGqtrMpVPpACTU6pltYLwHgVkrnYv0XhWEcjio9sYEfIEzgn3c7nDqA==
+  version "0.5.5"
+  resolved "https://registry.yarnpkg.com/@types/webxr/-/webxr-0.5.5.tgz#9e0a27e809c8f76cc1ef525d9f96b8fd94ef9c42"


modified to contain this fix DefinitelyTyped/DefinitelyTyped@b2505fd

yue4u · 2023-09-29T07:18:59Z

fdb0c87 addressed missing import issues. The added exports are most for building the dts bundle.

0b5vr · 2023-10-03T02:24:26Z

the report files end with .api.md, are those files meant to be committed to?

0b5vr · 2023-10-03T02:34:06Z

 import { removeUnnecessaryVertices } from './removeUnnecessaryVertices';
 import { rotateVRM0 } from './rotateVRM0';

+export type { deepDispose, removeUnnecessaryJoints, removeUnnecessaryVertices, rotateVRM0 };


why is the line needed?

see #1293 (comment)

mhm,,, How does it work? If I understand that the api-extractor simply forgets to output types for such static members, is that correct?

I added these to avoid api-extractor generating dts with some missing types. But after trying again now the issue has not been fixed. 🤔 Let me check it again.

Ah, I think I finally figured this out.

three-vrm is exporting VRMExpressionLoaderPlugin form three-vrm-core which use types-vrm-0.0 inside

if we bundle three-vrm-core with types-vrm-0.0 first, some exports from types-vrm-0.0 became private in three-vrm-core but it works fine

if we bundle three-vrm with bundled three-vrm-core then, the private part is untouchable from three-vrm so the output dts is incomplete

which seems reasonable so it's hard to say it's a bug in api-extractor

The same thing happends to ConstraintSchema.

So our options are

do not bundle dts from types-* packages in intermediate packages three-vrm-* and only bundle them inside three-vrm

can achieve single dts and no deps install

some exports from types-* are still private so maybe hard to use

types may conflict to user installed types-*

introduce inconstancy

treat all types-* as dependencies or peerdependencies and let user install them

not true dts bundle but flexible

option to not install types-vrm-0.0 at all

re-export or provide a public interface for each types-* in three-vrm-*

can achieve single dts and no deps install

needs dependency design?

What do you think?

Sounds like 2 is the best option...? It sounds easier from a contributor perspective at least.
3 is probably the most favorable option from a user perspective but it would make the module hard to maintain.

0b5vr · 2023-10-03T02:38:21Z

 export * from '@pixiv/three-vrm-springbone';
+
+export type { VRMMaterialsV0CompatPlugin } from '@pixiv/three-vrm-materials-v0compat';
+export type { VRMNodeConstraintLoaderPlugin } from '@pixiv/three-vrm-node-constraint';


Doesn't it overwrapped with the line export * from '@pixiv/three-vrm-node-constraint'; ?

0b5vr · 2023-10-03T02:39:51Z

 export * from '@pixiv/three-vrm-node-constraint';
 export * from '@pixiv/three-vrm-springbone';
+
+export type { VRMMaterialsV0CompatPlugin } from '@pixiv/three-vrm-materials-v0compat';


I think we can simply expose the entirety of @pixiv/three-vrm-node-constraint since it's already included in the build regardless.

yue4u · 2023-10-03T02:40:05Z

the report files end with .api.md, are those files meant to be committed to?

As post as Needs discussion: in the description, with committed api.md CI will fail during the build if any unintended public api interface change detected.

cons: may be noisy / pollute search results

0b5vr · 2023-10-03T02:57:59Z

As post as Needs discussion: in the description, with committed api.md CI will fail during the build if any unintended public api interface change detected.

ooo that actually sounds sweet. While I slightly feel that I want to try this, by looking at other adopters no one is using this feature. Would you want to recommend us using the feature?

0b5vr · 2023-10-03T03:07:14Z

+import type * as V0VRM from '@pixiv/types-vrm-0.0';
+export type { V0VRM };


If I understand correctly, these two lines are needed to control whether we are going to expose V0VRM from three-vrm-core or not, right?

Why we need to have this in src/expressions/index.ts , not src/index.ts ?

yue4u mentioned this pull request Sep 22, 2023

Tracking issue: Revamp build process #1294

Open

6 tasks

yue4u force-pushed the revamp-build-process branch from 2dc011e to 19ed32d Compare September 27, 2023 10:05

chore!: remove downlevel-dts

2b34689

yue4u mentioned this pull request Sep 29, 2023

BREAKING: chore: remove downlevel-dts #1302

Merged

yue4u force-pushed the revamp-build-process branch from 19ed32d to d307480 Compare September 29, 2023 04:11

yue4u changed the base branch from dev to chore/remove-downlevel-dts September 29, 2023 04:12

yue4u force-pushed the revamp-build-process branch from d307480 to cb48d0a Compare September 29, 2023 04:14

feat: bundle dts via api-extractor and move deps to dev only

a7bb7b5

yue4u force-pushed the revamp-build-process branch from cb48d0a to a7bb7b5 Compare September 29, 2023 05:38

yue4u commented Sep 29, 2023

View reviewed changes

fix: resolve missing imports

fdb0c87

yue4u requested a review from 0b5vr September 29, 2023 07:20

yue4u marked this pull request as ready for review September 29, 2023 07:20

0b5vr reviewed Oct 3, 2023

View reviewed changes

yue4u force-pushed the chore/remove-downlevel-dts branch 9 times, most recently from abe7da1 to 136ce08 Compare June 6, 2024 06:54

yue4u force-pushed the chore/remove-downlevel-dts branch from 136ce08 to f0c66b6 Compare June 6, 2024 07:07

Base automatically changed from chore/remove-downlevel-dts to dev-v3 June 10, 2024 10:09

Base automatically changed from dev-v3 to dev August 1, 2024 08:10

yamayuski mentioned this pull request Aug 12, 2025

Use VRM types from three-vrm's one or not? yamayuski/babylon-vrm#9

Closed

		import type * as V0VRM from '@pixiv/types-vrm-0.0';
		export type { V0VRM };

Conversation

yue4u commented Sep 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

OPTIONS:

@microsoft/api-extractor

rollup-plugin-dts

do not bundle at all

Needs discussion:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yue4u commented Sep 29, 2023

Uh oh!

0b5vr commented Oct 3, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yue4u Oct 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yue4u commented Oct 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

0b5vr commented Oct 3, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

yue4u commented Sep 22, 2023 •

edited

Loading

`@microsoft/api-extractor`

`rollup-plugin-dts`

yue4u Oct 3, 2023 •

edited

Loading

yue4u commented Oct 3, 2023 •

edited

Loading