Skip to content

Commit

Permalink
Smaller multiple gifs for README
Browse files Browse the repository at this point in the history
  • Loading branch information
usernamehw committed Jun 19, 2021
1 parent b1caa35 commit 2359574
Show file tree
Hide file tree
Showing 9 changed files with 101 additions and 60 deletions.
6 changes: 4 additions & 2 deletions .vscodeignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,7 @@ webpack.config.js
scripts

dist/extension.js.LICENSE.txt
img/extension_demo.gif
LICENSE
LICENSE

img/*.*
!img/icon.png
155 changes: 97 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,105 @@
[![Rating](https://vsmarketplacebadge.apphb.com/rating-short/usernamehw.commands.svg)](https://marketplace.visualstudio.com/items?itemName=usernamehw.commands)
[![Trending](https://vsmarketplacebadge.apphb.com/trending-monthly/usernamehw.commands.svg)](https://marketplace.visualstudio.com/items?itemName=usernamehw.commands)

![extension_demo_gif](img/extension_demo.gif)
## Simple command

## Features
```js
"Toggle minimap": {
"command": "editor.action.toggleMinimap",
},
```

![simple](img/simple.gif)

## Command with arguments

```js
"Typing": {
"command": "editor.action.insertSnippet",
"args": {
"snippet": "Typing... ",
},
},
```

![arguments](img/args.gif)

## Multiple commands (sequence)

```js
"Toggle multiple settings": {
"sequence": [
{
"command": "editor.action.toggleMinimap"
},
{
"command": "workbench.action.toggleStatusbarVisibility"
}
]
},
```

![sequence](img/sequence.gif)

## Tree View icons

```js
"GitHub": {
"icon": "github",
},
"Flame": {
"icon": "flame",
"iconColor": "errorForeground",
},
```

![icons](img/tree_icon.png)

## Folders (nested items)

```js
"folder": {
"nestedItems": {
"Flame": {
"icon": "flame",
"iconColor": "errorForeground",
},
"Trusted": {
"icon": "workspace-trusted",
"iconColor": "terminal.ansiGreen",
},
},
},
```

![folder](img/folder.gif)

## Quick Pick `commands.openAsQuickPick`

![quick_pick](img/quick_pick.gif)

## Status Bar

```js
"Toggle line numbers": {
"command": "commands.toggleSetting",
"args": {
"setting": "editor.lineNumbers",
"value": [
"on",
"off",
],
},
"statusBar": {
"alignment": "left",
"text": "🔢",
"priority": -9999,
},
},
```

![status_bar](img/status_bar.gif)

- Execute multiple commands; Execute commands with arguments
- Execute commands from Tree View
- Execute commands from Quick Pick
- Add items to Status Bar
- Add items to Command Palette
- Register command to execute from a keybinding
- Additional commands contributed by this extension

<!-- COMMANDS_START -->
## Commands (4)
Expand Down Expand Up @@ -65,55 +153,6 @@ interface CommandObject {
}
```

## Examples

```js
"commands.commands": {
"Object with \"args\"": {
"command": "type",
"args": {
"text": "!!!",
},
},
// ──────────────────────────────
"Mutliple Commands": {
"sequence": [
{
"command": "editor.action.toggleMinimap",
},
{
"command": "workbench.action.toggleStatusbarVisibility",
},
]
},
// ──────────────────────────────
"Folder": {
"nestedItems": {
"togge minimap (nested item)": {
"command": "editor.action.toggleMinimap",
},
},
},
// ──────────────────────────────
"Icon": {
"command": "help.tweetFeedback",
"icon": "heart",
"iconColor": "editorError.foreground",
},
// ──────────────────────────────
"Status Bar Item": {
"icon": "gear",
"command": "editor.action.toggleMinimap",
"statusBar": {
"alignment": "left",
"text": "🗺",
"priority": -9999,
},
},
},
```


## [Builtin commands (with args)](https://code.visualstudio.com/api/references/commands)

### `type` Type text into active editor
Expand Down
Binary file added img/args.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/folder.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/quick_pick.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/sequence.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/simple.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/status_bar.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/tree_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2359574

Please sign in to comment.