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

[WIP] Add the introduction of emitters for sdk clients. #5663

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lirenhe
Copy link
Member

@lirenhe lirenhe commented Jan 20, 2025

To resolve #5339

Add the introduction to describe the location, the configuration and how to run the client emitters for Java, Python, JS and .NET.

The doc currently only contain the common content and it needs the contribution for all language owners.

cc @lmazuel

To resolve #5339

Add the introduction to describe the location, the configuration and how to run the client emitters for Java, Python, JS and .NET.
@microsoft-github-policy-service microsoft-github-policy-service bot added the meta:website TypeSpec.io updates label Jan 20, 2025
@azure-sdk
Copy link
Collaborator

No changes needing a change description found.

@azure-sdk
Copy link
Collaborator

azure-sdk commented Jan 20, 2025

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs 🛝 VSCode Extension

@lirenhe
Copy link
Member Author

lirenhe commented Jan 20, 2025

Need each language owner to update their language specific contents:

Java: @weidongxu-microsoft
JS: @MaryGao
Python: @msyyc
.NET: @ArthurMa1978

| ---------------------------- | ------------ | ------------------------ | ------------------------ |
| @azure-tools/typespec-ts | JavaScript | `0.37.0` | `emitter-output-dir` |
| @typespec/http-client-python | Python | `0.6.0` | `emitter-output-dir` |
| @typespec/http-client-java | Java | `0.1.6` | `emitter-output-dir` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we use latest in package version?

I am not sure whether providing a specific version would be helpful for customer, while dev could forget to update the number here when releasing new version of the lib, and making this doc outdated.

Copy link
Member Author

@lirenhe lirenhe Jan 21, 2025

Choose a reason for hiding this comment

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

I already added the below notes:

Note: Check for the Latest Version

To ensure you are using the latest version of the packages, visit npmjs.com and search for the relevant packages.

How do you think of the options of
a. always use latest
b. every time, there is a emitter upgrade, we update the version in this file

@weidongxu-microsoft
Copy link
Contributor

weidongxu-microsoft commented Jan 21, 2025

Currently Java emitter does not have important emitter options to add.

We are checking if we need to have a (potentially cross-language) package-name emitter option. E.g. <groupdId>:<artifactId> for Java
(for azure, the <groupId> is com.azure/com.azure.resourcemanager, and <artifactId> is from SDK namespace -- but this is no longer a valid assumption for unbranded)

@lirenhe
Copy link
Member Author

lirenhe commented Jan 21, 2025

Currently Java emitter does not have important emitter options to add.

We are checking if we need to have a (potentially cross-language) package-name emitter option. E.g. <groupdId>:<artifactId> for Java (for azure, the <groupId> is com.azure/com.azure.resourcemanager, and <artifactId> is from SDK namespace -- but this is no longer a valid assumption for unbranded)

If there is no additional options to add, could you put some information like no additional setting needed for Java under

#### Configuration Options for Java

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta:website TypeSpec.io updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a "how to generate" for 3P scenarios
4 participants