Skip to content

Commit f0f316b

Browse files
committed
Update Liberty Dashboard references to Liberty Tools
1 parent 6ba6de4 commit f0f316b

9 files changed

Lines changed: 113 additions & 112 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ Liberty Tools for Visual Studio Code depends on the [Tools for MicroProfile](htt
6666
- Install [Liberty Tools for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=Open-Liberty.liberty-dev-vscode-ext)
6767
- Select a project in the Liberty dashboard to view the available commands.
6868

69-
Projects with the Liberty Maven Plugin or Liberty Gradle Plugin configured will appear in the Liberty Dashboard on the sidebar.
69+
Projects with the Liberty Maven Plugin or Liberty Gradle Plugin configured will appear in Liberty Tools on the sidebar.
7070

7171
For minimum requirements information and detailed instructions on how to use the Liberty commands, check out the [Liberty Tools for Visual Studio Code user guide](docs/user-guide.md) page.
7272

7373
## Commands
7474

75-
The following commands are available when you select a project in the Liberty Dashboard.
75+
The following commands are available when you select a project in Liberty Tools.
7676

7777
| Command | Description |
7878
| --- | --- |

docs/user-guide.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ For information regarding known issues and limitations, refer to our [Common Iss
99
- [Configure your Java runtime for language servers](#configure-your-java-runtime-for-language-servers)
1010
- [External extension settings](#external-extension-settings)
1111
- [Terminal shell support](#terminal-shell-support)
12-
- [Open the Liberty dashboard](#open-the-liberty-dashboard)
12+
- [Open Liberty Tools](#open-liberty-tools)
1313
- [Run your application on Liberty using dev mode](#run-your-application-on-liberty-using-dev-mode)
14-
- [Use the Liberty dashboard](#use-the-liberty-dashboard)
14+
- [Use Liberty Tools](#use-liberty-tools)
1515
- [Use the Visual Studio Code Command Palette](#use-the-visual-studio-code-command-palette)
1616
- [Start your application in dev mode](#start-your-application-in-dev-mode)
1717
- [Start your application in dev mode in a container](#start-your-application-in-dev-mode-in-a-container)
@@ -20,7 +20,7 @@ For information regarding known issues and limitations, refer to our [Common Iss
2020
- [View your application test reports](#view-your-application-test-reports)
2121
- [Stop your application](#stop-your-application)
2222
- [Debug your application](#debug-your-application)
23-
- [Manually add your Liberty project to the Liberty dashboard](#manually-add-your-liberty-project-to-the-liberty-dashboard)
23+
- [Manually add your Liberty project to Liberty Tools](#manually-add-your-liberty-project-to-liberty-tools)
2424
- [Manually remove project](#manually-remove-project)
2525
- [Configure a Liberty server](#configure-a-liberty-server)
2626
- [Develop with Jakarta EE and MicroProfile APIs](#develop-with-jakarta-ee-and-microprofile-apis)
@@ -87,31 +87,31 @@ Liberty Tools supports the default shell types for each OS in the Visual Studio
8787

8888
It may be possible to use other shell types, but support is not guaranteed. Please feel free to open an enhancement issue if your preferred shell type is not supported: https://github.com/OpenLiberty/liberty-tools-vscode/issues.
8989

90-
## Open the Liberty dashboard
90+
## Open Liberty Tools
9191

92-
By default, the Liberty dashboard appears in the Project Explorer side bar. Optionally, you can drag the Liberty dashboard into the Activity Bar.
92+
By default, Liberty Tools appears in the Project Explorer side bar. Optionally, you can drag Liberty Tools into the Activity Bar.
9393

9494
| Side Bar view | Activity Bar view |
9595
| ------ | ----- |
96-
| ![Liberty Dashboard Side Bar view](/docs/user-guide-screenshots/liberty_dashboard_side_bar.png) | ![Liberty Dashboard Activity Bar view](/docs/user-guide-screenshots/liberty_dashboard_activity_bar.png)|
96+
| ![Liberty Tools Side Bar view](/docs/user-guide-screenshots/liberty_dashboard_side_bar.png) | ![Liberty Tools Activity Bar view](/docs/user-guide-screenshots/liberty_dashboard_activity_bar.png)|
9797

98-
Projects that are already properly configured to run on Liberty and use Liberty dev mode are automatically added the Liberty dashboard when it opens. If your Liberty project does not show up in the Liberty dashboard automatically and you have the Liberty Maven or Liberty Gradle plugin configured, check out [how to manually add your project to the Liberty dashboard](#manually-add-your-liberty-project-to-the-dashboard).
98+
Projects that are already properly configured to run on Liberty and use Liberty dev mode are automatically added to Liberty Tools when it opens. If your Liberty project does not show up in Liberty Tools automatically and you have the Liberty Maven or Liberty Gradle plugin configured, check out [how to manually add your project to Liberty Tools](#manually-add-your-liberty-project-to-liberty-tools).
9999

100-
If you add new projects or make changes, use the refresh icon in the Liberty dashboard toolbar to refresh the dashboard view.
100+
If you add new projects or make changes, use the refresh icon in the Liberty Tools toolbar to refresh the view.
101101

102102
![Dashboard Refresh highlighted](/docs/user-guide-screenshots/dashboardToolbarRefresh.png)
103103

104104
## Run your application on Liberty using dev mode
105105

106-
The following three menu actions are available to start your Liberty application in dev mode through the Liberty dashboard or the Visual Studio Code command palette:
106+
The following three menu actions are available to start your Liberty application in dev mode through Liberty Tools or the Visual Studio Code command palette:
107107

108108
- [Start your application in dev mode](#start-your-application-in-dev-mode)
109109
- [Start your application in dev mode with configuration](#start-your-application-in-dev-mode-with-configuration)
110110
- [Start your application in dev mode in a container](#start-your-application-in-dev-mode-in-a-container)
111111

112-
### Use the Liberty dashboard
112+
### Use Liberty Tools
113113

114-
The Liberty dashboard provides a context menu for Liberty projects. You can choose different commands from the menu to speed up application development.
114+
Liberty Tools provides a context menu for Liberty projects. You can choose different commands from the menu to speed up application development.
115115

116116
![Dashboard context menu](/docs/user-guide-screenshots/liberty_dashboard_contextual.png)
117117

@@ -125,15 +125,15 @@ All Liberty Tools commands that are described in the following sections are also
125125

126126
### Start your application in dev mode
127127

128-
To start your application in dev mode, select the **Start** command for your application in the Liberty dashboard.
128+
To start your application in dev mode, select the **Start** command for your application in Liberty Tools.
129129

130130
A new terminal tab opens to run the application in dev mode.
131131

132132
![Start command started](/docs/user-guide-screenshots/devModeStarted.png)
133133

134134
### Start your application in dev mode with configuration
135135

136-
To start your application in dev mode with custom configuration, select the **Start...** command for your application in the Liberty dashboard. The command opens an edit dialog where you can specify parameters for the [Liberty Maven dev goal](https://github.com/OpenLiberty/ci.maven/blob/main/docs/dev.md#additional-parameters) or [Liberty Gradle dev task](https://github.com/OpenLiberty/ci.gradle/blob/main/docs/libertyDev.md#command-line-parameters).
136+
To start your application in dev mode with custom configuration, select the **Start...** command for your application in Liberty Tools. The command opens an edit dialog where you can specify parameters for the [Liberty Maven dev goal](https://github.com/OpenLiberty/ci.maven/blob/main/docs/dev.md#additional-parameters) or [Liberty Gradle dev task](https://github.com/OpenLiberty/ci.gradle/blob/main/docs/libertyDev.md#command-line-parameters).
137137

138138
![Liberty Start... command](/docs/user-guide-screenshots/devModeStartCustom.png)
139139

@@ -147,7 +147,7 @@ The next time you choose to start dev mode with configuration, the menu provides
147147

148148
### Start your application in dev mode in a container
149149

150-
To use dev mode for containers, select the **Start in container** command for your application in the Liberty dashboard.
150+
To use dev mode for containers, select the **Start in container** command for your application in Liberty Tools.
151151

152152
![Liberty Start in container command](/docs/user-guide-screenshots/devModeStartContainer.png)
153153

@@ -157,7 +157,7 @@ For more information on dev mode for containers, check out the [Liberty Maven de
157157

158158
After your application is running on Liberty using dev mode, you can easily run the tests provided by your application.
159159

160-
To run tests, select the **Run tests** command for your application in the Liberty dashboard.
160+
To run tests, select the **Run tests** command for your application in Liberty Tools.
161161

162162
The tests are run in the corresponding terminal.
163163

@@ -171,23 +171,23 @@ After you finish running your application tests, you can access the produced tes
171171

172172
### Maven-built applications
173173

174-
To view the integration test report for Maven-built applications, select the **View integration test report** command for your application in the Liberty dashboard.
174+
To view the integration test report for Maven-built applications, select the **View integration test report** command for your application in Liberty Tools.
175175

176176
This command looks for the integration test report at the `/target/site/failsafe-report.html` default location.
177177

178-
To view the unit test report for Maven-built applications, select the **View unit test report** command for your application in the Liberty dashboard.
178+
To view the unit test report for Maven-built applications, select the **View unit test report** command for your application in Liberty Tools.
179179

180180
This command looks for the unit test report at the`/target/site/surefire-report.html` default location.
181181

182182
### Gradle-built applications
183183

184-
To view the test report for Gradle-built applications, select the **View test report** command for your application in the Liberty dashboard.
184+
To view the test report for Gradle-built applications, select the **View test report** command for your application in Liberty Tools.
185185

186186
This command looks for the test report at the `build/reports/tests/test/index.html` default location.
187187

188188
## Stop your application
189189

190-
To stop your application, select the **Stop** command for your application in the Liberty dashboard.
190+
To stop your application, select the **Stop** command for your application in Liberty Tools.
191191

192192
![Stop command](/docs/user-guide-screenshots/devModeStop.png)
193193

@@ -201,30 +201,30 @@ When the debugger is attached, the Visual Studio Code [debug options](https://co
201201

202202
![Debug Mode](/docs/user-guide-screenshots/debugger_mode.png)
203203

204-
## Manually add your Liberty project to the Liberty dashboard
204+
## Manually add your Liberty project to Liberty Tools
205205

206-
If your Liberty project is not automatically detected by the Liberty dashboard, you can manually add your Liberty project to the Liberty dashboard in one of four ways:<br>
207-
* Click the plus icon (+) in the Liberty dashboard.<br>
208-
![Add Liberty project from Liberty dashboard](/docs/user-guide-screenshots/add_from_liberty_dashboard.png)<br>
209-
* Right-click into an empty space in the Explorer view and select **Add project to Liberty Dashboard**.<br>
206+
If your Liberty project is not automatically detected by Liberty Tools, you can manually add your Liberty project to Liberty Tools in one of four ways:<br>
207+
* Click the plus icon (+) in Liberty Tools.<br>
208+
![Add Liberty project from Liberty Tools](/docs/user-guide-screenshots/add_from_liberty_dashboard.png)<br>
209+
* Right-click into an empty space in the Explorer view and select **Add project to Liberty Tools**.<br>
210210
![Add Liberty project from Explorer view empty space](/docs/user-guide-screenshots/add_from_empty_space.png)<br>
211-
* If you have a workspace open, you also have the option to right-click on a project root folder in the Explorer view and select **Add project to Liberty Dashboard**.<br>
211+
* If you have a workspace open, you also have the option to right-click on a project root folder in the Explorer view and select **Add project to Liberty Tools**.<br>
212212
![Add Liberty project from Explorer view project root](/docs/user-guide-screenshots/add_from_project_root_folder.png)<br>
213-
* Use the Command Palette to select the **Liberty: Add project to Liberty Dashboard** command.<br>
213+
* Use the Command Palette to select the **Liberty: Add project to Liberty Tools** command.<br>
214214
![Add Liberty project from Command Palette](/docs/user-guide-screenshots/add_from_command_palette.png)<br>
215215

216-
In each of these cases, you are prompted in the Command Palette to select a project from a list of projects that are currently not displayed in the Liberty dashboard.<br>
216+
In each of these cases, you are prompted in the Command Palette to select a project from a list of projects that are currently not displayed in Liberty Tools.<br>
217217
![Liberty add project selection](/docs/user-guide-screenshots/add_project_selection.png)<br>
218218

219219
### Manually remove project
220220

221-
To remove manually added Liberty projects from the Liberty dashboard, you have a similar set of four options:
222-
* Click the minus icon (-) in the Liberty dashboard.
223-
* Right-click into an empty space in the Explorer view and select **Remove project from Liberty Dashboard**.
224-
* If you have a workspace open, you also have the option to right-click on a project root folder in the Explorer view and select **Remove project from Liberty Dashboard**.
225-
* Use the Command Palette to select the **Liberty: Remove project from Liberty Dashboard** command.
221+
To remove manually added Liberty projects from Liberty Tools, you have a similar set of four options:
222+
* Click the minus icon (-) in Liberty Tools.
223+
* Right-click into an empty space in the Explorer view and select **Remove project from Liberty Tools**.
224+
* If you have a workspace open, you also have the option to right-click on a project root folder in the Explorer view and select **Remove project from Liberty Tools**.
225+
* Use the Command Palette to select the **Liberty: Remove project from Liberty Tools** command.
226226

227-
Similar to adding the project, you are prompted in the Command Palette to select a project from a list of projects in the Liberty dashboard that can be removed.
227+
Similar to adding the project, you are prompted in the Command Palette to select a project from a list of projects in Liberty Tools that can be removed.
228228

229229
## Configure a Liberty server
230230

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "liberty-dev-vscode-ext",
33
"displayName": "Liberty Tools",
44
"description": "Liberty Tools for Visual Studio Code",
5-
"version": "25.0.12-SNAPSHOT",
5+
"version": "26.0.4-SNAPSHOT",
66
"publisher": "Open-Liberty",
77
"repository": {
88
"type": "git",
@@ -248,6 +248,7 @@
248248
"watch": "webpack --mode development --watch --info-verbosity verbose",
249249
"test-compile": "tsc -p ./",
250250
"build": "gulp downloadLibertyLSJars downloadLSP4JakartaJars",
251+
"downloadLCLS": "gulp downloadLibertyLSJars",
251252
"buildLcls": "gulp buildLemminxLiberty buildLibertyServer",
252253
"buildJakarta": "gulp buildJakartaJdt buildJakartaLs",
253254
"test": "npm run test-compile && extest setup-and-run -o .vscode/settings.json 'out/test/*.js' --code_settings src/test/resources/settings.json",

package.nls.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"views.explorer.name": "Liberty Dashboard",
2+
"views.explorer.name": "Liberty Tools",
33
"commands.title.refresh": "Refresh projects",
44
"commands.title.start": "Start",
55
"commands.title.debug": "Attach debugger",
@@ -10,9 +10,9 @@
1010
"commands.title.view.integration.test.report": "View integration test report",
1111
"commands.title.view.unit.test.report": "View unit test report",
1212
"commands.title.view.test.report": "View test report",
13-
"commands.title.add.project": "Add project to Liberty Dashboard",
14-
"commands.title.remove.project": "Remove project from Liberty Dashboard",
13+
"commands.title.add.project": "Add project to Liberty Tools",
14+
"commands.title.remove.project": "Remove project from Liberty Tools",
1515
"commands.title.show.commands": "Show Liberty commands",
16-
"views.welcome.message": "\n 1. If no projects are open in the Explorer, open or create a Liberty project using the File menu.\n[Open Project](command:vscode.openFolder) \n 2. If one or more existing Maven or Gradle projects are open in the Explorer, try one of the following actions:\n a. Configure the Liberty build plugin in the build file of an existing [Maven](https://github.com/OpenLiberty/ci.maven/#configuration) or [Gradle](https://github.com/OpenLiberty/ci.gradle#adding-the-plugin-to-the-build-script) project.\n b. Add a [server.xml file](https://openliberty.io/docs/latest/reference/config/server-configuration-overview.html#server-xml) to an existing Maven or Gradle project at src/main/liberty/config. \n c. Manually add an existing Maven or Gradle project to the Liberty Dashboard through the Command Palette action Liberty: Add project to Liberty Dashboard”.\n [Add project to Liberty Dashboard](command:liberty.dev.add.project)"
16+
"views.welcome.message": "\n 1. If no projects are open in the Explorer, open or create a Liberty project using the File menu.\n[Open Project](command:vscode.openFolder) \n 2. If one or more existing Maven or Gradle projects are open in the Explorer, try one of the following actions:\n a. Configure the Liberty build plugin in the build file of an existing [Maven](https://github.com/OpenLiberty/ci.maven/#configuration) or [Gradle](https://github.com/OpenLiberty/ci.gradle#adding-the-plugin-to-the-build-script) project.\n b. Add a [server.xml file](https://openliberty.io/docs/latest/reference/config/server-configuration-overview.html#server-xml) to an existing Maven or Gradle project at \"src/main/liberty/config\". \n c. Manually add an existing Maven or Gradle project to Liberty Tools through the Command Palette action \"Liberty: Add project to Liberty Tools\".\n [Add project to Liberty Tools](command:liberty.dev.add.project)"
1717

1818
}

src/liberty/libertyProject.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ export class ProjectProvider implements vscode.TreeDataProvider<LibertyProject>
170170
const project = await this.createLibertyProject(p.path, p.contextValue);
171171
if ( project !== undefined) {
172172
this.projects.set(p.path, project);
173-
console.debug("Project " + p.path + " added to Liberty Dashboard");
173+
console.debug("Project " + p.path + " added to Liberty Tools");
174174
} else {
175175
// add to remove list
176176
projectsToBeRemoved.push(p);

0 commit comments

Comments
 (0)