vscode-plugin-dx-dashboard-poc README

🔗 https://marketplace.visualstudio.com/items?itemName=jc-sample.vscode-plugin-dx-dashboard-poc

In this extension, a developer can set his themesPath in User Settings, and loads all the directories under it. If there is no listed or available themes there will be the "Set Themes Path" button which will open a select folder dialog box to set the directory where all the themes will be placed under. You can also change themesPath via going to the extension's setting and manually setting it or via the command in the command palette named "DXClient: Set Themes Folder" which will open a select folder dialog box.

📒 NOTE: All first-level dirs under themesPath are considered a theme.

Features

1. A separate Panel in the Activity Bar

2. General Features

   1. Pull All
      • This will trigger DXClient Livesync Pull Theme for each of the existing themes under the tree which will download theme files to a directory named with the respective theme name under themesPath.
   2. Push New Theme
      • This will provide the user selection of all theme folder names in the server. The user chooses one to pull which will trigger DXClient Livesync Pull Theme to download theme files to a directory named with the chosen theme name under themesPath. If the chosen theme is new locally, do not have a directory named after it, a new directory will be created named after it.
   3. Refresh
      • This will refresh the listed themes that is under themesPath.

3. The features available for each listed theme

   1. Pull theme
      • This will trigger DXClient Livesync Pull Theme using the chosen theme to download theme files to the directory named after it under themesPath.
   2. Unwatch
      • This will terminate the watching process if there is one for this particular theme.
   3. Watch
      • This will trigger DXClient Livesync Push Theme for this particular theme and start a watching process for the directory named of after it in the themesPath and push the subsequent changes.

4. The statusbar will display the server hostname you are connected to and the number of running processes of DXClient there are.

Requirements

There should be an installed dxclient in your local. It should also be exposed as dxclient as if calling dxclient -V anywhere should work.

Extension Settings

This extension contributes the following settings:

• vscodePluginDxDashboardPoc.dxProtocol: Protocol of the DX Core server
• vscodePluginDxDashboardPoc.hostname: Host name of the DX Core server
• vscodePluginDxDashboardPoc.dxPort: Port number of the DX Core server, for any Kubernetes Environment default is 443
• vscodePluginDxDashboardPoc.dxUsername: Username of the DX Core server
• vscodePluginDxDashboardPoc.dxPassword: Password of the DX Core server
• vscodePluginDxDashboardPoc.contenthandlerPath: Alternate path for the portal context root or the content handler servlet
• vscodePluginDxDashboardPoc.themesPath: The parent folder of your Themes.

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines