Improve the formatter a bit for return list/indentation

waleedyaseen · waleedyaseen · commit 0dee17378c21 · 2023-08-19T22:01:12.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,9 +2,16 @@
 
 ## [Unreleased]
 
+### Added
+- Add a formatter option for space around commas in return lists.
+- Add a formatter option for space within return list parenthesis.
+
 ### Changed
 - The build window will now display internal compiler errors as well.
 
+### Fixed
+- Fix a bug with script block indentation.
+
 ## [1.2.0] - 2023-08-18
 
 ### Added
diff --git a/src/main/kotlin/io/runescript/plugin/ide/formatter/blocks/impl/RsScriptBlock.kt b/src/main/kotlin/io/runescript/plugin/ide/formatter/blocks/impl/RsScriptBlock.kt
@@ -4,6 +4,12 @@ import com.intellij.formatting.Indent
 import com.intellij.lang.ASTNode
 import io.runescript.plugin.ide.formatter.RsFormatterContext
 import io.runescript.plugin.ide.formatter.blocks.RsBlock
+import io.runescript.plugin.lang.psi.RsElementTypes
 
-class RsScriptBlock(context: RsFormatterContext, node: ASTNode)
-    : RsBlock(context, node, Indent.getNoneIndent(), null, null)
+class RsScriptBlock(context: RsFormatterContext, node: ASTNode) :
+    RsBlock(context, node, Indent.getNoneIndent(), null, null) {
+
+    override fun getChildIndent(): Indent? {
+        return Indent.getNoneIndent()
+    }
+}
diff --git a/src/main/kotlin/io/runescript/plugin/ide/formatter/impl/RsSpacingBuilder.kt b/src/main/kotlin/io/runescript/plugin/ide/formatter/impl/RsSpacingBuilder.kt
@@ -45,9 +45,6 @@ class RsSpacingBuilder(private val settings: CommonCodeStyleSettings,
                 return spaceIf(settings.SPACE_AROUND_ASSIGNMENT_OPERATORS)
             }
         }
-        if (type1 == DEFINE_TYPE || type1 == TYPE_NAME || type1 == ARRAY_TYPE_LITERAL) {
-            return spaceIf(true)
-        }
         if (type2 == SEMICOLON) {
             return spaceIf(settings.SPACE_BEFORE_SEMICOLON)
         }
@@ -110,6 +107,9 @@ class RsSpacingBuilder(private val settings: CommonCodeStyleSettings,
         if (elementType == CALC_EXPRESSION && (type1 == LPAREN || type2 == RPAREN)) {
             return spaceIf(rsSettings.SPACE_WITHIN_CALC_PARENTHESES)
         }
+        if (elementType == RETURN_LIST && (type1 == LPAREN || type2 == RPAREN)) {
+            return spaceIf(rsSettings.SPACE_WITHIN_RETURN_LIST_PARENTHESES)
+        }
         if (elementType == ARGUMENT_LIST && (type1 == LPAREN || type2 == RPAREN)) {
             val superType = parent.node.treeParent.elementType
             if (superType == GOSUB_EXPRESSION || superType == COMMAND_EXPRESSION) {
@@ -118,16 +118,26 @@ class RsSpacingBuilder(private val settings: CommonCodeStyleSettings,
             }
         }
         if (elementType == ARGUMENT_LIST || elementType == SWITCH_CASE
-                || elementType == PARAMETER_LIST || elementType == RETURN_LIST) {
+                || elementType == PARAMETER_LIST) {
             if (type2 == COMMA) {
                 return spaceIf(settings.SPACE_BEFORE_COMMA)
             } else if (type1 == COMMA) {
                 return spaceIf(settings.SPACE_AFTER_COMMA)
             }
         }
+        if (elementType == RETURN_LIST) {
+            if (type2 == COMMA) {
+                return spaceIf(rsSettings.SPACE_BEFORE_COMMA_IN_RETURN_LIST)
+            } else if (type1 == COMMA) {
+                return spaceIf(rsSettings.SPACE_AFTER_COMMA_IN_RETURN_LIST)
+            }
+        }
         if (type2 == ARGUMENT_LIST && (elementType == GOSUB_EXPRESSION || elementType == COMMAND_EXPRESSION)) {
             return spaceIf(settings.SPACE_BEFORE_METHOD_CALL_PARENTHESES)
         }
+        if (type1 == DEFINE_TYPE || type1 == TYPE_NAME || type1 == ARRAY_TYPE_LITERAL) {
+            return spaceIf(true)
+        }
         return null
     }
 
diff --git a/src/main/kotlin/io/runescript/plugin/ide/formatter/style/RsCodeStyleSettings.kt b/src/main/kotlin/io/runescript/plugin/ide/formatter/style/RsCodeStyleSettings.kt
@@ -17,4 +17,13 @@ class RsCodeStyleSettings(container: CodeStyleSettings) : CustomCodeStyleSetting
 
     @JvmField
     var SPACE_WITHIN_CALC_PARENTHESES = false
+
+    @JvmField
+    var SPACE_WITHIN_RETURN_LIST_PARENTHESES = false
+
+    @JvmField
+    var SPACE_BEFORE_COMMA_IN_RETURN_LIST = false
+
+    @JvmField
+    var SPACE_AFTER_COMMA_IN_RETURN_LIST = false
 }
diff --git a/src/main/kotlin/io/runescript/plugin/ide/formatter/style/RsLanguageCodeStyleSettingsProvider.kt b/src/main/kotlin/io/runescript/plugin/ide/formatter/style/RsLanguageCodeStyleSettingsProvider.kt
@@ -15,6 +15,7 @@ class RsLanguageCodeStyleSettingsProvider : LanguageCodeStyleSettingsProvider()
         if (settingsType == SettingsType.SPACING_SETTINGS) {
             val spacesWithin = CodeStyleSettingsCustomizableOptions.getInstance().SPACES_WITHIN
             val spacesBeforeParen = CodeStyleSettingsCustomizableOptions.getInstance().SPACES_BEFORE_PARENTHESES
+            val spacesOther = CodeStyleSettingsCustomizableOptions.getInstance().SPACES_OTHER
             consumer.showStandardOptions(
                     // Before parentheses
                     "SPACE_BEFORE_IF_PARENTHESES",
@@ -76,6 +77,11 @@ class RsLanguageCodeStyleSettingsProvider : LanguageCodeStyleSettingsProvider()
                     "'calc' parentheses",
                     spacesWithin)
 
+            consumer.showCustomOption(RsCodeStyleSettings::class.java,
+                "SPACE_WITHIN_RETURN_LIST_PARENTHESES",
+                "Return list parentheses",
+                spacesWithin)
+
             consumer.showCustomOption(RsCodeStyleSettings::class.java,
                     "SPACE_WITHIN_ARRAY_BOUNDS",
                     "Array bounds",
@@ -85,6 +91,20 @@ class RsLanguageCodeStyleSettingsProvider : LanguageCodeStyleSettingsProvider()
                     "SPACE_BEFORE_ARRAY_BOUNDS",
                     "Array bounds",
                     spacesBeforeParen)
+
+            consumer.showCustomOption(RsCodeStyleSettings::class.java,
+                "SPACE_BEFORE_COMMA_IN_RETURN_LIST",
+                "Before comma in return list",
+                spacesOther,
+                CodeStyleSettingsCustomizable.OptionAnchor.AFTER,
+                "SPACE_AFTER_COMMA")
+
+            consumer.showCustomOption(RsCodeStyleSettings::class.java,
+                "SPACE_AFTER_COMMA_IN_RETURN_LIST",
+                "After comma in return list",
+                spacesOther,
+                CodeStyleSettingsCustomizable.OptionAnchor.AFTER,
+                "SPACE_AFTER_COMMA")
         }
     }
 
@@ -131,5 +151,7 @@ class RsLanguageCodeStyleSettingsProvider : LanguageCodeStyleSettingsProvider()
             return(${'$'}odd_count);
             
             [proc,tostring](string ${'$'}text)
+            
+            [proc,multiple_returns]()(int,int,string)
         """.trimIndent()
 }

Original file line number	Diff line number	Diff line change
`@@ -45,9 +45,6 @@ class RsSpacingBuilder(private val settings: CommonCodeStyleSettings,`
`45`	`45`	`return spaceIf(settings.SPACE_AROUND_ASSIGNMENT_OPERATORS)`
`46`	`46`	`}`
`47`	`47`	`}`
`48`		`- if (type1 == DEFINE_TYPE \|\| type1 == TYPE_NAME \|\| type1 == ARRAY_TYPE_LITERAL) {`
`49`		`- return spaceIf(true)`
`50`		`- }`
`51`	`48`	`if (type2 == SEMICOLON) {`
`52`	`49`	`return spaceIf(settings.SPACE_BEFORE_SEMICOLON)`
`53`	`50`	`}`
`@@ -110,6 +107,9 @@ class RsSpacingBuilder(private val settings: CommonCodeStyleSettings,`
`110`	`107`	`if (elementType == CALC_EXPRESSION && (type1 == LPAREN \|\| type2 == RPAREN)) {`
`111`	`108`	`return spaceIf(rsSettings.SPACE_WITHIN_CALC_PARENTHESES)`
`112`	`109`	`}`
	`110`	`+ if (elementType == RETURN_LIST && (type1 == LPAREN \|\| type2 == RPAREN)) {`
	`111`	`+ return spaceIf(rsSettings.SPACE_WITHIN_RETURN_LIST_PARENTHESES)`
	`112`	`+ }`
`113`	`113`	`if (elementType == ARGUMENT_LIST && (type1 == LPAREN \|\| type2 == RPAREN)) {`
`114`	`114`	`val superType = parent.node.treeParent.elementType`
`115`	`115`	`if (superType == GOSUB_EXPRESSION \|\| superType == COMMAND_EXPRESSION) {`
`@@ -118,16 +118,26 @@ class RsSpacingBuilder(private val settings: CommonCodeStyleSettings,`
`118`	`118`	`}`
`119`	`119`	`}`
`120`	`120`	`if (elementType == ARGUMENT_LIST \|\| elementType == SWITCH_CASE`
`121`		`- \|\| elementType == PARAMETER_LIST \|\| elementType == RETURN_LIST) {`
	`121`	`+ \|\| elementType == PARAMETER_LIST) {`
`122`	`122`	`if (type2 == COMMA) {`
`123`	`123`	`return spaceIf(settings.SPACE_BEFORE_COMMA)`
`124`	`124`	`} else if (type1 == COMMA) {`
`125`	`125`	`return spaceIf(settings.SPACE_AFTER_COMMA)`
`126`	`126`	`}`
`127`	`127`	`}`
	`128`	`+ if (elementType == RETURN_LIST) {`
	`129`	`+ if (type2 == COMMA) {`
	`130`	`+ return spaceIf(rsSettings.SPACE_BEFORE_COMMA_IN_RETURN_LIST)`
	`131`	`+ } else if (type1 == COMMA) {`
	`132`	`+ return spaceIf(rsSettings.SPACE_AFTER_COMMA_IN_RETURN_LIST)`
	`133`	`+ }`
	`134`	`+ }`
`128`	`135`	`if (type2 == ARGUMENT_LIST && (elementType == GOSUB_EXPRESSION \|\| elementType == COMMAND_EXPRESSION)) {`
`129`	`136`	`return spaceIf(settings.SPACE_BEFORE_METHOD_CALL_PARENTHESES)`
`130`	`137`	`}`
	`138`	`+ if (type1 == DEFINE_TYPE \|\| type1 == TYPE_NAME \|\| type1 == ARRAY_TYPE_LITERAL) {`
	`139`	`+ return spaceIf(true)`
	`140`	`+ }`
`131`	`141`	`return null`
`132`	`142`	`}`
`133`	`143`