Skip to content

Commit 16a7d7b

Browse files
authored
Merge to main (#9)
* Updating display name and fixing readme img paths for marketplace.
1 parent 6c0f130 commit 16a7d7b

3 files changed

Lines changed: 53 additions & 11 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11

22

3-
<img src="./media/readme/brand-banner.png" alt="banner" />
3+
<img src="media/readme/brand-banner.png" alt="banner" />
44

55
# Cloudsmith Visual Studio Code Extension
66

7-
<img src="./media/readme/overview.gif" alt="overview" width="600"/>
7+
<img src="media/readme/overview.gif" alt="overview" width="600"/>
88

9-
<img src="./media/readme/brand-card.png" alt="brand-card" />
9+
<img src="media/readme/brand-card.png" alt="brand-card" />
1010

1111
## Installation
1212

@@ -35,7 +35,7 @@ code-insiders --install-extension cloudsmith-x-x-x.vsix
3535
### Connect
3636
After installing, to connect to your Cloudsmith instance, you need to configure either your Personal API Key or a Service Account Token. Click on the `key` icon from the view menu and enter your credential into the input box. To connect press the `connect` or `refresh` icons.
3737

38-
<img src="./media/readme/configure.gif" alt="configure" width="1000"/>
38+
<img src="media/readme/configure.gif" alt="configure" width="1000"/>
3939

4040
### Settings
4141

@@ -47,7 +47,7 @@ A range of settings are configurable for the extension. See Overview for usage o
4747
* Use Legacy Web App - URLs to Cloudsmith packages will use the legacy Web App instead.
4848

4949

50-
<img src="./media/readme/settings.gif" alt="settings" width="1000"/>
50+
<img src="media/readme/settings.gif" alt="settings" width="1000"/>
5151

5252

5353
## Overview
@@ -61,7 +61,7 @@ The Cloudsmith extension contributes a Cloudsmith view to VS Code. The Cloudsmit
6161
By default the extension returns individual packages. You can display them as [package groups](https://help.cloudsmith.io/docs/package-groups) instead.
6262

6363

64-
<img src="./media/readme/package_view_type.gif" alt="groupBySetting" width="1000"/>
64+
<img src="media/readme/package_view_type.gif" alt="groupBySetting" width="1000"/>
6565

6666
#### Package Details
6767

@@ -88,26 +88,26 @@ You can right-click on each detail and copy the value to the clipboard.
8888
- Last pushed date/time
8989

9090

91-
<img src="./media/readme/package_details.gif" alt="packageDetails" width="350"/>
91+
<img src="media/readme/package_details.gif" alt="packageDetails" width="350"/>
9292

9393
#### Package Context Menus
9494

9595
The right-click menu provides access to the following commands varying depending on whether you have enabled the package groups setting.
9696

97-
<img src="./media/readme/package_context_menu.gif" alt="contextMenu" width="400"/>
97+
<img src="media/readme/package_context_menu.gif" alt="contextMenu" width="400"/>
9898

9999
#### Package Inspect
100100

101101
Selecting inspect will return the raw JSON data for the selected item. By default it will send the output to the `Output` window. You can configure for output to be sent to a new text document instead.
102102

103-
<img src="./media/readme/package_inspect.gif" alt="inspectPackage"/>
103+
<img src="media/readme/package_inspect.gif" alt="inspectPackage"/>
104104

105105
#### Open Package in Cloudsmith
106106

107107
You can open the package directly in your Cloudsmith Web App.
108108

109109

110-
<img src="./media/readme/package_open_browser.gif" alt="openPackage" width="1000"/>
110+
<img src="media/readme/package_open_browser.gif" alt="openPackage" width="1000"/>
111111

112112

113113
## Limitations & known issues

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "cloudsmith-vsc",
33
"publisher": "Cloudsmith",
4-
"displayName": "Cloudsmith",
4+
"displayName": "Cloudsmith VSCode",
55
"description": "Access your artifacts from Cloudsmith instance.",
66
"version": "1.0.0",
77
"license": "SEE LICENSE IN LICENSE",

vsc-extension-quickstart.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Welcome to your VS Code Extension
2+
3+
## What's in the folder
4+
5+
* This folder contains all of the files necessary for your extension.
6+
* `package.json` - this is the manifest file in which you declare your extension and command.
7+
* The sample plugin registers a command and defines its title and command name. With this information VS Code can show the command in the command palette. It doesn’t yet need to load the plugin.
8+
* `extension.js` - this is the main file where you will provide the implementation of your command.
9+
* The file exports one function, `activate`, which is called the very first time your extension is activated (in this case by executing the command). Inside the `activate` function we call `registerCommand`.
10+
* We pass the function containing the implementation of the command as the second parameter to `registerCommand`.
11+
12+
## Get up and running straight away
13+
14+
* Press `F5` to open a new window with your extension loaded.
15+
* Run your command from the command palette by pressing (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and typing `Hello World`.
16+
* Set breakpoints in your code inside `extension.js` to debug your extension.
17+
* Find output from your extension in the debug console.
18+
19+
## Make changes
20+
21+
* You can relaunch the extension from the debug toolbar after changing code in `extension.js`.
22+
* You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
23+
24+
## Explore the API
25+
26+
* You can open the full set of our API when you open the file `node_modules/@types/vscode/index.d.ts`.
27+
28+
## Run tests
29+
30+
* Install the [Extension Test Runner](https://marketplace.visualstudio.com/items?itemName=ms-vscode.extension-test-runner)
31+
* Open the Testing view from the activity bar and click the Run Test" button, or use the hotkey `Ctrl/Cmd + ; A`
32+
* See the output of the test result in the Test Results view.
33+
* Make changes to `test/extension.test.js` or create new test files inside the `test` folder.
34+
* The provided test runner will only consider files matching the name pattern `**.test.js`.
35+
* You can create folders inside the `test` folder to structure your tests any way you want.
36+
37+
## Go further
38+
39+
* [Follow UX guidelines](https://code.visualstudio.com/api/ux-guidelines/overview) to create extensions that seamlessly integrate with VS Code's native interface and patterns.
40+
* [Publish your extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) on the VS Code extension marketplace.
41+
* Automate builds by setting up [Continuous Integration](https://code.visualstudio.com/api/working-with-extensions/continuous-integration).
42+
* Integrate to the [report issue](https://code.visualstudio.com/api/get-started/wrapping-up#issue-reporting) flow to get issue and feature requests reported by users.

0 commit comments

Comments
 (0)