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: reworked core exports #1491

Merged
merged 5 commits into from
Feb 2, 2024

Conversation

javiertoledo
Copy link
Member

@javiertoledo javiertoledo commented Nov 2, 2023

Description

Cleanup of exported methods of the core package to avoid extra levels of indirection. The core index interface has not changed, but I've moved the implementation of the static methods from the booster.ts file to the index.ts to avoid a level of indirection. The BoosterApp type was made redundant as it was just describing the Booster class signature.

Changes

  • Moved static methods implementation to index.ts
  • Export the Booster object directly without proxying it through the BoosterApp type
  • Remove the BoosterApp type, as the Booster object already exports the correct signature. This type was used only to type-check loading user apps from the CLI, and while the type was exported, it was not used in practice. Users use the Booster singleton exported by the core package instead.
  • Remove no longer used methods from the Booster class, as they were never exported; thus, removing them is not a breaking change.
  • Fix all the tests

@javiertoledo javiertoledo self-assigned this Nov 2, 2023
@javiertoledo javiertoledo added maintainance refactor Refactor or rearchitecture labels Nov 2, 2023
Copy link
Contributor

github-actions bot commented Nov 2, 2023

Oops, looks like you forgot to add a changeset.

⚠️ Please run rush change and commit the changeset file.

This command will prompt you for a change description and generate a changeset file. You can read more about changesets here.

Remember that you should use the version bump that is appropriate for the change you are making:

Version bump Meaning
patch Bug fixes, documentation changes, etc.
minor New features, non-breaking changes
major Breaking changes

If you are unsure about which version bump to use, please ask in the comments and we will help you out.

@javiertoledo javiertoledo force-pushed the refactor/reworked-core-exported-static-methods branch from f2572cf to 18f0435 Compare November 6, 2023 23:25
@javiertoledo javiertoledo marked this pull request as ready for review November 7, 2023 00:10
@javiertoledo
Copy link
Member Author

/integration sha=00adf90abd8b29bb0f3eb46c9462a07ff6e9612a

Copy link
Contributor

github-actions bot commented Nov 7, 2023

⌛ Integration tests are running...

Check their status here 👈

Copy link
Contributor

github-actions bot commented Nov 7, 2023

✅ Integration tests have finished successfully!

@javiertoledo javiertoledo force-pushed the refactor/reworked-core-exported-static-methods branch from 00adf90 to d2e57fe Compare February 1, 2024 21:10
@javiertoledo
Copy link
Member Author

/integration sha=d2e57fecc55aaaf0644d6804b485b6b12ef4ed27

Copy link
Contributor

github-actions bot commented Feb 1, 2024

⌛ Integration tests are running...

Check their status here 👈

Copy link
Contributor

github-actions bot commented Feb 1, 2024

✅ Integration tests have finished successfully!

Copy link
Member

@NickSeagull NickSeagull left a comment

Choose a reason for hiding this comment

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

LGTM

@javiertoledo javiertoledo merged commit 35d9b6e into main Feb 2, 2024
6 checks passed
@javiertoledo javiertoledo deleted the refactor/reworked-core-exported-static-methods branch February 2, 2024 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintainance refactor Refactor or rearchitecture
Projects
Development

Successfully merging this pull request may close these issues.

2 participants