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: split global type module #63

Merged
merged 27 commits into from
Dec 12, 2023
Merged

refactor: split global type module #63

merged 27 commits into from
Dec 12, 2023

Conversation

ComradeVanti
Copy link
Collaborator

@ComradeVanti ComradeVanti commented Dec 12, 2023

This PR has a whole bunch of new refactors. Mostly this fit into the following categories:

  • Moving types from the global.ts module to own files as well as also extracting functions that act on those types. Also add tests
  • Adding various other utility functions
  • Add a lot of JSDoc

Move editor-version type into corresponding module and move that module into the types folder
Move pkg-info type into corresponding module. Also move that module into types folder.
Rename upm-config to upm-config-io. This is in preparation for moving the UpmConfig type and functions which act on it into own module which should be called upm-config
This will be  its own module so that it can also contain helpers related to the type which do not involve io
Split into multiple types in preparation for further refactors
Move env type into corresponding module
Move ScopedRegistry type to own module and add utility functions with tests
Move PkgManifest type to own module and create helper functions with tests. Also rename the manifest file and corresponding test file to pkg-manifest-io since that is what the module is there for
Also add type documentation where I knew what to write
@favoyang favoyang self-assigned this Dec 12, 2023
@favoyang favoyang self-requested a review December 12, 2023 15:49
Copy link
Member

@favoyang favoyang left a comment

Choose a reason for hiding this comment

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

LGTM.

@favoyang favoyang merged commit bb1c999 into openupm:master Dec 12, 2023
2 checks passed
@ComradeVanti ComradeVanti deleted the split-global-module branch December 17, 2023 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants