Skip to content

Commit 585a092

Browse files
authored
Normalize extension naming (#738)
* Rename Java Extensions Guide * Minor phrasing corrections * Normalize name of the redhat.java extension
1 parent acd7533 commit 585a092

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@
212212
{
213213
"command": "java.extGuide",
214214
"category": "Java",
215-
"title": "Extension Guide"
215+
"title": "Extensions Guide"
216216
},
217217
{
218218
"command": "java.formatterSettings",

src/classpath/assets/features/classpathConfiguration/components/Exception.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ const Exception = (): JSX.Element | null => {
2626
case ClasspathViewException.JavaExtensionNotInstalled:
2727
content = (
2828
<div>
29-
<span>The required extension <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.openJavaLanguageSupportMarketPlace", "extension.open", ["redhat.java"])}>Language Support for Java(TM) by Red Hat</a> is not installed or it's disabled. Please <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.installJavaLanguageSupport", "workbench.extensions.installExtension", ["redhat.java"])}>install</a> it in Visual Studio Code and <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.reloadWebview", "workbench.action.webview.reloadWebviewAction")}>reload</a> the page after installation.</span>
29+
<span>The required extension <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.openJavaLanguageSupportMarketPlace", "extension.open", ["redhat.java"])}>Language Support for Java by Red Hat</a> is not installed or it's disabled. Please <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.installJavaLanguageSupport", "workbench.extensions.installExtension", ["redhat.java"])}>install</a> it in Visual Studio Code and <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.reloadWebview", "workbench.action.webview.reloadWebviewAction")}>reload</a> the page after installation.</span>
3030
</div>
3131
);
3232
break;
3333
case ClasspathViewException.StaleJavaExtension:
3434
content = (
3535
<div>
36-
<span>The version of required extension <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.openJavaLanguageSupportMarketPlace", "extension.open", ["redhat.java"])}>Language Support for Java(TM) by Red Hat</a> is too stale. Please <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.installJavaLanguageSupport", "workbench.extensions.installExtension", ["redhat.java"])}>update</a> it and <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.reloadWebview", "workbench.action.webview.reloadWebviewAction")}>reload</a> the page.</span>
36+
<span>The version of required extension <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.openJavaLanguageSupportMarketPlace", "extension.open", ["redhat.java"])}>Language Support for Java by Red Hat</a> is too stale. Please <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.installJavaLanguageSupport", "workbench.extensions.installExtension", ["redhat.java"])}>update</a> it and <a href={encodeCommandUriWithTelemetry(WEBVIEW_ID, "classpath.reloadWebview", "workbench.action.webview.reloadWebviewAction")}>reload</a> the page.</span>
3737
</div>
3838
);
3939
break;

src/ext-guide/assets/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
<head>
55
<meta charset="UTF-8">
66
<meta http-equiv="Content-Security-Policy" content="default-src 'unsafe-inline'">
7-
<title>Java Extension Guide</title>
7+
<title>Java Extensions Guide</title>
88
</head>
99

1010
<body>
1111
<div class="container mt-5 mb-5">
1212
<div class="row mb-3">
1313
<div class="col">
14-
<h1 class="font-weight-light">Java Extension Guide</h1>
14+
<h1 class="font-weight-light">Java Extensions Guide</h1>
1515
<h6 class="font-weight-light">Recommended extensions for Java development.</h5>
1616
</div>
1717
</div>

src/ext-guide/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export async function javaExtGuideCmdHandler(context: vscode.ExtensionContext, o
1414
return;
1515
}
1616

17-
javaExtGuideView = vscode.window.createWebviewPanel("java.extGuide", "Java Extension Guide", {
17+
javaExtGuideView = vscode.window.createWebviewPanel("java.extGuide", "Java Extensions Guide", {
1818
viewColumn: vscode.ViewColumn.One,
1919
}, {
2020
enableScripts: true,

src/getting-started/assets/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -319,11 +319,11 @@ <h5 class="font-weight-light">Feedback Channels</h5>
319319
</blockquote>
320320
<h3 class="font-weight-light">Why do I see the JDK errors?</h3>
321321
<p>
322-
<strong><code>JDK 11+</code> is required</strong> to run VS Code Java! You see this error because we failed to find one on your machine. The <a href="command:java.runtime">Configure Java Runtime</a> guide can help you understand how JDK path is searched and provides download links if you need to install one.
322+
<strong><code>JDK 11+</code> is required</strong> to run the Java language support (redhat.java) extension! You see this error because we failed to find one on your machine. The <a href="command:java.runtime">Configure Java Runtime</a> guide can help you understand how JDK path is searched and provides download links if you need to install one.
323323
</p>
324324
<h3 class="font-weight-light">Can I run my Java 8 project with JDK 1.8?</h3>
325325
<p>
326-
Yes. JDK 11 requirement is just for running VS Code Java extension itself, you can still configure a different runtime <a href="command:java.helper.openUrl?%22https%3A%2F%2Fcode.visualstudio.com%2Fdocs%2Fjava%2Fjava-project%23_jdk-for-projects%22">JDK for your project</a> via user setting <a href="command:workbench.action.openSettings?%22java.configuration.runtimes%22">"java.configuration.runtimes"</a>. The extension will pick a mapping JDK to compile/run your project according to the compiler version specified by the project build file.
326+
Yes. The JDK 11 requirement is just for running the Java language support (redhat.java) extension itself. You can still configure a different runtime <a href="command:java.helper.openUrl?%22https%3A%2F%2Fcode.visualstudio.com%2Fdocs%2Fjava%2Fjava-project%23_jdk-for-projects%22">JDK for your project</a> via the user setting <a href="command:workbench.action.openSettings?%22java.configuration.runtimes%22">"java.configuration.runtimes"</a>. The extension will pick a matching JDK to compile/run your project according to the compiler version specified by the project build file.
327327
<pre>
328328
"java.configuration.runtimes": [
329329
{

src/java-runtime/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ export async function findJavaRuntimeEntries(): Promise<{
206206
javaDotHome = runtime.java_home;
207207
const javaVersion = runtime.java_version;
208208
if (!javaVersion || javaVersion < 11) {
209-
javaHomeError = `Java 11 or more recent is required to run the Java extension. Preferred JDK "${javaDotHome}" (version ${javaVersion}) doesn't meet the requirement. Please specify or install a recent JDK.`;
209+
javaHomeError = `Java 11 or more recent is required by the Java language support (redhat.java) extension. Preferred JDK "${javaDotHome}" (version ${javaVersion}) doesn't meet the requirement. Please specify or install a recent JDK.`;
210210
}
211211
} catch (error) {
212212
javaHomeError = error.message;

src/java-runtime/utils/upstreamApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export async function resolveRequirements(): Promise<any> {
4949
}
5050

5151
if (javaVersion < REQUIRED_JDK_VERSION) {
52-
let message = `Java ${REQUIRED_JDK_VERSION} or more recent is required to run the Java extension.`;
52+
let message = `Java ${REQUIRED_JDK_VERSION} or more recent is required by the Java language support (redhat.java) extension.`;
5353
if (javaHome) {
5454
message += `(Current JDK: ${javaHome})`;
5555
}

src/overview/assets/index.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,32 +47,32 @@ <h3 class="font-weight-light">Key Bindings</h3>
4747
<div class="row mb-3">
4848
<div class="col">
4949
<h3 class="font-weight-light">Extensions</h3>
50-
<div ext="redhat.java" displayName="Java Language Support by Red Hat">
51-
<a href="#" title="Install Java Language Support extension...">Install Java Language Support by Red Hat</a>
50+
<div ext="redhat.java" displayName="Language Support for Java by Red Hat">
51+
<a href="#" title="Install the Java language support extension...">Install Language Support for Java by Red Hat</a>
5252
</div>
5353
<div ext="vscjava.vscode-java-debug" displayName="Debugger for Java">
54-
<a href="#" title="Install Debugger for Java extension...">Install Debugger for Java</a>
54+
<a href="#" title="Install the Debugger for Java extension...">Install Debugger for Java</a>
5555
</div>
5656
<div ext="vscjava.vscode-java-test" displayName="Java Test Runner">
57-
<a href="#" title="Install Java Test Runner extension...">Install Java Test Runner</a>
57+
<a href="#" title="Install the Java Test Runner extension...">Install Java Test Runner</a>
5858
</div>
5959
<div ext="vscjava.vscode-maven" displayName="Maven for Java">
60-
<a href="#" title="Install Maven for Java extension...">Install Maven for Java</a>
60+
<a href="#" title="Install the Maven for Java extension...">Install Maven for Java</a>
6161
</div>
6262
<div ext="SonarSource.sonarlint-vscode" displayName="SonarLint">
6363
<a href="#" title="Install SonarLint...">Install SonarLint</a>
6464
</div>
6565
<div ext="adashen.vscode-tomcat" displayName="Tomcat for Java">
66-
<a href="#" title="Install Tomcat for Java extension...">Install Tomcat for Java</a>
66+
<a href="#" title="Install the Tomcat for Java extension...">Install Tomcat for Java</a>
6767
</div>
6868
<div ext="shengchen.vscode-checkstyle" displayName="Checkstyle for Java">
69-
<a href="#" title="Install Checkstyle for Java extension...">Install Checkstyle for Java</a>
69+
<a href="#" title="Install the Checkstyle for Java extension...">Install Checkstyle for Java</a>
7070
</div>
7171
<div ext="redhat.vscode-xml" displayName="XML">
7272
<a href="#" title="Schema validation when editing pom.xml...">Install XML extension</a>
7373
</div>
7474
<div ext="vscjava.vscode-java-dependency" displayName="Project Manager for Java">
75-
<a href="#" title="Install Project Manager for Java extension...">Install Project Manager for Java</a>
75+
<a href="#" title="Install the Project Manager for Java extension...">Install Project Manager for Java</a>
7676
</div>
7777
</div>
7878
</div>
@@ -171,8 +171,8 @@ <h3 class="font-weight-light">Configuration</h3>
171171
<p class="mb-1">Configure Java Runtime</p>
172172
<small>Setup JDKs for projects and VS Code Java.</small>
173173
</a>
174-
<a href="javascript:void(0)" command="java.extGuide" class="list-group-item list-group-item-action flex-column align-items-start btn btn-link mb-2 p-2" title="Open Extension Guide">
175-
<p class="mb-1">Extension Guide</p>
174+
<a href="javascript:void(0)" command="java.extGuide" class="list-group-item list-group-item-action flex-column align-items-start btn btn-link mb-2 p-2" title="Open Extensions Guide">
175+
<p class="mb-1">Extensions Guide</p>
176176
<small>Recommended extensions for Java development.</small>
177177
</a>
178178
<a href="javascript:void(0)" command="workbench.action.openSettings" args='"java."' class="list-group-item list-group-item-action flex-column align-items-start btn btn-link mb-2 p-2" title="Open Java Settings">

0 commit comments

Comments
 (0)