Skip to content

Commit e2b12e0

Browse files
committed
fix: use new keybindings, add imgs to readme
1 parent 8873c43 commit e2b12e0

File tree

6 files changed

+14
-10
lines changed

6 files changed

+14
-10
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,22 @@ comment and bam
1414

1515
## Features
1616

17-
- convert a block or line comment into a JSDoc comment
17+
- convert a line comment into JSDoc and vice versa
18+
![toggle line comment](images/toggle-line.gif)
19+
- convert a block comment into JSDoc and vice versa
20+
![toggle block comment](images/toggle-block.gif)
1821
- generate a new JSDoc comment to start documenting a variable
19-
- convert JSDoc into a regular comment
22+
![generate new JSDoc](images/add.gif)
2023
- generate inline JSDoc for "casting" a value with `@type`
24+
![generate inline JSDoc](images/add-inline.gif)
2125

2226
## Usage
2327

2428
- command: `Toggle JSDoc Comment`
25-
- keyboard shortcut: `ctrl+k ctrl+/` or `cmd+k cmd+/` for MacOS
29+
- keyboard shortcut: `ctrl+r ctrl+/` or `cmd+r cmd+/` for MacOS
2630
- the shortcut uses chords - press the first key combination, release, and then
27-
press the second
28-
- change shortcut in Preferences -> Keyboard Shortcuts -> extension.jsdoc-comment-toggler
31+
press the second (tip: you can hold `ctrl`/`cmd` the whole time)
32+
- change shortcut in Preferences -> Keyboard Shortcuts -> Search "jsdoc-comment-toggler"
2933

3034
## Extension Settings
3135

images/add-inline.gif

55.5 KB
Loading

images/add.gif

73.4 KB
Loading

images/toggle-block.gif

55.7 KB
Loading

images/toggle-line.gif

66.1 KB
Loading

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "jsdoc-comment-toggler",
3-
"version": "1.10.0",
3+
"version": "1.10.1",
44
"preview": true,
55
"displayName": "jsdoc comment toggler",
66
"description": "toggle JSDoc comment on line or selection",
@@ -54,14 +54,14 @@
5454
},
5555
"keybindings": [
5656
{
57-
"key": "ctrl+k ctrl+/",
57+
"key": "ctrl+r ctrl+/",
5858
"command": "jsdoc-comment-toggler.toggle",
59-
"when": "!isMac && editorTextFocus"
59+
"when": "!isMac && editorTextFocus && !editorReadonly"
6060
},
6161
{
62-
"key": "cmd+k cmd+/",
62+
"key": "cmd+r cmd+/",
6363
"command": "jsdoc-comment-toggler.toggle",
64-
"when": "isMac && editorTextFocus"
64+
"when": "isMac && editorTextFocus && !editorReadonly"
6565
}
6666
],
6767
"scripts": {

0 commit comments

Comments
 (0)