Skip to content

Commit a90599c

Browse files
fathulfahmyfathulfahmy
committed
feat: first major release
1 parent a536461 commit a90599c

23 files changed

+794
-391
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ name: Bug report
33
about: Create a report to help us improve
44
title: "[BUG] Example Bug Report Title"
55
labels: bug
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
**Describe the bug**
1110
A clear and concise description of what the bug is.
1211

1312
**To Reproduce**
1413
Steps to reproduce the behavior:
14+
1515
1. Go to '...'
1616
2. Click on '....'
1717
3. Scroll down to '....'
@@ -24,9 +24,9 @@ A clear and concise description of what you expected to happen.
2424
If applicable, add screenshots to help explain your problem.
2525

2626
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
27+
28+
- OS: [e.g. windows, mac, linux]
29+
- Version [e.g. v1.0.13]
3030

3131
**Additional context**
3232
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ name: Feature request
33
about: Suggest an idea for this project
44
title: "[FEAT] Example Feature Request Title"
55
labels: enhancement
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
**Is your feature request related to a problem? Please describe.**

‎.prettierrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

‎.vscode/launch.json‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,13 @@
33
// Hover to view descriptions of existing attributes.
44
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
55
{
6-
"version": "0.2.0",
7-
"configurations": [
8-
{
9-
"name": "Extension",
10-
"type": "extensionHost",
11-
"request": "launch",
12-
"args": [
13-
"--extensionDevelopmentPath=${workspaceFolder}"
14-
]
15-
}
16-
]
17-
}
6+
"version": "0.2.0",
7+
"configurations": [
8+
{
9+
"name": "Extension",
10+
"type": "extensionHost",
11+
"request": "launch",
12+
"args": ["--extensionDevelopmentPath=${workspaceFolder}"]
13+
}
14+
]
15+
}

‎CHANGELOG.md‎

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,43 @@
11
# Change Log
22

3-
## v1.0.13 (07-01-2023)
3+
## v1.1.0 (07-03-2024)
4+
5+
**Changed**
6+
7+
- `ctrl+shift+t` toggle terminal to toggle or focus terminal
8+
- `ctrl+space+t` to terminal menu (new, toggle, focus)
9+
- `ctrl+space+T` to `ctrl+space+u` toggle UI menu
10+
- `ctrl+space+b+Y` to `ctrl+space+y` copy buffer to clipboard
11+
- `ctrl+space+d+d` to `ctrl+space+s` start debug
12+
13+
**Added**
14+
15+
- `d` delete file
16+
- `p` paste file
17+
- `x` cut file
18+
- `y` copy file
19+
- `ctrl+shift+h` increase editor size
20+
- `ctrl+shift+l` decrease editor size
21+
- `ctrl+space+?` view all references
22+
- `ctrl+space+l` LSP menu (refactor, autofix, definition, declaration, format, symbol)
23+
- `ctrl+space+o` open menu (directory, file, recent)
24+
- `ctrl+space+p` peek menu (definition, declaration, implementation, reference)
25+
- `ctrl+space+x` view vscode extension
26+
- `ctrl+space+g+F` git pull from
27+
- `ctrl+space+g+h` git history
28+
- `ctrl+space+g+j` git next change
29+
- `ctrl+space+g+k` git previous change
30+
- `ctrl+space+g+P` git pull
31+
- `ctrl+space+g+t` git create tag
32+
- `ctrl+space+g+T` git delete tag
33+
- `ctrl+space+w+c` to `ctrl+space+w+d` close editor group
34+
35+
**Removed**
36+
37+
- `ctrl+space+c` close current editor
38+
- `ctrl+space+b+P` paste clipboard to buffer
39+
40+
## v1.0.13 (07-01-2024)
441

542
**Changed**
643

@@ -24,7 +61,7 @@
2461

2562
- `ctrl+e` is now handled by vscode and not vim
2663

27-
## v1.0.9 (13-07-2023)
64+
## v1.0.9 (12-07-2023)
2865

2966
**Added**
3067

‎README.md‎

Lines changed: 106 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,120 @@
1-
# LunarKeymap
1+
<div align="center">
22

3-
This extension provides keymaps for [Vim](https://marketplace.visualstudio.com/items?itemName=vscodevim.vim) and [Which Key](https://marketplace.visualstudio.com/items?itemName=VSpaceCode.whichkey) to achieve keyboard driven workflow in Visual Studio Code. Inspired by LunarVim.
3+
<img src="assets/logo.png" height="128" />
44

5-
## Usage
5+
<br>
66

7-
Full list of shortcuts are available on `Feature Contributions`
7+
<h2>LunarKeymap</h2>
88

9-
### Workspace navigation
9+
Keymaps for [Vim](https://marketplace.visualstudio.com/items?itemName=vscodevim.vim) and [Which Key](https://marketplace.visualstudio.com/items?itemName=VSpaceCode.whichkey) to enable efficient keyboard-driven workflow for developers. Inspired by LunarVim.
1010

11-
![Workspace navigation demonstration gif](assets/workspace-navigation.gif)
11+
</div>
12+
13+
## 1.0 Installation
14+
15+
Install LunarKeymap via [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=fathulfahmy.lunarkeymap)
16+
17+
## 2.0 Usage
1218

13-
| Key | Mode | Features |
14-
| -------- | ------- | ---------------- |
15-
| `ctrl+h` | n, v, i | Move focus left |
16-
| `ctrl+j` | n, v, i | Move focus down |
17-
| `ctrl+k` | n, v, i | Move focus up |
18-
| `ctrl+l` | n, v, i | Move focus right |
19-
| `alt+j` | n, v, i | Focus terminal |
19+
Full list of shortcuts are available on `Feature Contributions`.
2020

21-
### List navigation
21+
### 2.1 Workspace Navigation
2222

23-
![List navigation demonstration gif](assets/list-navigation.gif)
23+
![common shortcuts demonstration gif](assets/workspace1.gif)
2424

25-
| Key | Features |
26-
| -------- | ----------------------------------- |
27-
| `ctrl+j` | Cycle next suggestion or option |
28-
| `ctrl+k` | Cycle previous suggestion or option |
25+
| Key | Features |
26+
| -------- | ------------------- |
27+
| `ctrl+h` | Move focus left |
28+
| `ctrl+j` | Move focus down |
29+
| `ctrl+k` | Move focus up |
30+
| `ctrl+l` | Move focus right |
31+
| `alt+j` | Move focus terminal |
2932

30-
### Common keymaps
33+
![more common shortcuts demonstration gif](assets/workspace2.gif)
3134

32-
![Common keymaps demonstration gif](assets/common-keymaps.gif)
35+
| Key | Features |
36+
| -------------- | ----------------------------------- |
37+
| `ctrl+j` | Cycle next suggestion or option |
38+
| `ctrl+k` | Cycle previous suggestion or option |
39+
| `ctrl+shift+h` | Increase editor size |
40+
| `ctrl+shift+l` | Decrease editor size |
3341

34-
| Key | Mode | Features |
35-
| -------------- | ------- | ---------------------------- |
36-
| `>` | v | Indent selected lines |
37-
| `<` | v | Outdent selected lines |
38-
| `ctrl+space+t` | n, v, i | Toggle terminal |
39-
| `ctrl+shift+t` | n, v, i | Toggle terminal |
40-
| `ctrl+space` | n, v, i | Open Which Key shortcut menu |
42+
### 2.2 File Explorer
4143

42-
### File explorer
44+
![file explorer demonstration](assets/explorer1.gif)
4345

44-
![File explorer navigation demonstration gif](assets/file-navigation.gif)
46+
| Key | Features |
47+
| -------- | ------------- |
48+
| `ctrl+e` | Open explorer |
49+
| `h` | Collapse list |
50+
| `j` | Move down |
51+
| `k` | Move up |
52+
| `l` | Expand list |
53+
| `o` | Expand list |
4554

46-
| Key | Features |
47-
| ---------------- | ----------------- |
48-
| `ctrl+e` | Open explorer |
49-
| `a` | Create new file |
50-
| `A` or `shift+a` | Create new folder |
51-
| `h` | Collapse list |
52-
| `j` | Move down |
53-
| `k` | Move up |
54-
| `l` | Expand list |
55-
| `o` | Expand list |
56-
| `r` | Rename file |
57-
| `enter` | Select file |
55+
![more file explorer demonstration](assets/explorer2.gif)
5856

59-
### Which Key (Common)
57+
| Key | Features |
58+
| --------- | -------------- |
59+
| `a` | Add new file |
60+
| `shift+a` | Add new folder |
61+
| `d` | Delete file |
62+
| `x` | Cut file |
63+
| `y` | Copy file |
64+
| `p` | Paste file |
65+
| `r` | Rename file |
66+
| `enter` | Select file |
6067

61-
![Which Key common demonstration gif](assets/whichkey-common.gif)
68+
### 2.3 Which Key (Common)
6269

63-
| Key | Features |
64-
| -------------- | ---------------------------- |
65-
| `ctrl+space` | Open Which Key shortcut menu |
66-
| `ctrl+space+/` | Toggle comment line |
67-
| `ctrl+space+;` | Open command palette |
68-
| `ctrl+space+e` | Toggle file explorer |
69-
| `ctrl+space+h` | Horizontal split |
70-
| `ctrl+space+v` | Vertical split |
71-
| `ctrl+space+z` | Toggle zen mode |
70+
![Which Key common demonstration](assets/whichkey1.gif)
7271

73-
### Which Key (Buffers)
72+
| Key | Features |
73+
| -------------- | ------------------------- |
74+
| `ctrl+space` | Open shortcut menu |
75+
| `ctrl+space+;` | Open command palette |
76+
| `ctrl+space+/` | Toggle comment |
77+
| `ctrl+space+?` | View all references |
78+
| `ctrl+space+e` | Toggle file explorer |
79+
| `ctrl+space+h` | Horizontally split editor |
80+
| `ctrl+space+v` | Vertically split editor |
81+
| `ctrl+space+m` | Toggle minimap |
82+
| `ctrl+space+x` | View extensions |
83+
| `ctrl+space+z` | Toggle zen mode |
7484

75-
![Which Key buffer demonstration gif](assets/whichkey-buffer.gif)
85+
### 2.4 Which Key (Buffers/Editors)
7686

77-
| Key | Features |
78-
| --------------- | ---------------------------------- |
79-
| `ctrl+space` | Open Which Key shortcut menu |
80-
| `ctrl+space+bn` | Cycle next editor |
81-
| `ctrl+space+bp` | Cycle previous editor |
82-
| `ctrl+space+bc` | Close current editor |
83-
| `ctrl+space+bu` | Reopen closed editor |
84-
| `ctrl+space+bx` | Close other editors |
85-
| `ctrl+space+bh` | Move current editor to left group |
86-
| `ctrl+space+bj` | Move current editor to below group |
87-
| `ctrl+space+bk` | Move current editor to above group |
88-
| `ctrl+space+bl` | Move current editor to right group |
87+
![Which Key buffer demonstration](assets/whichkey2.gif)
8988

90-
## Defaults
89+
| Key | Features |
90+
| ---------------- | ---------------------------------- |
91+
| `ctrl+space` | Open shortcut menu |
92+
| `ctrl+space+b+n` | Cycle next editor |
93+
| `ctrl+space+b+p` | Cycle previous editor |
94+
| `ctrl+space+b+d` | Close current editor |
95+
| `ctrl+space+b+u` | Reopen closed editor |
96+
| `ctrl+space+b+x` | Close other editors |
97+
| `ctrl+space+b+N` | Open new editor |
98+
| `ctrl+space+b+y` | Copy editor to clipboard |
99+
| `ctrl+space+b+h` | Move current editor to left group |
100+
| `ctrl+space+b+j` | Move current editor to below group |
101+
| `ctrl+space+b+k` | Move current editor to above group |
102+
| `ctrl+space+b+l` | Move current editor to right group |
103+
104+
### 2.5 Which Key Menu
105+
106+
- Buffer `b`
107+
- Debug `d`
108+
- Find & Replace `f`
109+
- Git `g`
110+
- LSP `l`
111+
- Open `o`
112+
- Peek `p`
113+
- Terminal `t`
114+
- UI toggles `u`
115+
- Window `w`
116+
117+
## 3.0 Defaults
91118

92119
```
93120
"vim.useSystemClipboard": true,
@@ -107,7 +134,7 @@ Full list of shortcuts are available on `Feature Contributions`
107134
}
108135
```
109136

110-
## Change Which Key Shortcut Menu Keybinding
137+
## 4.0 Change Which Key Shortcut Menu Keybinding
111138

112139
1. Open command palette `ctrl+shift+p`
113140
2. Open Keyboard Shortcuts (JSON)
@@ -130,7 +157,7 @@ Full list of shortcuts are available on `Feature Contributions`
130157
]
131158
```
132159

133-
4. Save keyboard shortcuts
160+
4. Save file `ctrl+s`
134161
5. Open command palette `ctrl+shift+p`
135162
6. Open User Settings (JSON)
136163
7. Add
@@ -147,34 +174,23 @@ Full list of shortcuts are available on `Feature Contributions`
147174
},
148175
```
149176

150-
8. Save user settings
177+
8. Save user settings `ctrl+s`
151178

152179
<!-- ## Known Issues -->
153180

154-
## Installation
181+
## 5.0 Contributing
155182

156-
[Go to Lunar Keymap on Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=fathulfahmy.lunarkeymap)
157-
158-
1. Install Visual Studio Code
159-
2. Launch Visual Studio Code
160-
3. Open extension view `ctrl+shift+x`
161-
4. Search and install `LunarKeymap`
162-
5. Reload Visual Studio Code
163-
164-
## Contributing
165-
166-
1. Go to Lunar Keymap [GitHub repository](https://github.com/fathulfahmy/lunarkeymap).
183+
1. Go to LunarKeymap [GitHub repository](https://github.com/fathulfahmy/lunarkeymap).
167184
2. Open [package.json](https://github.com/fathulfahmy/lunarkeymap/blob/main/package.json).
168185
3. Add JSON object to [contributes.configurationDefaults](https://github.com/fathulfahmy/lunarkeymap/blob/main/package.json) or [contributes.keybindings](https://github.com/fathulfahmy/lunarkeymap/blob/main/package.json).
169186
4. Open a pull request.
170187

171-
## License
188+
## 6.0 License
172189

173-
This extension is licensed under the [GNU General Publick License v3.0](https://github.com/fathulfahmy/lunarkeymap/blob/main/LICENSE)
190+
This extension is licensed under the [GNU General Public License v3.0](https://github.com/fathulfahmy/lunarkeymap/blob/main/LICENSE)
174191

175-
## Reference
192+
## 7.0 Special thanks
176193

177-
1. VSCode with embedded Neovim, chris@machine
178-
[Open youtube link](https://www.youtube.com/watch?v=g4dXZ0RQWdw)
179-
2. THE BEST VIM CONFIG FOR VSCODE | configure vscode like vim, Joaquin Varela
180-
[Open youtube link](https://www.youtube.com/watch?v=Vkm4bc2Y0AA&t=215s)
194+
1. [LunarVim](https://github.com/LunarVim/LunarVim/tree/4625145d0278d4a039e55c433af9916d93e7846a/utils/vscode_config)
195+
2. [Christian Chiarulli](https://www.youtube.com/watch?v=g4dXZ0RQWdw)
196+
3. [Joaquin Varela](https://www.youtube.com/watch?v=Vkm4bc2Y0AA&t=215s)

‎assets/common-keymaps.gif‎

-1.37 MB
Binary file not shown.

‎assets/explorer1.gif‎

2.33 MB
Loading

‎assets/explorer2.gif‎

5.7 MB
Loading

‎assets/file-navigation.gif‎

-1.57 MB
Binary file not shown.

0 commit comments

Comments
 (0)