Merge branch 'main' into feature/annotation-option-parameter-validation

Author: xterao

.claude/commands/execute_issue.md

@@ -0,0 +1,11 @@
+gh issue view $ARGUMENTS to check the content of a GitHub Issue and proceed with the task.
+Follow the steps below to complete the task:
+
+1. Review the content of the Issue.
+2. Checkout and pull the latest state of the main branch.
+3. Create and checkout an appropriate branch based on the Issue content.
+4. Implement test code and test files that cover the cases described in the Issue. Refer to the [Test Case Implementation Guidelines](../guidelines/TEST_CASE_GUIDELINE) for rules on implementing test cases.
+5. Run the tests and ensure all tests pass.
+6. Create commits with appropriate granularity.
+7. Create a PR following the rules below:
+   - Refer to the [PR Creation Guidelines](../guidelines/CREATE_PR_GUIDELINE.md) for PR rules.

.claude/guidelines/CREATE_PR_GUIDELINE.md

@@ -0,0 +1,10 @@
+## Commit Guidelines
+- Use imperative mood for commit messages (e.g., "Fix bug" instead of "Fixed
+- Write Commit messages in English
+
+## PR Guidelines
+- If there are unstaged changes when creating a pull request, please split them appropriately and commit them separately.
+- Use the [PR Template](../templates/PR_TEMPLATE.md) for PR descriptions
+- PR titles should be concise and descriptive
+- Ensure all tests pass before submitting a PR
+- Write PR title and descriptions in English

.claude/guidelines/TEST_CASE_GUIDELINE.md

@@ -0,0 +1,30 @@
+# Test Case Implementation Guidelines
+Follow the rules below when implementing test code.
+
+## Code Inspection Functionality
+Implement tests for code inspection functionality using the following steps:
+
+### **Implementation of Test Case Classes**
+- Implement test case classes in `@src/test/kotlin/org/domaframework/doma/intellij/inspection`.
+- Implement test cases for each subclass of **AbstractBaseJavaLocalInspectionTool**.
+- Name the test case class as `<InspectionToolName>InspectionTest`.
+- The test case class should extend `DomaSqlTest`.
+- Override **setUp()** to add mock **Entity** classes or other necessary components to the virtual project for testing.
+- Register the target **AbstractBaseJavaLocalInspectionTool** subclass using **myFixture.enableInspections**.
+- In test case functions, retrieve the target Dao class using **DomaSqlTest#findDaoClass()** and test the highlighting results using **myFixture.testHighlighting()**.
+
+### Implementation of Test Cases
+Create the target Dao class or SQL file for inspection.
+Wrap the elements to be error-highlighted with the **<error>** tag and specify the error message to be displayed using the **descr** option.
+
+#### Test Data for Dao Classes
+- Implement test data Dao classes in **Java**.
+- Annotate test data Dao classes with **@Dao**.
+- Place them under the appropriate subpackage in `@src/test/testData/src/main/java/doma/example/dao/inspection`.
+- Implement any other necessary classes as needed.
+
+#### Test Data for SQL Files
+- Create and place SQL files in a directory named after the corresponding Dao class under `@src/test/testData/src/main/resources/META-INF/doma/example/dao`.
+
+### Reference
+For actual implementation examples using Doma, refer to the [Doma GitHub repository](https://github.com/domaframework/doma/tree/master/integration-test-java/src/main/java/org/seasar/doma/it/dao).

.claude/setting.json

@@ -0,0 +1 @@
+

.claude/settings.json

@@ -13,4 +13,5 @@ out/
 *.iws
 .kotlin
 secrets.properties
-/certificate/**
+/certificate/**
+.claude/settings.local.json

.claude/settings.local.json

@@ -34,6 +34,7 @@ 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 to generate SQL template file.
+
   ![quickfix.png](images/quickfix.png)
 - Checks for unused DAO method arguments.
   ![inspection.png](images/inspection.png)
@@ -69,17 +70,78 @@ Along with DAO changes, the plugin will refactor the SQL file directory and file
 - After refactoring the DAO package, the SQL directory will also be updated.
 ![RenameDao.gif](images/gif/RenameDao.gif)
 
-## Formatter (Preview)
+## Formatter
 Provides code formatting for SQL syntax.
 This feature is in preview. You cannot customize the indentation or keywords to be broken down!
 
+The formatting applies to SQL written in SQL files and in value fields (text blocks) within org.seasar.doma.Sql annotations.
+
+![Format.gif](images/gif/Format.gif)
+
 Automatic indentation on newlines provided by the SQL formatting feature is disabled by default.
 
 To enable auto-indentation, toggle the corresponding flag in the settings screen below.
 
 `Settings > Other Settings > Doma Tools > Enable auto-indent for SQL`
 
-![Format.gif](images/gif/Format.gif)
+### Limitations
+The current formatter has the following limitations:
+
+- **No customizable indentation**: The number of spaces for indentation is fixed and cannot be changed
+- **No customizable line breaks**: You cannot configure which keywords trigger line breaks
+- **No custom function registration**: User-defined functions cannot be registered for formatting rules
+- **No formatting style options**: Cannot choose between different formatting styles or conventions
+
+### Formatting Features
+The SQL formatter supports the following formatting capabilities:
+
+- **SQL Keywords**: Converts keywords to uppercase (SELECT, FROM, WHERE, INSERT, UPDATE, DELETE, etc.)
+- **Statement Structure**: Properly formats different SQL statement types:
+  - SELECT statements with proper column and clause alignment
+  - INSERT statements with formatted column lists and VALUES clauses
+  - UPDATE statements with aligned SET clauses
+  - DELETE statements with formatted conditions
+  - WITH clauses (CTE) with proper indentation
+- **Joins**: Formats JOIN operations with appropriate indentation and alignment
+- **Subqueries**: Properly indents nested queries and subselects
+- **Functions**: Formats function calls with proper parameter alignment
+- **Comments**: Preserves single-line (--) and multi-line (/* */) comments
+- **Doma Directives**: Maintains proper formatting for Doma-specific directives:
+  - Bind variables: `/* paramName */` with proper spacing
+  - Conditional directives: `/*%if condition */` ... `/*%end*/`
+  - Loop directives: `/*%for item : collection */` ... `/*%end*/`
+  - Expand directive: `/*%expand */`
+  - Populate directive: `/*%populate */`
+  - Static property calls: `/* @ClassName@property */`
+  - Literal values: `/*^ literalValue */`
+  - Embedded variables: `/*# variable */`
+
+### Examples
+
+**Before formatting:**
+```sql
+SELECT COUNT(DISTINCT x) AS count_x, o.*, COALESCE(nbor.nearest, 999)
+AS nearest FROM ( SELECT p.objid, p.psfmag_g - p.extinction_g AS rpm
+FROM phototag p JOIN usno u ON p.objid = u.objid
+WHERE p.TYPE = 'Star' /*%if status == 2 */ and u.propermotion > 2.0 /*%end*/ ) as o
+```
+
+**After formatting:**
+```sql
+SELECT COUNT(DISTINCT x) AS count_x
+       , o.*
+       , COALESCE(nbor.nearest
+                  , 999) AS nearest
+  FROM ( SELECT p.objid
+                , p.psfmag_g - p.extinction_g AS rpm
+           FROM phototag p
+                JOIN usno u
+                  ON p.objid = u.objid
+          WHERE p.TYPE = 'Star'
+            /*%if status == 2 */
+            AND u.propermotion > 2.0
+            /*%end*/ ) AS o
+```
 
 ## Reference Contributor
 Ctrl+Click on a bind variable in an SQL file to jump to its source symbol.

.gitignore

@@ -1,7 +1,7 @@
 pluginGroup = org.domaframework.doma.intellij
 pluginName = Doma Tools for IntelliJ
 pluginRepositoryUrl = https://github.com/domaframework/doma-tools-for-intellij
-pluginVersion = 1.1.2-beta
+pluginVersion = 2.0.1-beta
 
 pluginSinceBuild=231