support space_before_inline_comment = keep

Author: CppCXY

CodeFormatCore/include/CodeFormatCore/Config/LuaStyle.h

@@ -76,7 +76,7 @@ class LuaStyle {
 
     bool ignore_spaces_inside_function_call = false;
 
-    std::size_t space_before_inline_comment = 1;
+    SpaceBeforeInlineComment space_before_inline_comment = SpaceBeforeInlineComment();
 
     // [operator space]
     bool space_around_math_operator = true;

CodeFormatCore/include/CodeFormatCore/Config/LuaStyleEnum.h

@@ -106,4 +106,17 @@ enum class SpaceAroundStyle {
     Always,
     // for no_space_asym
     NoSpaceAsym,
+};
+
+enum class SpaceBeforeInlineCommentStyle {
+    Fixed,
+    Keep,
+};
+
+struct SpaceBeforeInlineComment {
+    explicit SpaceBeforeInlineComment(std::size_t space = 1, SpaceBeforeInlineCommentStyle style = SpaceBeforeInlineCommentStyle::Fixed)
+        : Style(style), Space(space) {}
+
+    SpaceBeforeInlineCommentStyle Style;
+    std::size_t Space;
 };

CodeFormatCore/src/Config/LuaStyle.cpp

@@ -150,7 +150,14 @@ void LuaStyle::Parse(std::map<std::string, std::string, std::less<>> &configMap)
 
     BOOL_OPTION(ignore_spaces_inside_function_call)
 
-    NUMBER_OPTION(space_before_inline_comment)
+    if(configMap.count("space_before_inline_comment")) {
+        auto &value = configMap.at("space_before_inline_comment");
+        if (value == "keep") {
+            space_before_inline_comment = SpaceBeforeInlineComment(0, SpaceBeforeInlineCommentStyle::Keep);
+        } else if (IsNumber(value)) {
+            space_before_inline_comment = SpaceBeforeInlineComment(std::stoi(value), SpaceBeforeInlineCommentStyle::Fixed);
+        }
+    }
 
     BOOL_OPTION(space_around_math_operator)
 

CodeFormatCore/src/Format/Analyzer/AlignAnalyzer.cpp

@@ -70,7 +70,7 @@ void AlignAnalyzer::Analyze(FormatState &f, const LuaSyntaxTree &t) {
         } else {
             switch (syntaxNode.GetTokenKind(t)) {
                 case TK_SHORT_COMMENT: {
-                    if (f.GetStyle().align_continuous_inline_comment) {
+                    if (f.GetStyle().align_continuous_inline_comment && f.GetStyle().space_before_inline_comment.Style == SpaceBeforeInlineCommentStyle::Fixed) {
                         AnalyzeInlineComment(f, syntaxNode, t);
                     }
                     break;
@@ -441,7 +441,7 @@ void AlignAnalyzer::ResolveAlignGroup(FormatState &f, std::size_t groupIndex, Al
                     auto prev = comment.GetPrevToken(t);
                     auto newPos =
                             file.GetColumn(prev.GetTextRange(t).GetEndOffset()) +
-                            f.GetStyle().space_before_inline_comment +
+                            f.GetStyle().space_before_inline_comment.Space +
                             1;
                     if (newPos > maxDis) {
                         maxDis = newPos;

CodeFormatCore/src/Format/Analyzer/SpaceAnalyzer.cpp

@@ -177,7 +177,17 @@ void SpaceAnalyzer::Analyze(FormatState &f, const LuaSyntaxTree &t) {
                 }
                 case TK_LONG_COMMENT:
                 case TK_SHORT_COMMENT: {
-                    SpaceLeft(syntaxNode, t, f.GetStyle().space_before_inline_comment, SpacePriority::CommentFirst);
+                    if (f.GetStyle().space_before_inline_comment.Style == SpaceBeforeInlineCommentStyle::Fixed) {
+                        SpaceLeft(syntaxNode, t, f.GetStyle().space_before_inline_comment.Space, SpacePriority::CommentFirst);
+                    } else {
+                        auto prevToken = syntaxNode.GetPrevToken(t);
+                        if (prevToken.GetEndLine(t) == syntaxNode.GetStartLine(t)) {
+                            auto space = syntaxNode.GetStartCol(t) - prevToken.GetEndCol(t) - 1;
+                            SpaceLeft(syntaxNode, t, space, SpacePriority::CommentFirst);
+                        } else {
+                            SpaceLeft(syntaxNode, t, 0, SpacePriority::CommentFirst);
+                        }
+                    }
                     SpaceRight(syntaxNode, t, 1);
                     break;
                 }

Test/src/FormatResult_unitest.cpp

@@ -1040,7 +1040,7 @@ local t = {
 TEST(Format, bug_131) {
     LuaStyle style;
 
-    style.space_before_inline_comment = 2;
+    style.space_before_inline_comment = SpaceBeforeInlineComment(2);
     style.align_continuous_inline_comment = false;
     EXPECT_TRUE(TestHelper::TestFormatted(
             R"(

Test/src/FormatStyle_unitest.cpp

@@ -769,7 +769,7 @@ map('k', 123, 456)
 TEST(FormatByStyleOption, space_before_inline_comment) {
     LuaStyle style;
 
-    style.space_before_inline_comment = 1;
+    style.space_before_inline_comment = SpaceBeforeInlineComment(1);
     EXPECT_TRUE(TestHelper::TestFormatted(
             R"(
 local t = 123 --hello
@@ -778,7 +778,7 @@ local t = 123 --hello
 local t = 123 --hello
 )",
             style));
-    style.space_before_inline_comment = 2;
+    style.space_before_inline_comment = SpaceBeforeInlineComment(2);
     EXPECT_TRUE(TestHelper::TestFormatted(
             R"(
 local t = 123 --hello
@@ -787,6 +787,24 @@ local t = 123 --hello
 local t = 123  --hello
 )",
             style));
+    style.space_before_inline_comment = SpaceBeforeInlineComment(0, SpaceBeforeInlineCommentStyle::Keep);
+    EXPECT_TRUE(TestHelper::TestFormatted(
+            R"(
+local function fff()                   --123131
+    local t = "hello world", 1         --12313131
+end
+local t        = hello --fjoiwjfowifw
+yes.it.is.me.a = 123                --fjoiwjfowifw
+)",
+            R"(
+local function fff()                   --123131
+    local t = "hello world", 1         --12313131
+end
+local t        = hello --fjoiwjfowifw
+yes.it.is.me.a = 123                --fjoiwjfowifw
+)",
+            style));
+
 }
 
 TEST(FormatByStyleOption, space_around_math_operator) {

lua.template.editorconfig

@@ -64,6 +64,7 @@ space_around_table_append_operator = false
 
 ignore_spaces_inside_function_call = false
 
+# detail number or 'keep'
 space_before_inline_comment = 1
 
 # [operator space]