Formatting CLI Tool

CHANGELOG.md

@@ -32,7 +32,7 @@ All notable changes to this project will be documented in this file. When sendin
 
 ### Tooling
 
-- 
+- [Add Formatting CLI tool](https://github.com/ballerina-platform/ballerina-lang/pull/15664)
 - 
 - 
 - 

cli/ballerina-launcher/src/main/resources/cli-help/ballerina-format.help

@@ -0,0 +1,57 @@
+NAME
+    Ballerina Format - Format ballerina source files according to
+    the default Ballerina style guide.
+    https://github.com/ballerina-platform/ballerina-lang/tree/master/docs/style_guide
+
+SYNOPSIS
+    ballerina format [ballerinaFile|moduleName] [-ow|--over-write]
+
+DESCRIPTION
+    Format Ballerina source files according to the ballerina style guide.
+
+    Formatting can be performed on Ballerina project, on a Ballerina Module,
+    on a Ballerina file.
+
+    Formatted content will be written on to the original files and will ask
+    for confirmation before proceeding to replace the original content.
+
+    If Ballerina sources contains syntax errors they will be notified and
+    formatting won't proceed until they are fixed.
+
+SUB COMMANDS
+    ballerina format
+        Format the all ballerina source files available in the given ballerina project.
+        This command should be executed from the ballerina project root.
+
+    ballerina format <moduleName>
+        Format the all ballerina source files available in the given module. This command
+        should be executed from the ballerina project root.
+
+    ballerina format <ballerinaFile>
+        Format the given ballerina file to match the default Ballerina style guide.
+        Formatted source will replace the given files content with user consent.
+
+OPTIONS
+    -ow
+    --over-write
+        By providing this option user can over write the original file content without blocked by consent message.
+        CAUTION: This process is not reversible unless your file is under a VCS.
+            If you don't want your original source file content to be replaced with
+            Formatted code please do not use this command.
+
+    -h
+    --help
+        Show help file for the format command.
+
+EXAMPLES
+    Format Ballerina project
+    $ ballerina format
+
+    Format Ballerina module
+    $ ballerina format module1
+
+    Format Ballerina file
+    $ ballerina format hello.bal
+
+    Overwrite without confirmation
+    $ ballerina format -ow

cli/ballerina-launcher/src/main/resources/cli-help/ballerina-help.help

@@ -36,6 +36,7 @@ DESCRIPTION
          test       Test Ballerina program
          version    Print Ballerina version
          encrypt    Encrypt sensitive data
+         format     Format ballerina source code
 
 OPTIONS
      Ballerina help takes no command line options 

distribution/zip/ballerina-tools/build.gradle

@@ -72,6 +72,7 @@ dependencies {
     dist project(':openapi-ballerina:openapi-to-ballerina-generator')
     dist project(':ballerina-backend-jvm')
     dist project(':language-server:language-server-compiler')
+    dist project(':ballerina-formatter')
     dist project(':ballerina-packerina')
     // dist project(':protobuf-ballerina')
     dist project(':openapi-ballerina:openapi-to-ballerina-generator')

distribution/zip/ballerina-tools/pom.xml

@@ -282,6 +282,10 @@
             <groupId>org.ballerinalang</groupId>
             <artifactId>openapi-to-ballerina-generator</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.ballerinalang</groupId>
+            <artifactId>ballerina-formatter</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.ballerinalang</groupId>
             <artifactId>ballerina-client-generator</artifactId>

distribution/zip/ballerina-tools/src/assembly/bin.xml

@@ -142,6 +142,7 @@
                     in ballerina OpenAPI CLI tools
                  -->
                 <include>org.ballerinalang:language-server-compiler:jar</include>
+                <include>org.ballerinalang:ballerina-formatter:jar</include>
                 <include>org.ballerinalang:ballerina-packerina:jar</include>
                 <include>org.ballerinalang:protobuf-ballerina:jar</include>
                 <include>org.ballerinalang:ballerina-client-generator:jar</include>

distribution/zip/jballerina-tools/build.gradle

@@ -62,7 +62,7 @@ dependencies {
     dist project(':ballerina-runtime')
 
     dist project(':testerina:testerina-core')
-
+    dist project(':ballerina-formatter')
     dist project(':openapi-ballerina:openapi-to-ballerina-generator')
     dist project(':ballerina-backend-jvm')
     dist project(':language-server:language-server-compiler')

distribution/zip/jballerina-tools/pom.xml

@@ -280,6 +280,10 @@
             <groupId>org.ballerinalang</groupId>
             <artifactId>ballerina-client-generator</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.ballerinalang</groupId>
+            <artifactId>ballerina-formatter</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.ballerinalang</groupId>
             <artifactId>protobuf-ballerina</artifactId>

distribution/zip/jballerina-tools/src/assembly/bin.xml

@@ -136,6 +136,7 @@
                     in ballerina OpenAPI CLI tools
                  -->
                 <include>org.ballerinalang:language-server-compiler:jar</include>
+                <include>org.ballerinalang:ballerina-formatter:jar</include>
                 <include>org.ballerinalang:ballerina-packerina:jar</include>
                 <include>org.ballerinalang:protobuf-ballerina:jar</include>
                 <include>org.ballerinalang:ballerina-client-generator:jar</include>

language-server/modules/langserver-core/src/main/java/org/ballerinalang/langserver/formatting/FormattingConstants.java → language-server/modules/langserver-compiler/src/main/java/org/ballerinalang/langserver/compiler/format/FormattingConstants.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.ballerinalang.langserver.formatting;
+package org.ballerinalang.langserver.compiler.format;
 
 /**
  * Formatting constants for keywords used in the formatting util.
@@ -54,4 +54,5 @@ public class FormattingConstants {
     public static final String KIND = "kind";
     public static final String TYPE = "type";
     public static final String NAME = "name";
+    public static final String EXPRESSIONS = "expressions";
 }

language-server/modules/langserver-core/src/main/java/org/ballerinalang/langserver/formatting/FormattingNodeTree.java → language-server/modules/langserver-compiler/src/main/java/org/ballerinalang/langserver/compiler/format/FormattingNodeTree.java

@@ -13,11 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.ballerinalang.langserver.formatting;
+package org.ballerinalang.langserver.compiler.format;
 
 import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
+import org.ballerinalang.langserver.compiler.sourcegen.FormattingSourceGen;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -2913,8 +2914,8 @@ public void formatPanicNode(JsonObject node) {
             }
 
             // Handle the expression formatting.
-            if (node.has("expressions")) {
-                node.getAsJsonObject("expressions").add(FormattingConstants.FORMATTING_CONFIG,
+            if (node.has(FormattingConstants.EXPRESSIONS)) {
+                node.getAsJsonObject(FormattingConstants.EXPRESSIONS).add(FormattingConstants.FORMATTING_CONFIG,
                         this.getFormattingConfig(0, 1, this.getWhiteSpaceCount(indentation),
                                 false, this.getWhiteSpaceCount(indentationOfParent),
                                 formatConfig.get(FormattingConstants.USE_PARENT_INDENTATION).getAsBoolean()));
@@ -3006,20 +3007,10 @@ public void formatRecordLiteralExprNode(JsonObject node) {
         if (node.has(FormattingConstants.WS) && node.has(FormattingConstants.FORMATTING_CONFIG)) {
             JsonArray ws = node.getAsJsonArray(FormattingConstants.WS);
             JsonObject formatConfig = node.getAsJsonObject(FormattingConstants.FORMATTING_CONFIG);
-            String indentation = this.getIndentation(formatConfig, false);
             String indentWithParentIndentation = this.getParentIndentation(formatConfig);
             String parentKind = node.getAsJsonObject(FormattingConstants.PARENT).get(FormattingConstants.KIND)
                     .getAsString();
             boolean isTable = parentKind.equals("Table");
-            boolean isExpression = parentKind.equals("Endpoint") || parentKind.equals("AnnotationAttachment")
-                    || parentKind.equals("Service") || parentKind.equals("Variable") || parentKind.equals("Invocation")
-                    || parentKind.equals("ErrorConstructor") || parentKind.equals("RecordLiteralExpr")
-                    || parentKind.equals("RecordLiteralKeyValue") || parentKind.equals("Return");
-
-            if (isExpression) {
-                node.getAsJsonObject(FormattingConstants.POSITION).addProperty(FormattingConstants.START_COLUMN,
-                        indentation);
-            }
 
             // Preserve line separation that already available.
             this.preserveHeight(ws, indentWithParentIndentation);
@@ -3037,12 +3028,12 @@ public void formatRecordLiteralExprNode(JsonObject node) {
                 // Update whitespace for opening brace.
                 if (text.equals(Tokens.OPENING_BRACE)
                         && this.noHeightAvailable(currentWS.get(FormattingConstants.WS).getAsString())) {
-                    if (isExpression) {
-                        currentWS.addProperty(FormattingConstants.WS,
-                                this.getWhiteSpaces(formatConfig.get(FormattingConstants.SPACE_COUNT).getAsInt()));
-                    } else if (isTable) {
+                    if (isTable) {
                         currentWS.addProperty(FormattingConstants.WS, this.getNewLines(formatConfig
                                 .get(FormattingConstants.NEW_LINE_COUNT).getAsInt()) + indentWithParentIndentation);
+                    } else {
+                        currentWS.addProperty(FormattingConstants.WS,
+                                this.getWhiteSpaces(formatConfig.get(FormattingConstants.SPACE_COUNT).getAsInt()));
                     }
                 }
 
@@ -4222,8 +4213,8 @@ public void formatStringTemplateLiteralNode(JsonObject node) {
             }
 
             // Handle expressions format
-            if (node.has("expressions")) {
-                JsonArray expressions = node.getAsJsonArray("expressions");
+            if (node.has(FormattingConstants.EXPRESSIONS)) {
+                JsonArray expressions = node.getAsJsonArray(FormattingConstants.EXPRESSIONS);
                 // Every three expression is related to
                 // Start of the template expression
                 // expression of the template expression
@@ -5106,8 +5097,51 @@ public void formatTypedescExpressionNode(JsonObject node) {
      * @param node {JsonObject} node as json object
      */
     public void formatTypeInitExprNode(JsonObject node) {
-        // TODO: fix formatting for type init expression
-        this.skipFormatting(node, true);
+        if (node.has(FormattingConstants.WS) && node.has(FormattingConstants.FORMATTING_CONFIG)) {
+            JsonObject formatConfig = node.getAsJsonObject(FormattingConstants.FORMATTING_CONFIG);
+            JsonArray ws = node.getAsJsonArray(FormattingConstants.WS);
+
+            String indentation = this.getIndentation(formatConfig, false);
+            String indentationOfParent = this.getParentIndentation(formatConfig);
+            boolean useParentIndentation = formatConfig.get(FormattingConstants.USE_PARENT_INDENTATION).getAsBoolean();
+
+            // Preserve available new lines in node.
+            this.preserveHeight(ws, useParentIndentation ? indentationOfParent : indentation);
+
+            // Iterate and update whitespaces for node.
+            for (JsonElement wsItem : ws) {
+                JsonObject currentWS = wsItem.getAsJsonObject();
+                if (this.noHeightAvailable(currentWS.get(FormattingConstants.WS).getAsString())) {
+                    String text = currentWS.get(FormattingConstants.TEXT).getAsString();
+                    if (text.equals(Tokens.NEW)) {
+                        currentWS.addProperty(FormattingConstants.WS,
+                                this.getWhiteSpaces(formatConfig.get(FormattingConstants.SPACE_COUNT).getAsInt()));
+                    } else if (text.equals(Tokens.OPENING_PARENTHESES)) {
+                        if (node.has(FormattingConstants.TYPE)) {
+                            currentWS.addProperty(FormattingConstants.WS, FormattingConstants.EMPTY_SPACE);
+                        } else {
+                            currentWS.addProperty(FormattingConstants.WS, FormattingConstants.SINGLE_SPACE);
+                        }
+                    } else if (text.equals(Tokens.COMMA) || text.equals(Tokens.CLOSING_PARENTHESES)) {
+                        currentWS.addProperty(FormattingConstants.WS, FormattingConstants.EMPTY_SPACE);
+                    }
+                }
+            }
+
+            // Iterate and format expressions.
+            if (node.has(FormattingConstants.EXPRESSIONS)) {
+                JsonArray expressions = node.getAsJsonArray(FormattingConstants.EXPRESSIONS);
+                iterateAndFormatMembers(indentation.isEmpty() ? indentationOfParent : indentation,
+                        expressions);
+            }
+
+            // Handle type name formatting.
+            if (node.has(FormattingConstants.TYPE)) {
+                node.getAsJsonObject(FormattingConstants.TYPE).add(FormattingConstants.FORMATTING_CONFIG,
+                        this.getFormattingConfig(0, 1, 0, false,
+                                this.getWhiteSpaceCount(indentationOfParent), true));
+            }
+        }
     }
 
     /**
@@ -6034,8 +6068,8 @@ private void modifyReturnTypeAnnotations(JsonObject node, String indentation) {
     }
 
     private void modifyExpressions(JsonObject node, String indentWithParentIndentation) {
-        if (node.has("expressions")) {
-            JsonArray expressions = node.getAsJsonArray("expressions");
+        if (node.has(FormattingConstants.EXPRESSIONS)) {
+            JsonArray expressions = node.getAsJsonArray(FormattingConstants.EXPRESSIONS);
             iterateAndFormatMembers(indentWithParentIndentation, expressions);
         }
     }

language-server/modules/langserver-core/src/main/java/org/ballerinalang/langserver/formatting/FormattingVisitor.java → language-server/modules/langserver-compiler/src/main/java/org/ballerinalang/langserver/compiler/format/FormattingVisitor.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.ballerinalang.langserver.formatting;
+package org.ballerinalang.langserver.compiler.format;
 
 import com.google.gson.JsonObject;
 

language-server/modules/langserver-core/src/main/java/org/ballerinalang/langserver/formatting/FormattingVisitorEntry.java → language-server/modules/langserver-compiler/src/main/java/org/ballerinalang/langserver/compiler/format/FormattingVisitorEntry.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.ballerinalang.langserver.formatting;
+package org.ballerinalang.langserver.compiler.format;
 
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;

language-server/modules/langserver-core/src/main/java/org/ballerinalang/langserver/formatting/Tokens.java → language-server/modules/langserver-compiler/src/main/java/org/ballerinalang/langserver/compiler/format/Tokens.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.ballerinalang.langserver.formatting;
+package org.ballerinalang.langserver.compiler.format;
 
 /**
  * Constants values to be used when comparing tokens in formatting.
@@ -104,4 +104,5 @@ public class Tokens {
     public static final String ONABORT = "onabort";
     public static final String ONCOMMIT = "oncommit";
     public static final String TRAP = "trap";
+    public static final String NEW = "new";
 }

language-server/modules/langserver-core/src/main/java/org/ballerinalang/langserver/formatting/FormattingSourceGen.java → language-server/modules/langserver-compiler/src/main/java/org/ballerinalang/langserver/compiler/sourcegen/FormattingSourceGen.java

@@ -13,11 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.ballerinalang.langserver.formatting;
+package org.ballerinalang.langserver.compiler.sourcegen;
 
 import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
+import org.ballerinalang.langserver.compiler.format.FormattingConstants;
 
 import java.util.ArrayList;
 import java.util.Comparator;

language-server/modules/langserver-core/src/main/java/org/ballerinalang/langserver/BallerinaTextDocumentService.java

@@ -29,15 +29,15 @@
 import org.ballerinalang.langserver.compiler.LSServiceOperationContext;
 import org.ballerinalang.langserver.compiler.common.LSCustomErrorStrategy;
 import org.ballerinalang.langserver.compiler.common.LSDocument;
+import org.ballerinalang.langserver.compiler.format.FormattingVisitorEntry;
 import org.ballerinalang.langserver.compiler.format.TextDocumentFormatUtil;
+import org.ballerinalang.langserver.compiler.sourcegen.FormattingSourceGen;
 import org.ballerinalang.langserver.compiler.workspace.WorkspaceDocumentException;
 import org.ballerinalang.langserver.compiler.workspace.WorkspaceDocumentManager;
 import org.ballerinalang.langserver.completions.CompletionKeys;
 import org.ballerinalang.langserver.completions.util.CompletionUtil;
 import org.ballerinalang.langserver.definition.LSReferencesException;
 import org.ballerinalang.langserver.diagnostic.DiagnosticsHelper;
-import org.ballerinalang.langserver.formatting.FormattingSourceGen;
-import org.ballerinalang.langserver.formatting.FormattingVisitorEntry;
 import org.ballerinalang.langserver.hover.util.HoverUtil;
 import org.ballerinalang.langserver.implementation.GotoImplementationCustomErrorStrategy;
 import org.ballerinalang.langserver.implementation.GotoImplementationUtil;

language-server/modules/langserver-core/src/main/java/org/ballerinalang/langserver/extensions/ballerina/document/BallerinaDocumentServiceImpl.java

@@ -37,10 +37,10 @@
 import org.ballerinalang.langserver.compiler.common.modal.SymbolMetaInfo;
 import org.ballerinalang.langserver.compiler.format.JSONGenerationException;
 import org.ballerinalang.langserver.compiler.format.TextDocumentFormatUtil;
+import org.ballerinalang.langserver.compiler.sourcegen.FormattingSourceGen;
 import org.ballerinalang.langserver.compiler.workspace.WorkspaceDocumentException;
 import org.ballerinalang.langserver.compiler.workspace.WorkspaceDocumentManager;
 import org.ballerinalang.langserver.extensions.OASGenerationException;
-import org.ballerinalang.langserver.formatting.FormattingSourceGen;
 import org.ballerinalang.model.tree.ServiceNode;
 import org.ballerinalang.model.tree.TopLevelNode;
 import org.ballerinalang.openapi.CodeGenerator;

language-server/modules/langserver-core/src/main/java/org/ballerinalang/langserver/extensions/ballerina/fragment/BallerinaFragmentServiceImpl.java

@@ -26,7 +26,7 @@
 import org.ballerinalang.langserver.compiler.common.modal.BallerinaFile;
 import org.ballerinalang.langserver.compiler.format.JSONGenerationException;
 import org.ballerinalang.langserver.compiler.format.TextDocumentFormatUtil;
-import org.ballerinalang.langserver.formatting.FormattingSourceGen;
+import org.ballerinalang.langserver.compiler.sourcegen.FormattingSourceGen;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.wso2.ballerinalang.compiler.tree.BLangCompilationUnit;

language-server/modules/langserver-core/src/test/java/org/ballerinalang/langserver/formatting/FormattingTest.java

@@ -151,6 +151,7 @@ public Object[][] fileProvider() {
                 {"expectedInvocation.bal", "invocation.bal"},
                 {"expectedTypeDesc.bal", "typeDesc.bal"},
                 {"expectedAnonObject.bal", "anonObject.bal"},
+                {"expectedTypeInitExpr.bal", "typeInitExpr.bal"},
         };
     }
 

language-server/modules/langserver-core/src/test/java/org/ballerinalang/langserver/sourcegen/SourceGenTest.java

@@ -20,9 +20,9 @@
 import org.ballerinalang.langserver.compiler.LSCompiler;
 import org.ballerinalang.langserver.compiler.LSServiceOperationContext;
 import org.ballerinalang.langserver.compiler.format.TextDocumentFormatUtil;
+import org.ballerinalang.langserver.compiler.sourcegen.FormattingSourceGen;
 import org.ballerinalang.langserver.compiler.workspace.WorkspaceDocumentManager;
 import org.ballerinalang.langserver.compiler.workspace.WorkspaceDocumentManagerImpl;
-import org.ballerinalang.langserver.formatting.FormattingSourceGen;
 import org.ballerinalang.langserver.util.TestUtil;
 import org.eclipse.lsp4j.jsonrpc.Endpoint;
 import org.slf4j.Logger;