Skip to content

docs(rfc): update packaging with shipping types rfc#22469

Merged
Hotell merged 2 commits intomicrosoft:masterfrom
Hotell:hotell/rfcs/packaging-shipping-types
Apr 25, 2022
Merged

docs(rfc): update packaging with shipping types rfc#22469
Hotell merged 2 commits intomicrosoft:masterfrom
Hotell:hotell/rfcs/packaging-shipping-types

Conversation

@Hotell
Copy link
Contributor

@Hotell Hotell commented Apr 12, 2022

Pre-requisite:

Adds shipping types RFC chapter

Preview 👀

Related Issue(s)

Fixes partially #22429

@github-actions github-actions bot added the Type: RFC Request for Feedback label Apr 12, 2022
@Hotell Hotell changed the title Hotell/rfcs/packaging shipping types docs(rfc): update packaging with shipping types rfc Apr 12, 2022
@Hotell Hotell requested review from a team April 12, 2022 11:35
@fabricteam
Copy link
Collaborator

fabricteam commented Apr 12, 2022

📊 Bundle size report

🤖 This report was generated against b48c03cff249019cf845af18a7f63dacf46d5218

@Hotell Hotell mentioned this pull request Apr 12, 2022
50 tasks
@codesandbox-ci
Copy link

codesandbox-ci bot commented Apr 12, 2022

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 133412c:

Sandbox Source
@fluentui/react 8 starter Configuration
@fluentui/react-components 9 starter Configuration

@size-auditor
Copy link

size-auditor bot commented Apr 12, 2022

Asset size changes

Size Auditor did not detect a change in bundle size for any component!

Baseline commit: 543b0c6b1e1d950b454c43662fa3e7b911139919 (build)

Copy link
Contributor

@theerebuss theerebuss left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both approaches seem good to me 👌

3 (shipping only rollup-ed(bundled) implementation files) and 4 (package.json post-processing) won't be tackled in this PR, correct?

- TBA
- additional configuration to maintain within our legacy tool chain

### 3. shipping only rollup-ed(bundled) implementation files
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This solution is what's mentioned as an approach for problem 1 of section 2, right?

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, there is nothing regarding implementation files in this PR/RFC

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

is it confusing ? if yes what would you suggest ? I'm following proper a11y heading outline in general

@Hotell Hotell force-pushed the hotell/rfcs/packaging-shipping-types branch from 36d7492 to 876cc60 Compare April 13, 2022 15:34
Co-authored-by: André Dias (he/him) <39736248+andrefcdias@users.noreply.github.com>
Copy link
Contributor

@spmonahan spmonahan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Copy link
Member

@khmakoto khmakoto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this makes sense, I especially like not exposing internals if we don't need to.

- TBA
**Problem 1 solution:**

- ship only [rolluped declaration files `.d.ts`](https://medium.com/@martin_hotell/typescript-library-tips-rollup-your-types-995153cc81c7) for all public API entrances. We can leverage already existing setup via api-extractor.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The diagram mentions rollup, but the solution using api-extractor is still comptible with how we currently build with tsc right ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

diagram is taken from my blogpost, where rollup.js was used for bundling implementation. the rest of diagram uses api-extractor for declaration bundling (rollup-ing).

is still comptible with how we currently build with tsc right

yes

@Hotell Hotell merged commit 6a091d2 into microsoft:master Apr 25, 2022
@Hotell Hotell deleted the hotell/rfcs/packaging-shipping-types branch April 25, 2022 14:18
marwan38 pushed a commit to marwan38/fluentui that referenced this pull request Jun 13, 2022
* docs(rfc): update packaging with shipping types rfc

* Apply suggestions from code review

Co-authored-by: André Dias (he/him) <39736248+andrefcdias@users.noreply.github.com>

Co-authored-by: André Dias (he/him) <39736248+andrefcdias@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants