Merge pull request #224 from domaframework/document/update-readme

CleanUp Document

Author: xterao

CHANGELOG.md

@@ -39,7 +39,7 @@
 
 ### Bug Fixes
 
-- Fix to not display Dao parameter information in the document for elements defined with the for directive. ([#167])
+- Fix to not display DAO parameter information in the document for elements defined with the for directive. ([#167])
 - Do not suggest element names you define in the for directive element ([#166])
 - Fix: issue where grouped conditions in block comments were recognized as bind variables ([#159])
 - Fixed check for List type test data ([#157])
@@ -178,35 +178,35 @@
 
 ## [0.3.0] - 2025-03-07
 
-### Dao Support Features
+### DAO Support Features
 
 - **Actions**
-  - **Jump to SQL:** Added an action (with a gutter icon) that jumps to the SQL file from the Dao method.
+  - **Jump to SQL:** Added an action (with a gutter icon) that jumps to the SQL file from the DAO method.
     - Shortcut key: Alt+D
   - **Generate SQL:** Added an action to generate SQL files.
     - Shortcut key: Ctrl+Alt+G
 - **Code Inspection**
-  - Displays a quick fix when the corresponding SQL template file for a Dao method requiring one is not found.
+  - Displays a quick fix when the corresponding SQL template file for a DAO method requiring one is not found.
   - Shows an error if there are parameter arguments not used as SQL bind variables.
 
 ### SQL Support Features
 
 - **Actions**
-  - **Jump to Dao:** Added an action to jump from the SQL file to the Dao method.
+  - **Jump to DAO:** Added an action to jump from the SQL file to the DAO method.
     - Shortcut key: Alt+D
-  - **Jump to Declaration:** Added an action to jump from SQL bind variables to Dao parameters or class definitions.
+  - **Jump to Declaration:** Added an action to jump from SQL bind variables to DAO parameters or class definitions.
     - Shortcut key: Alt+E
 - **Code Inspection**
-  - Displays an error when fields or methods that do not exist in the Dao parameters or class definition are used.
+  - Displays an error when fields or methods that do not exist in the DAO parameters or class definition are used.
 - **Code Completion**
-  - Provides code completion for Dao method parameters, instance fields, and methods when used as bind variables.
+  - Provides code completion for DAO method parameters, instance fields, and methods when used as bind variables.
   - Provides code completion for static fields and methods during static property calls.
   - Offers code completion for directive names.
   - Provides code completion for Doma built-in functions.
 - **Refactoring**
-  - Rename SQL file when renaming Dao method
-  - Rename SQL file directory when renaming Dao
-  - Change Dao package name or SQL file directory configuration when changing configuration
+  - Rename SQL file when renaming DAO method
+  - Rename SQL file directory when renaming DAO
+  - Change DAO package name or SQL file directory configuration when changing configuration
 
 [Unreleased]: https://github.com/domaframework/doma-tools-for-intellij/compare/v0.8.0...HEAD
 [0.8.0]: https://github.com/domaframework/doma-tools-for-intellij/compare/v0.7.0...v0.8.0

README.md

@@ -6,63 +6,63 @@
 <!-- Plugin description -->
 "Doma Tools" is a plugin that supports the development of [Doma](https://github.com/domaframework/doma) based projects in IntelliJ.
 
-It checks associations between DAO and SQL, and offers coding support features for Doma syntax,
-such as generating SQL template files, navigating between files, and inspections to ensure the validity of bind variables.
+It checks associations between DAO and SQL and offers coding support features for Doma syntax,
+such as generating SQL template files, navigating between files, and inspecting the validity of bind variables.
 
 <!-- Plugin description end -->
 
 # Features
 
 ## Actions
-The plugin adds some actions, gutter icons.
-Shortcut keys can be used for actions
+The plugin adds several actions and gutter icons.
+Shortcut keys can be used for these actions.
 ![FileJump.gif](images/gif/FileJump.gif)
 
 - **Jump to SQL**
-  - Jump to from DAO to SQL
-  - You can also jump to the SQL file from the gutter icon that is displayed together.
+  - Jump from DAO to SQL.
+  - You can also jump to the SQL file using the gutter icon displayed alongside.
 - **Generate SQL**
-  - Generate SQL file
+  - Generate an SQL file.
 - **Jump to DAO**
-  - Jump to from SQL to DAO
-  - You can also jump to the DAO Method from the gutter icon that is displayed together.
+  - Jump from SQL to DAO.
+  - You can also jump to the DAO method using the gutter icon displayed alongside.
 
 ## Inspection
-Check that bind variables are used appropriately for DAO and SQL associations.
+Checks that bind variables are used appropriately for DAO and SQL associations.
 The plugin also provides quick fixes for DAO methods where the required SQL files do not exist.
 
-- Quick fix for generate SQL template file.
+- Quick fix to generate SQL template file.
   ![quickfix.png](images/quickfix.png)
-- Checking for DAO method arguments not used.
+- Checks for unused DAO method arguments.
   ![inspection.png](images/inspection.png)
-- Check for undefined bind variable names.
-- Check the class name and package name for static property calls.
+- Checks for undefined bind variable names.
+- Checks the class name and package name for static property calls.
   ![inspectionPackageName.png](images/inspectionPackageName.png)
-- Optional types are recognized as their element type (e.g. a parameter of type `Optional<String>` is treated as type `String`).
+- Optional types are recognized as their element type (e.g., a parameter of type `Optional<String>` is treated as type `String`).
 - For custom functions, checks for methods that are not defined in the configured ExpressionFunctions implementation class.
 
 ## Completion
-Code completion is available to assist you in coding within the directives.
+Code completion is available to assist you in coding within directives.
 
-- Suggest DAO method arguments in bind variable directives.
+- Suggests DAO method arguments in bind variable directives.
   ![Completion.gif](images/gif/Completion.gif)
-- It looks at DAO method argument types and suggests instance fields, methods.
+- Analyzes DAO method argument types and suggests instance fields and methods.
 - Suggests package and class names for class names used in static property calls.
   ![CompletionStatic.gif](images/gif/CompletionStatic.gif)
-- Suggest members defined as static in static fields and method calls.
-- Directives such as Condition, Loop, Population are suggested after `%`.
+- Suggests members defined as static in static fields and method calls.
+- Directives such as Condition, Loop, and Population are suggested after `%`.
 - Suggests built-in and custom functions after `@`.
-- Optional types are recognized as their element type (e.g. a parameter of type `Optional<String>` is treated as type `String`).
+- Optional types are recognized as their element type (e.g., a parameter of type `Optional<String>` is treated as type `String`).
 
 ## Refactoring
-Along with the DAO change, we will refactor the SQL file directory and file name.
+Along with DAO changes, the plugin will refactor the SQL file directory and file name.
 
-- After refactoring the DAO name, change the SQL directory name as well.
-- After refactoring the DAO method name, we will also change the SQL file name.
-- After refactoring the DAO package, we will also change the SQL directory.
+- After refactoring the DAO name, the SQL directory name will also be updated.
+- After refactoring the DAO method name, the SQL file name will also be updated.
+- After refactoring the DAO package, the SQL directory will also be updated.
 ![RenameDao.gif](images/gif/RenameDao.gif)
 
-## Formatter(Preview)
+## Formatter (Preview)
 Provides code formatting for SQL syntax.
 This feature is in preview. You cannot customize the indentation or keywords to be broken down!
 
@@ -74,34 +74,34 @@ To enable auto-indentation, toggle the corresponding flag in the settings screen
 
 ![Format.gif](images/gif/Format.gif)
 
-## Reference resolution
-Ctrl+Click on a bind variable in an SQL file to jump to its source symbol:
+## Reference Contributor
+Ctrl+Click on a bind variable in an SQL file to jump to its source symbol.
 
 This feature works in source JARs as well, but in binary JARs, if the DAO method’s argument parameter names have been changed, the references cannot be resolved and the feature will not function.
 
-- The DAO method’s argument parameter definition
-- The field and method definitions on that parameter’s type
-- The class definition referenced by @ClassName@
-- Custom functions in the configured ExpressionFunctions implementation class
+- The DAO method’s argument parameter definition.
+- The field and method definitions on that parameter’s type.
+- The class definition referenced by @ClassName@.
+- Custom functions in the configured ExpressionFunctions implementation class.
 - You can also jump using the **Go To > Declaration Usage** menu.
 
 ![Reference.gif](images/gif/Reference.gif)
 
 ## Settings
 Some functions of "Doma Tools" can be customized from the settings screen.
 
-- Enabling/disabling inspections and customizing error levels
-- Highlight color settings for SQL elements
+- Enable/disable inspections and customize error levels.
+- Highlight color settings for SQL elements.
 ![setting_highlight.png](images/setting_highlight.png)
-- Customize action shortcut keys
-- Enable/disable automatic indentation when breaking SQL lines
+- Customize action shortcut keys.
+- Enable/disable automatic indentation when breaking SQL lines.
 
 **If you want to use custom functions defined in your own ExpressionFunctions implementation class,
-place a `doma.compile.config` file directly under the resources directory and describe the `doma.expr.functions` entry.**
+place a `doma.compile.config` file directly under the resources directory and specify the `doma.expr.functions` entry.**
 
 [Doma Setting Options with Configuration File](https://doma.readthedocs.io/en/stable/annotation-processing/#setting-options-with-configuration-file)
 
-ex) doma.compile.config
+Example: doma.compile.config
 ```properties
 doma.expr.functions=example.expression.MyExpressionFunctions
 ```

images/gif/FileJump.gif

@@ -28,7 +28,7 @@ import org.domaframework.doma.intellij.common.psi.PsiDaoMethod
 import org.domaframework.doma.intellij.common.util.PluginLoggerUtil
 
 /**
- * Action class that generates SQL from Dao method
+ * Action class that generates SQL from DAO method
  */
 class GenerateSqlAction : AnAction() {
     private var currentFile: PsiFile? = null

src/main/kotlin/org/domaframework/doma/intellij/action/dao/GenerateSqlAction.kt

@@ -27,7 +27,7 @@ import org.domaframework.doma.intellij.common.isSupportFileType
 import org.domaframework.doma.intellij.common.util.PluginLoggerUtil
 
 /***
- * Action to jump from SQL file to corresponding Dao function
+ * Action to jump from SQL file to corresponding DAO function
  */
 class JumpToDaoFromSQLAction : AnAction() {
     private var currentFile: PsiFile? = null

src/main/kotlin/org/domaframework/doma/intellij/action/sql/JumpToDaoFromSQLAction.kt

@@ -35,7 +35,7 @@ fun getExtension(type: String): String =
     }
 
 /**
- * Does it match the Dao file type condition?
+ * Does it match the DAO file type condition?
  */
 fun isJavaOrKotlinFileType(daoFile: PsiFile): Boolean {
     if (daoFile.virtualFile == null) return false

src/main/kotlin/org/domaframework/doma/intellij/common/FileTypeCheck.kt

@@ -42,7 +42,7 @@ import org.domaframework.doma.intellij.extension.getModule
 import org.jetbrains.kotlin.idea.base.util.module
 
 /**
- * Get Dao method corresponding to SQL file
+ * Get DAO method corresponding to SQL file
  */
 fun findDaoMethod(
     originalFile: PsiFile,
@@ -120,7 +120,7 @@ private fun getDaoClassName(
 ): String = methodDaoFilePath.substringBefore(".$extensionName").substringAfter("dao/")
 
 /**
- * Get jump destination Dao method file from SQL file
+ * Get jump destination DAO method file from SQL file
  */
 fun findDaoFile(
     project: Project,
@@ -136,7 +136,7 @@ fun findDaoFile(
 }
 
 /**
- * Dao file search for SQL file
+ * DAO file search for SQL file
  */
 private fun searchDaoFile(
     module: Module?,
@@ -171,7 +171,7 @@ private fun findDaoClass(
 ): PsiClass? = module.getJavaClazz(includeTest, daoClassName)
 
 /**
- * Generate Dao deployment path from SQL file path
+ * Generate DAO deployment path from SQL file path
  * @param sqlFile SQL File
  * @param projectRootPath project content Root Path
  * @return
@@ -204,9 +204,9 @@ private fun getDaoPathFromSqlFilePath(
 }
 
 /**
- * Generate SqlFile path from Dao file path
- * @param daoFile Dao File
- * @param module The module to which the Dao file belongs
+ * Generate SqlFile path from DAO file path
+ * @param daoFile DAO File
+ * @param module The module to which the DAO file belongs
  * @return SqlFile path ex) META-INF/package/dao/DaoClassName/
  */
 fun getRelativeSqlFilePathFromDaoFilePath(

src/main/kotlin/org/domaframework/doma/intellij/common/dao/DaoMethodUtil.kt

@@ -47,7 +47,7 @@ import java.io.File
 import java.io.IOException
 
 /**
- * Class that handles Dao method information
+ * Class that handles DAO method information
  */
 class PsiDaoMethod(
     private val psiProject: Project,

src/main/kotlin/org/domaframework/doma/intellij/common/psi/PsiDaoMethod.kt

@@ -22,7 +22,7 @@ import org.domaframework.doma.intellij.bundle.MessageBundle
 import org.domaframework.doma.intellij.common.psi.PsiParentClass
 
 /**
- * no Dao parameter matching the name of the field access top was found
+ * no DAO parameter matching the name of the field access top was found
  */
 open class ValidationDaoParamResult(
     override val identify: PsiElement,

src/main/kotlin/org/domaframework/doma/intellij/common/sql/validator/result/ValidationDaoParamResult.kt

@@ -178,7 +178,7 @@ class ForDirectiveUtil {
             targetForItem: PsiElement? = null,
         ): PsiParentClass? {
             // Get the type of the top for directive definition element
-            // Defined in Dao parameters or static property calls
+            // Defined in DAO parameters or static property calls
             if (forDirectiveBlocks.isEmpty()) return null
             val topDirectiveItem = forDirectiveBlocks.first().item
             val file = topDirectiveItem.containingFile ?: return null
@@ -290,7 +290,7 @@ class ForDirectiveUtil {
                             referenceClazz,
                         )
                 } else {
-                    // Defined by Dao parameter
+                    // Defined by DAO parameter
                     if (daoMethod == null) return null
 
                     val topElementText =