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

Organize versioning library #3309

Merged

Conversation

timotheeguerin
Copy link
Member

@timotheeguerin timotheeguerin commented May 9, 2024

Versioning library is a big mess of things all into one file, this makes it hard to contribute. Did this originally because I was going to deal with multiple madeRequired and madeOptional over time but that will be done later but finished the cleanup anyway.

Split the versioning.ts into multiple separate logical files:

  • decorators.ts: Contains all the versioning decorators and accessor
  • internal-projection-functions.ts: Contains implementation of the helper function used inside the versioning projection(not meant for external use)
  • projection.ts: Contains the projection building functions
  • versioning.ts: Contains the various versioning computation function(timeline, etc.)

This makes it clearer of what is supposed to be public apis vs internal, waht is just mean for decorator, projection, etc.

@azure-sdk
Copy link
Collaborator

azure-sdk commented May 9, 2024

All changed packages have been documented.

  • @typespec/versioning
Show changes

@typespec/versioning - internal ✏️

Organize versioning library

@azure-sdk
Copy link
Collaborator

You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/3309/

Check the website changes at https://tspwebsitepr.z22.web.core.windows.net/prs/3309/

@timotheeguerin timotheeguerin added this pull request to the merge queue May 23, 2024
Merged via the queue into microsoft:main with commit 0a70aa7 May 23, 2024
21 checks passed
@timotheeguerin timotheeguerin deleted the versioning-library-cleanup branch May 23, 2024 23:00
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.

None yet

4 participants