Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(types): move non-core, non-public types out of the types package #7293

Merged
merged 1 commit into from
May 3, 2022

Conversation

Josh-Cena
Copy link
Collaborator

@Josh-Cena Josh-Cena commented May 3, 2022

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

We don't have a clear definition of what the types package is supposed to be for, but at baseline, it should expose those types that don't have a clear place where they are coming from, very likely from user config. If the type is produced by an internal function, it should be collocated with that function. For example, TOCItem is now moved to mdx-loader types, because it's produced by the loader, and the core should not be aware of it. Similarly, all tags types have been moved to utils, because we already have FrontMatterTag exported from there.

This results in a smaller types API surface.

@Josh-Cena Josh-Cena added the pr: maintenance This PR does not produce any behavior differences to end users when upgrading. label May 3, 2022
@Josh-Cena Josh-Cena requested review from slorber and lex111 as code owners May 3, 2022 08:58
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label May 3, 2022
@netlify
Copy link

netlify bot commented May 3, 2022

[V2]

Name Link
🔨 Latest commit 4b32dd2
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/6270eecc5990bd0009d97424
😎 Deploy Preview https://deploy-preview-7293--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented May 3, 2022

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 61
🟢 Accessibility 100
🟢 Best practices 92
🟢 SEO 100
🟢 PWA 90

Lighthouse ran on https://deploy-preview-7293--docusaurus-2.netlify.app/

@github-actions
Copy link

github-actions bot commented May 3, 2022

Size Change: 0 B

Total Size: 805 kB

ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 50.5 kB
website/build/assets/css/styles.********.css 107 kB
website/build/assets/js/main.********.js 609 kB
website/build/index.html 38.8 kB

compressed-size-action

@Josh-Cena Josh-Cena merged commit b49ae67 into main May 3, 2022
@Josh-Cena Josh-Cena deleted the jc/simplify-types branch May 3, 2022 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: maintenance This PR does not produce any behavior differences to end users when upgrading.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants