Skip to content

Commit 5948d91

Browse files
committed
Update README to include GIFs for actions and features
1 parent d0e4d1e commit 5948d91

13 files changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ such as generating SQL template files, navigating between files, and inspections
1616
## Actions
1717
The plugin adds some actions, gutter icons.
1818
Shortcut keys can be used for actions
19-
20-
![action.png](images/action.png)
19+
![FileJump.gif](images/gif/FileJump.gif)
2120

2221
- **Jump to SQL**
2322
- Jump to action from Dao to SQL
@@ -45,11 +44,10 @@ The plugin also provides quick fixes for Dao methods where the required SQL file
4544
Adds code completion functionality to support indexing of Doma directives and bind variables
4645

4746
- Suggest Dao method arguments in bind variable directives
48-
![complete_bindVariables.png](images/complete_bindVariables.png)
47+
![Completion.gif](images/gif/Completion.gif)
4948
- Refer to class definition from Dao method argument type and suggest fields and methods
50-
![complete_member.png](images/cpmplete_member.png)
5149
- Provide code completion for class and package names used in static property calls.
52-
![complete_package.png](images/complete_package.png)
50+
![CompletionStatic.gif](images/gif/CompletionStatic.gif)
5351
- Suggest members defined as static in static fields and method calls
5452
- Suggest Doma directives
5553
- Directives such as Condition, Loop, Population are suggested after “%”
@@ -63,17 +61,16 @@ Along with the Dao name change, we will refactor the SQL file directory and file
6361
- After refactoring the Dao name, change the SQL deployment directory name as well.
6462
- After refactoring the Dao method name, we will also change the SQL file name.
6563
- After refactoring the Dao package, we will also change the SQL directory.
64+
![RenameDao.gif](images/gif/RenameDao.gif)
6665

6766
## Formatter(Preview)
6867
Provides code formatting for SQL syntax.
68+
Automatic indentation on newlines provided by the SQL formatting feature is disabled by default.
6969

70-
This feature is in preview. You cannot customize the indentation or keywords to be broken down!
71-
72-
You can reformat entire directories and files with "Code > Reformat Code".
73-
74-
If you want to enable the plugin's formatting function, check "Enable SQL Format" in "Settings > Other Settings > Doma Tools". (The default is OFF.)
70+
To enable auto-indentation, toggle the corresponding flag in the settings screen below.
71+
"Settings > Other Settings > Doma Tools > Enable auto-indent for SQL"
7572

76-
![enableFormat.png](images/enableFormat.png)
73+
![Format.gif](images/gif/Format.gif)
7774

7875
## Reference resolution
7976
Ctrl+Click on a bind variable in an SQL file to jump to its source symbol:
@@ -86,7 +83,7 @@ This feature works in source JARs as well, but in binary JARs, if the DAO method
8683
- Resolve references for custom functions using the ExpressionFunctions implementation class in which they are defined.
8784
- You can also jump using the **Go To > Declaration Usage** menu.
8885

89-
![reference.png](images/reference.png)
86+
![Reference.gif](images/gif/Reference.gif)
9087

9188
## Settings
9289
Some functions of "Doma Tools" can be customized from the settings screen.

images/action.png

-6.75 KB
Binary file not shown.

images/complete_bindVariables.png

-9.32 KB
Binary file not shown.

images/complete_package.png

-14.2 KB
Binary file not shown.

images/cpmplete_member.png

-40.6 KB
Binary file not shown.

images/enableFormat.png

-14.8 KB
Binary file not shown.

images/gif/Completion.gif

96.4 KB
Loading

images/gif/CompletionStatic.gif

168 KB
Loading

images/gif/FileJump.gif

478 KB
Loading

images/gif/Format.gif

118 KB
Loading

0 commit comments

Comments
 (0)