microsoft / microsoft/fluentui

Add Ability to Annotate Sub-Package Exports As "Internal"

Open
#23,343 5 comments 0 reactions 1 assignee View on GitHub

@Hotell is already working on this.

Since May 31, 2022.

Area: Build System Area: Linting Effort III: Weeks Resolution: Soft Close Type: Epic
Dominant language
TypeScript
Stars
20.3k
Forks
2.9k
Avg merge
2d 9h
Merged PRs (30d)
46

Description

Problem

The @fluentui/react-components package represents the officially supported public API surface of Fluent UI React v9 yet it is composed on many "sub-packages" that are published on npm and follow semantic versioning, effectively making the APIs of these sub-packages part of Fluent's public API as well. Yet we don't always re-export an entire sub-package's API from @fluentui/react-components as parts of these APIs are meant for internal use only.

For example, @fluentui/react-components imports @fluentui/react-utilities and then re-exports some of its exports. Some of the exports from react-utilities are only meant for internal use and are not part of the public API but we have no way of communicating this to users our even within the Fluent UI team.

Appetite

3~4 weeks. We should have a solution prior to the release of v9 stable at the end of June.

Solution

Provide a mechanism to mark exports from a sub-package as "internal only".

Risks (Rabbit holes)

Out of scope (No-gos)

  1. No breaking changes allowed

Related

  • #23345

Tasks

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.