org.eclipse.jdt.core.formatter.tabulation.* settings are ignored

[rybesh]

I am using jdtls with eglot in Emacs.

I have the following lines in .settings/org.eclipse.buildship.core.prefs:

org.eclipse.jdt.core.formatter.tabulation.char=SPACE
org.eclipse.jdt.core.formatter.tabulation.size=2

But eglot-format results in a formatted buffer with 8-space indentation, whether or not those lines are there.

[rgrunber]

I haven't tried this out yet, but I would think you need to place those JDT settings into .settings/org.eclipse.jdt.core.prefs.

[rybesh]

That doesn’t seem to have any effect either.

[rgrunber]

I think I found the problem. Similar to emacs-lsp/lsp-java#318 (comment) .

The textDocument/formatting & textDocument/rangeFormatting requests take as a parameter (aside from the document itself & the range to apply) FormattingOptions. In particular this includes :

/**
  * Size of a tab in spaces.
  */
tabSize: uinteger;

/**
  * Prefer spaces over tabs.
  */
insertSpaces: boolean;

So the spec expects that the client should send options for whether to use tabs/spaces and the number of spaces for a tab.

The language server then overrides tabulation.char & tabulation.size in the format call (because those are the options controlling that), so what you set is being ignored. I confirmed this by adding another option like org.eclipse.jdt.core.formatter.lineSplit=50, which was respected. I just had to place a .settings/org.eclipse.jdt.core.prefs where .settings/ was a sibling to the src folder.

eclipse.jdt.ls/org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/FormatterHandler.java

Lines 154 to 163 in 395b5da

	Integer tabSize = options.getTabSize();
	if (tabSize != null) {
	int tSize = tabSize.intValue();
	if (tSize > 0) {
	eclipseOptions.put(DefaultCodeFormatterConstants.FORMATTER_TAB_SIZE, Integer.toString(tSize));
	}
	}
	boolean insertSpaces = options.isInsertSpaces();
	eclipseOptions.put(DefaultCodeFormatterConstants.FORMATTER_TAB_CHAR, insertSpaces ? JavaCore.SPACE : JavaCore.TAB);
	return eclipseOptions;

Do you know what values eglot is sending to JDT-LS ? Is there a way made available to users to set this on the emacs side ?

[rybesh]

Unfortunately communication between eglot and jdtls is somewhat shrouded in mystery:

joaotavora/eglot#1222