Skip to content

Commit ffbf66c

Browse files
basic unbranded readme
1 parent 9361ea9 commit ffbf66c

File tree

4 files changed

+42
-11
lines changed

4 files changed

+42
-11
lines changed

packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/Javagen.java

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -281,16 +281,19 @@ protected JavaPackage writeToTemplates(CodeModel codeModel, Client client, JavaS
281281
// Readme, Changelog
282282
if (settings.isSdkIntegration()) {
283283
javaPackage.addReadmeMarkdown(project);
284-
if (generateSwaggerMarkdown) {
285-
javaPackage.addSwaggerReadmeMarkdown(project);
286-
}
287-
javaPackage.addChangelogMarkdown(project);
288284

289-
// test proxy asserts.json
290-
javaPackage.addTestProxyAssetsJson(project);
285+
if (settings.isBranded()) {
286+
if (generateSwaggerMarkdown) {
287+
javaPackage.addSwaggerReadmeMarkdown(project);
288+
}
289+
javaPackage.addChangelogMarkdown(project);
290+
291+
// test proxy asserts.json
292+
javaPackage.addTestProxyAssetsJson(project);
291293

292-
// Blank readme sample
293-
javaPackage.addProtocolExamplesBlank();
294+
// Blank readme sample
295+
javaPackage.addProtocolExamplesBlank();
296+
}
294297
}
295298
}
296299
return javaPackage;

packages/http-client-java/generator/http-client-generator-core/src/main/java/com/microsoft/typespec/http/client/generator/core/template/ReadmeTemplate.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
package com.microsoft.typespec.http.client.generator.core.template;
55

6+
import com.microsoft.typespec.http.client.generator.core.extension.plugin.JavaSettings;
67
import com.microsoft.typespec.http.client.generator.core.model.projectmodel.Project;
78
import com.microsoft.typespec.http.client.generator.core.util.TemplateUtil;
89
import java.io.UnsupportedEncodingException;
@@ -12,7 +13,8 @@
1213
public class ReadmeTemplate {
1314

1415
public String write(Project project) {
15-
return TemplateUtil.loadTextFromResource("Readme_protocol.txt", TemplateUtil.SERVICE_NAME,
16+
String templateReadme = JavaSettings.getInstance().isBranded() ? "Readme_protocol.txt" : "Readme_unbranded.txt";
17+
return TemplateUtil.loadTextFromResource(templateReadme, TemplateUtil.SERVICE_NAME,
1618
project.getServiceName(), TemplateUtil.SERVICE_DESCRIPTION, project.getServiceDescriptionForMarkdown(),
1719
TemplateUtil.GROUP_ID, project.getGroupId(), TemplateUtil.ARTIFACT_ID, project.getArtifactId(),
1820
TemplateUtil.ARTIFACT_VERSION, project.getVersion(), TemplateUtil.PACKAGE_NAME, project.getNamespace());
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# {{service-name}} client library for Java
2+
3+
{{service-name}} client library for Java.
4+
5+
{{service-description}}
6+
7+
## Getting started
8+
9+
### Prerequisites
10+
11+
- [Java Development Kit (JDK)][jdk] with version 8 or above
12+
13+
### Adding the package to your product
14+
15+
[//]: # ({x-version-update-start;{{group-id}}:{{artifact-id}};current})
16+
```xml
17+
<dependency>
18+
<groupId>{{group-id}}</groupId>
19+
<artifactId>{{artifact-id}}</artifactId>
20+
<version>{{artifact-version}}</version>
21+
</dependency>
22+
```
23+
[//]: # ({x-version-update-end})
24+
25+
## Examples
26+
27+
<!-- LINKS -->
28+
[jdk]: https://learn.microsoft.com/azure/developer/java/fundamentals/

packages/http-client-java/generator/http-client-generator/src/main/java/com/microsoft/typespec/http/client/generator/TypeSpecPlugin.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -290,8 +290,6 @@ public TypeSpecPlugin(EmitterOptions options, boolean sdkIntegration) {
290290
}
291291

292292
if (options.getFlavor() != null && !"azure".equalsIgnoreCase(options.getFlavor())) {
293-
SETTINGS_MAP.put("sdk-integration", false);
294-
295293
SETTINGS_MAP.put("sync-methods", "sync-only");
296294
SETTINGS_MAP.put("enable-page-size", false);
297295
SETTINGS_MAP.put("use-default-http-status-code-to-exception-type-mapping", false);

0 commit comments

Comments
 (0)