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

[tsp-client] Add a metadata file when generating a client library #9552

Open
catalinaperalta opened this issue Dec 17, 2024 · 2 comments
Open
Assignees
Labels
TypeSpec Issues or feature requests for tooling to support TypeSpec (Cadl)

Comments

@catalinaperalta
Copy link
Member

We need a metadata file to track the dependencies that were used at the time of generating a client library. It should include information about the packages specified in the emitter-package.json (and lock file?). Additionally, it would be good to have data on the tsp-client version that was used to generate.

@catalinaperalta catalinaperalta added the TypeSpec Issues or feature requests for tooling to support TypeSpec (Cadl) label Dec 17, 2024
@catalinaperalta catalinaperalta self-assigned this Dec 17, 2024
@catalinaperalta
Copy link
Member Author

Also add a warning if the spec repo's compiler version is ahead of the emitter's compiler version and warn that this could cause failures.

@catalinaperalta
Copy link
Member Author

catalinaperalta commented Dec 17, 2024

Goals:

  • Warn the tsp-client user that the mismatch may create errors
  • Save a metadata file on successful generation, that contains at the very least the emitter-package.json that was used

Cherry on top for later:

  • Add a way to re-consume the metadata to rebuild the same thing (bypass emitter-package,json and used saved information instead)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
TypeSpec Issues or feature requests for tooling to support TypeSpec (Cadl)
Projects
None yet
Development

No branches or pull requests

1 participant