Formatter Maven plugin

rosetta-ide/src/main/java/com/regnosys/rosetta/ide/formatting/RosettaFormattingService.java

@@ -24,18 +24,15 @@
 
 import org.eclipse.lsp4j.FormattingOptions;
 import org.eclipse.lsp4j.TextEdit;
-import org.eclipse.xtext.formatting.IIndentationInformation;
 import org.eclipse.xtext.formatting2.IFormatter2;
 import org.eclipse.xtext.formatting2.regionaccess.ITextReplacement;
 import org.eclipse.xtext.ide.server.Document;
 import org.eclipse.xtext.ide.server.formatting.FormattingService;
 import org.eclipse.xtext.preferences.ITypedPreferenceValues;
-import org.eclipse.xtext.preferences.MapBasedPreferenceValues;
 import org.eclipse.xtext.resource.XtextResource;
 import org.eclipse.xtext.util.TextRegion;
 
-import com.google.common.base.Strings;
-import com.regnosys.rosetta.formatting2.RosettaFormatterPreferenceKeys;
+import com.regnosys.rosetta.formatting2.FormattingOptionsAdaptor;
 
 /**
  * This class allows passing additional formatting parameters as defined in
@@ -47,55 +44,17 @@
  * - expose injected fields to child classes (make them protected)
  */
 public class RosettaFormattingService extends FormattingService {
-	public static String PREFERENCE_INDENTATION_KEY = "indentation";
-	public static String PREFERENCE_MAX_LINE_WIDTH_KEY = "maxLineWidth";
-	public static String PREFERENCE_CONDITIONAL_MAX_LINE_WIDTH_KEY = "conditionalMaxLineWidth";
-
 	@Inject
 	private Provider<IFormatter2> formatter2Provider;
-
 	@Inject
-	private IIndentationInformation indentationInformation;
-
-	protected ITypedPreferenceValues createPreferences(FormattingOptions options) {
-		MapBasedPreferenceValues preferences = new MapBasedPreferenceValues();
-
-		String indent = indentationInformation.getIndentString();
-		if (options != null) {
-			if (options.isInsertSpaces()) {
-				indent = Strings.padEnd("", options.getTabSize(), ' ');
-			}
-		}
-		preferences.put(PREFERENCE_INDENTATION_KEY, indent);
-
-		if (options == null) {
-			return preferences;
-		}
+	private FormattingOptionsAdaptor formattingOptionsAdapter;
 
-		Number conditionalMaxLineWidth = options.getNumber(PREFERENCE_CONDITIONAL_MAX_LINE_WIDTH_KEY);
-		if (conditionalMaxLineWidth != null) {
-			preferences.put(RosettaFormatterPreferenceKeys.conditionalMaxLineWidth, conditionalMaxLineWidth.intValue());
-		}
-		Number maxLineWidth = options.getNumber(PREFERENCE_MAX_LINE_WIDTH_KEY);
-		if (maxLineWidth != null) {
-			preferences.put(RosettaFormatterPreferenceKeys.maxLineWidth, maxLineWidth.intValue());
-			if (conditionalMaxLineWidth == null) {
-				int defaultConditionalMaxLineWidth = RosettaFormatterPreferenceKeys.conditionalMaxLineWidth.toValue(RosettaFormatterPreferenceKeys.conditionalMaxLineWidth.getDefaultValue());
-				int defaultMaxLineWidth = RosettaFormatterPreferenceKeys.maxLineWidth.toValue(RosettaFormatterPreferenceKeys.maxLineWidth.getDefaultValue());
-				double defaultRatio = (double)defaultConditionalMaxLineWidth / defaultMaxLineWidth;
-				preferences.put(RosettaFormatterPreferenceKeys.conditionalMaxLineWidth, (int)(maxLineWidth.doubleValue() * defaultRatio));
-			}
-		}
-
-		return preferences;
-	}
-
 	@Override
 	public List<TextEdit> format(XtextResource resource, Document document, int offset, int length,
 			FormattingOptions options) {
 		List<TextEdit> result = new ArrayList<>();
 		if (this.formatter2Provider != null) {
-			ITypedPreferenceValues preferences = createPreferences(options);
+			ITypedPreferenceValues preferences = formattingOptionsAdapter.createPreferences(options);
 			List<ITextReplacement> replacements = format2(resource, new TextRegion(offset, length), preferences);
 			for (ITextReplacement r : replacements) {
 				result.add(toTextEdit(document, r.getReplacementText(), r.getOffset(), r.getLength()));

rosetta-ide/src/main/java/com/regnosys/rosetta/ide/server/RosettaLanguageServer.java

@@ -0,0 +1,13 @@
+package com.regnosys.rosetta.ide.server;
+
+import java.util.concurrent.CompletableFuture;
+
+import org.eclipse.lsp4j.FormattingOptions;
+import org.eclipse.lsp4j.jsonrpc.services.JsonRequest;
+import org.eclipse.lsp4j.services.LanguageServer;
+
+public interface RosettaLanguageServer extends LanguageServer{
+
+	@JsonRequest
+	CompletableFuture<FormattingOptions> getDefaultFormattingOptions();
+}

rosetta-ide/src/main/java/com/regnosys/rosetta/ide/server/RosettaLanguageServerImpl.java

@@ -23,20 +23,25 @@
 import org.eclipse.xtext.resource.IResourceServiceProvider;
 import org.eclipse.xtext.util.CancelIndicator;
 
+import com.regnosys.rosetta.formatting2.FormattingOptionsAdaptor;
 import com.regnosys.rosetta.ide.inlayhints.IInlayHintsResolver;
 import com.regnosys.rosetta.ide.inlayhints.IInlayHintsService;
 import com.regnosys.rosetta.ide.semantictokens.ISemanticTokensService;
 import com.regnosys.rosetta.ide.semantictokens.SemanticToken;
 
+import java.io.IOException;
 import java.util.Arrays;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 
+import javax.inject.Inject;
+
 /**
  * TODO: contribute to Xtext.
  *
  */
-public class RosettaLanguageServerImpl extends LanguageServerImpl  {
+public class RosettaLanguageServerImpl extends LanguageServerImpl  implements RosettaLanguageServer{
+	@Inject FormattingOptionsAdaptor formattingOptionsAdapter;
 
 	@Override
 	protected ServerCapabilities createServerCapabilities(InitializeParams params) {
@@ -170,4 +175,14 @@ protected SemanticTokens semanticTokensRange(SemanticTokensRangeParams params, C
 	public CompletableFuture<SemanticTokens> semanticTokensRange(SemanticTokensRangeParams params) {
 		return this.getRequestManager().runRead((cancelIndicator) -> this.semanticTokensRange(params, cancelIndicator));
 	}
+
+	@Override
+	public CompletableFuture<FormattingOptions> getDefaultFormattingOptions() {
+		try {
+			return CompletableFuture.completedFuture(formattingOptionsAdapter.readFormattingOptions(null));
+		} catch (IOException e) {
+			// should never happen, since null path always leads to default options being returned
+			return CompletableFuture.failedFuture(e);
+		}
+	}
 }

rosetta-ide/src/test/java/com/regnosys/rosetta/ide/formatting/FormattingTest.xtend

@@ -3,6 +3,7 @@ package com.regnosys.rosetta.ide.formatting
 import org.junit.jupiter.api.Test
 import com.regnosys.rosetta.ide.tests.AbstractRosettaLanguageServerTest
 import org.eclipse.lsp4j.FormattingOptions
+import com.regnosys.rosetta.formatting2.FormattingOptionsAdaptor
 
 class FormattingTest extends AbstractRosettaLanguageServerTest {
 	@Test
@@ -23,7 +24,7 @@ class FormattingTest extends AbstractRosettaLanguageServerTest {
 		testFormatting(
 			[
 				val options = new FormattingOptions
-				options.putNumber(RosettaFormattingService.PREFERENCE_MAX_LINE_WIDTH_KEY, 10)
+				options.putNumber(FormattingOptionsAdaptor.PREFERENCE_MAX_LINE_WIDTH_KEY, 10)
 				it.options = options
 			],
 			[
@@ -67,7 +68,7 @@ class FormattingTest extends AbstractRosettaLanguageServerTest {
 		testFormatting(
 			[
 				val options = new FormattingOptions
-				options.putNumber(RosettaFormattingService.PREFERENCE_CONDITIONAL_MAX_LINE_WIDTH_KEY, 10)
+				options.putNumber(FormattingOptionsAdaptor.PREFERENCE_CONDITIONAL_MAX_LINE_WIDTH_KEY, 10)
 				it.options = options
 			],
 			[

rosetta-lang/model/RosettaExpression.xcore

@@ -244,6 +244,7 @@ class JoinOperation extends RosettaBinaryOperation {
 
 class RosettaOnlyExistsExpression extends RosettaExpression {
 	contains RosettaExpression[] args
+	boolean hasParentheses
 }
 
 /**

rosetta-lang/pom.xml

@@ -71,6 +71,10 @@
             <groupId>com.fasterxml.jackson.dataformat</groupId>
             <artifactId>jackson-dataformat-yaml</artifactId>
         </dependency>
+        <dependency>
+			<groupId>org.eclipse.lsp4j</groupId>
+			<artifactId>org.eclipse.lsp4j</artifactId>
+		</dependency>
         <!-- This dependency is only necessary to make it work in Eclipse. TODO:
         remove this and figure out a better way. -->
         <dependency>

rosetta-lang/src/main/java/com/regnosys/rosetta/Rosetta.xtext

@@ -789,7 +789,7 @@ RosettaCalcConditionalExpression returns RosettaExpression:
 ;
 
 RosettaCalcOnlyExists returns RosettaExpression:
-	{RosettaOnlyExistsExpression} (args+=RosettaOnlyExistsElement | ('(' args+=RosettaOnlyExistsElement (',' args+=RosettaOnlyExistsElement)* ')')) 'only' 'exists'
+	{RosettaOnlyExistsExpression} (args+=RosettaOnlyExistsElement | (hasParentheses?='(' args+=RosettaOnlyExistsElement (',' args+=RosettaOnlyExistsElement)* ')')) 'only' 'exists'
 ;
 
 RosettaOnlyExistsElement returns RosettaExpression:

rosetta-lang/src/main/java/com/regnosys/rosetta/formatting2/FormattingOptionsAdaptor.java

@@ -0,0 +1,94 @@
+package com.regnosys.rosetta.formatting2;
+
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Map;
+
+import org.eclipse.emf.mwe.core.resources.ResourceLoader;
+import org.eclipse.lsp4j.FormattingOptions;
+import org.eclipse.xtext.preferences.ITypedPreferenceValues;
+import org.eclipse.xtext.preferences.MapBasedPreferenceValues;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.base.Strings;
+
+public class FormattingOptionsAdaptor {
+	public static String PREFERENCE_INDENTATION_KEY = "indentation";
+	public static String PREFERENCE_MAX_LINE_WIDTH_KEY = "maxLineWidth";
+	public static String PREFERENCE_CONDITIONAL_MAX_LINE_WIDTH_KEY = "conditionalMaxLineWidth";
+
+	private static final String DEFAULT_FORMATTING_OPTIONS_PATH = "default-formatting-options.json";
+
+	public ITypedPreferenceValues createPreferences(FormattingOptions options) {
+		MapBasedPreferenceValues preferences = new MapBasedPreferenceValues();
+
+		String indent = "\t";
+		if (options != null) {
+			if (options.isInsertSpaces()) {
+				indent = Strings.padEnd("", options.getTabSize(), ' ');
+			}
+		}
+		preferences.put(PREFERENCE_INDENTATION_KEY, indent);
+
+		if (options == null) {
+			return preferences;
+		}
+
+		Number conditionalMaxLineWidth = options.getNumber(PREFERENCE_CONDITIONAL_MAX_LINE_WIDTH_KEY);
+		if (conditionalMaxLineWidth != null) {
+			preferences.put(RosettaFormatterPreferenceKeys.conditionalMaxLineWidth, conditionalMaxLineWidth.intValue());
+		}
+		Number maxLineWidth = options.getNumber(PREFERENCE_MAX_LINE_WIDTH_KEY);
+		if (maxLineWidth != null) {
+			preferences.put(RosettaFormatterPreferenceKeys.maxLineWidth, maxLineWidth.intValue());
+			if (conditionalMaxLineWidth == null) {
+				int defaultConditionalMaxLineWidth = RosettaFormatterPreferenceKeys.conditionalMaxLineWidth
+						.toValue(RosettaFormatterPreferenceKeys.conditionalMaxLineWidth.getDefaultValue());
+				int defaultMaxLineWidth = RosettaFormatterPreferenceKeys.maxLineWidth
+						.toValue(RosettaFormatterPreferenceKeys.maxLineWidth.getDefaultValue());
+				double defaultRatio = (double) defaultConditionalMaxLineWidth / defaultMaxLineWidth;
+				preferences.put(RosettaFormatterPreferenceKeys.conditionalMaxLineWidth,
+						(int) (maxLineWidth.doubleValue() * defaultRatio));
+			}
+		}
+
+		return preferences;
+	}
+
+	public FormattingOptions readFormattingOptions(String optionsPath) throws IOException {
+		InputStream resourceStream;
+		// If path not given, use default one
+		if (optionsPath == null) {
+			// Retrieve resource as an InputStream
+			resourceStream = ResourceLoader.class.getClassLoader().getResourceAsStream(DEFAULT_FORMATTING_OPTIONS_PATH);
+		} else {
+			resourceStream = new FileInputStream(optionsPath);
+		}
+
+		// Create an ObjectMapper, read JSON into a Map
+		ObjectMapper objectMapper = new ObjectMapper();
+		Map<String, Object> map = null;
+		map = objectMapper.readValue(resourceStream, Map.class);
+
+		// Create a FormattingOptions object
+		FormattingOptions formattingOptions = new FormattingOptions();
+
+		// Populate the FormattingOptions object
+		for (Map.Entry<String, Object> entry : map.entrySet()) {
+			String key = entry.getKey();
+			Object value = entry.getValue();
+
+			if (value instanceof String) {
+				formattingOptions.putString(key, (String) value);
+			} else if (value instanceof Number) {
+				formattingOptions.putNumber(key, (Number) value);
+			} else if (value instanceof Boolean) {
+				formattingOptions.putBoolean(key, (Boolean) value);
+			} else {
+				throw new IllegalArgumentException("Unsupported value type for key: " + key);
+			}
+		}
+		return formattingOptions;
+	}
+}

rosetta-lang/src/main/java/com/regnosys/rosetta/formatting2/FormattingUtil.java

@@ -29,7 +29,7 @@
 import org.eclipse.xtext.preferences.TypedPreferenceKey;
 
 public class FormattingUtil {
-	private ITextRegionExtensions getTextRegionExt(IFormattableDocument doc) {
+	public ITextRegionExtensions getTextRegionExt(IFormattableDocument doc) {
 		return doc.getRequest().getTextRegionAccess().getExtensions();
 	}
 

rosetta-lang/src/main/java/com/regnosys/rosetta/formatting2/IFormattedResourceAcceptor.java

@@ -0,0 +1,25 @@
+package com.regnosys.rosetta.formatting2;
+
+import org.eclipse.emf.ecore.resource.Resource;
+
+/**
+ * Functional interface for handling a formatted resource and its corresponding
+ * formatted text.
+ * <p>
+ * This interface allows customization of how formatted resources are processed,
+ * such as saving the content, logging it, or using it for validations or
+ * assertions in tests.
+ * </p>
+ */
+@FunctionalInterface
+public interface IFormattedResourceAcceptor {
+
+	/**
+	 * Accepts a formatted resource and its formatted content for further
+	 * processing.
+	 *
+	 * @param resource      the {@link Resource} that was formatted
+	 * @param formattedText the formatted content as a {@link String}
+	 */
+	void accept(Resource resource, String formattedText);
+}