-
Notifications
You must be signed in to change notification settings - Fork 443
POC: Support google-java-format #2592
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
CsCherrYY
wants to merge
2
commits into
eclipse-jdtls:main
Choose a base branch
from
CsCherrYY:cs-google-format
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
130 changes: 130 additions & 0 deletions
130
org.eclipse.jdt.ls.core/src/com/google/googlejavaformat/java/GoogleJavaFormatter.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| package com.google.googlejavaformat.java; | ||
|
|
||
| import com.google.common.base.Preconditions; | ||
| import com.google.common.collect.Range; | ||
| import com.google.googlejavaformat.java.SnippetFormatter.SnippetKind; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import org.eclipse.jdt.core.dom.ASTParser; | ||
| import org.eclipse.jdt.core.formatter.CodeFormatter; | ||
| import org.eclipse.jface.text.IRegion; | ||
| import org.eclipse.jface.text.Region; | ||
| import org.eclipse.text.edits.MultiTextEdit; | ||
| import org.eclipse.text.edits.ReplaceEdit; | ||
| import org.eclipse.text.edits.TextEdit; | ||
|
|
||
| /** Runs the Google Java formatter on the given code. */ | ||
| public class GoogleJavaFormatter extends CodeFormatter { | ||
|
|
||
| private static final int INDENTATION_SIZE = 2; | ||
|
|
||
| @Override | ||
| public TextEdit format( | ||
| int kind, String source, int offset, int length, int indentationLevel, String lineSeparator) { | ||
| IRegion[] regions = new IRegion[] {new Region(offset, length)}; | ||
| return formatInternal(kind, source, regions, indentationLevel); | ||
| } | ||
|
|
||
| @Override | ||
| public TextEdit format( | ||
| int kind, String source, IRegion[] regions, int indentationLevel, String lineSeparator) { | ||
| return formatInternal(kind, source, regions, indentationLevel); | ||
| } | ||
|
|
||
| @Override | ||
| public String createIndentationString(int indentationLevel) { | ||
| Preconditions.checkArgument( | ||
| indentationLevel >= 0, | ||
| "Indentation level cannot be less than zero. Given: %s", | ||
| indentationLevel); | ||
| int spaces = indentationLevel * INDENTATION_SIZE; | ||
| StringBuilder buf = new StringBuilder(spaces); | ||
| for (int i = 0; i < spaces; i++) { | ||
| buf.append(' '); | ||
| } | ||
| return buf.toString(); | ||
| } | ||
|
|
||
| /** Runs the Google Java formatter on the given source, with only the given ranges specified. */ | ||
| private TextEdit formatInternal(int kind, String source, IRegion[] regions, int initialIndent) { | ||
| try { | ||
| boolean includeComments = | ||
| (kind & CodeFormatter.F_INCLUDE_COMMENTS) == CodeFormatter.F_INCLUDE_COMMENTS; | ||
| kind &= ~CodeFormatter.F_INCLUDE_COMMENTS; | ||
| SnippetKind snippetKind; | ||
| switch (kind) { | ||
| case ASTParser.K_EXPRESSION: | ||
| snippetKind = SnippetKind.EXPRESSION; | ||
| break; | ||
| case ASTParser.K_STATEMENTS: | ||
| snippetKind = SnippetKind.STATEMENTS; | ||
| break; | ||
| case ASTParser.K_CLASS_BODY_DECLARATIONS: | ||
| snippetKind = SnippetKind.CLASS_BODY_DECLARATIONS; | ||
| break; | ||
| case ASTParser.K_COMPILATION_UNIT: | ||
| snippetKind = SnippetKind.COMPILATION_UNIT; | ||
| break; | ||
| default: | ||
| throw new IllegalArgumentException(String.format("Unknown snippet kind: %d", kind)); | ||
| } | ||
| List<Replacement> replacements = | ||
| new SnippetFormatter() | ||
| .format( | ||
| snippetKind, source, rangesFromRegions(regions), initialIndent, includeComments); | ||
| if (idempotent(source, regions, replacements)) { | ||
| // Do not create edits if there's no diff. | ||
| return null; | ||
| } | ||
| // Convert replacements to text edits. | ||
| return editFromReplacements(replacements); | ||
| } catch (IllegalArgumentException | FormatterException exception) { | ||
| // Do not format on errors. | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private List<Range<Integer>> rangesFromRegions(IRegion[] regions) { | ||
| List<Range<Integer>> ranges = new ArrayList<>(); | ||
| for (IRegion region : regions) { | ||
| ranges.add(Range.closedOpen(region.getOffset(), region.getOffset() + region.getLength())); | ||
| } | ||
| return ranges; | ||
| } | ||
|
|
||
| /** @return {@code true} if input and output texts are equal, else {@code false}. */ | ||
| private boolean idempotent(String source, IRegion[] regions, List<Replacement> replacements) { | ||
| // This implementation only checks for single replacement. | ||
| if (replacements.size() == 1) { | ||
| Replacement replacement = replacements.get(0); | ||
| String output = replacement.getReplacementString(); | ||
| // Entire source case: input = output, nothing changed. | ||
| if (output.equals(source)) { | ||
| return true; | ||
| } | ||
| // Single region and single replacement case: if they are equal, nothing changed. | ||
| if (regions.length == 1) { | ||
| Range<Integer> range = replacement.getReplaceRange(); | ||
| String snippet = source.substring(range.lowerEndpoint(), range.upperEndpoint()); | ||
| if (output.equals(snippet)) { | ||
| return true; | ||
| } | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| private TextEdit editFromReplacements(List<Replacement> replacements) { | ||
| // Split the replacements that cross line boundaries. | ||
| TextEdit edit = new MultiTextEdit(); | ||
| for (Replacement replacement : replacements) { | ||
| Range<Integer> replaceRange = replacement.getReplaceRange(); | ||
| edit.addChild( | ||
| new ReplaceEdit( | ||
| replaceRange.lowerEndpoint(), | ||
| replaceRange.upperEndpoint() - replaceRange.lowerEndpoint(), | ||
| replacement.getReplacementString())); | ||
| } | ||
| return edit; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
144 changes: 144 additions & 0 deletions
144
...se.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/preferences/FormatterPreferences.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2023 Red Hat Inc. and others. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License 2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Microsoft Corporation - initial API and implementation | ||
| *******************************************************************************/ | ||
| package org.eclipse.jdt.ls.core.internal.preferences; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import org.eclipse.jdt.core.formatter.DefaultCodeFormatterConstants; | ||
|
|
||
| public class FormatterPreferences { | ||
|
|
||
| // @formatter:off | ||
| // < JDTLS settings, eclipse settings > | ||
| private static Map<String, String> eclipseOptions = Map.ofEntries( | ||
| Map.entry("lineSplit", DefaultCodeFormatterConstants.FORMATTER_LINE_SPLIT), | ||
| Map.entry("comment.line.length", DefaultCodeFormatterConstants.FORMATTER_COMMENT_LINE_LENGTH), | ||
| Map.entry("join.wrapped.lines", DefaultCodeFormatterConstants.FORMATTER_JOIN_WRAPPED_LINES), | ||
| Map.entry("use.on.off.tags", DefaultCodeFormatterConstants.FORMATTER_USE_ON_OFF_TAGS), | ||
| Map.entry("disabling.tag", DefaultCodeFormatterConstants.FORMATTER_DISABLING_TAG), | ||
| Map.entry("enabling.tag", DefaultCodeFormatterConstants.FORMATTER_ENABLING_TAG), | ||
| Map.entry("indent.parameter.description", DefaultCodeFormatterConstants.FORMATTER_COMMENT_INDENT_PARAMETER_DESCRIPTION), | ||
| Map.entry("indent.root.tags", DefaultCodeFormatterConstants.FORMATTER_COMMENT_INDENT_ROOT_TAGS), | ||
| Map.entry("align.tags.descriptions.grouped", DefaultCodeFormatterConstants.FORMATTER_COMMENT_ALIGN_TAGS_DESCREIPTIONS_GROUPED), | ||
| Map.entry("align.tags.names.descriptions", DefaultCodeFormatterConstants.FORMATTER_COMMENT_ALIGN_TAGS_NAMES_DESCRIPTIONS), | ||
| Map.entry("clear.blank.lines.in.javadoc.comment", DefaultCodeFormatterConstants.FORMATTER_COMMENT_CLEAR_BLANK_LINES_IN_JAVADOC_COMMENT), | ||
| Map.entry("blank.lines.between.import.groups", DefaultCodeFormatterConstants.FORMATTER_BLANK_LINES_BETWEEN_IMPORT_GROUPS), | ||
| Map.entry("format.line.comments", DefaultCodeFormatterConstants.FORMATTER_COMMENT_FORMAT_LINE_COMMENT), | ||
| Map.entry("format.block.comments", DefaultCodeFormatterConstants.FORMATTER_COMMENT_FORMAT_BLOCK_COMMENT), | ||
| Map.entry("format.javadoc.comments", DefaultCodeFormatterConstants.FORMATTER_COMMENT_FORMAT_JAVADOC_COMMENT), | ||
| Map.entry("keep.loop.body.block.on.one.line", DefaultCodeFormatterConstants.FORMATTER_KEEP_LOOP_BODY_BLOCK_ON_ONE_LINE), | ||
| Map.entry("keep.anonymous.type.declaration.on.one.line", DefaultCodeFormatterConstants.FORMATTER_KEEP_ANONYMOUS_TYPE_DECLARATION_ON_ONE_LINE), | ||
| Map.entry("keep.type.declaration.on.one.line", DefaultCodeFormatterConstants.FORMATTER_KEEP_TYPE_DECLARATION_ON_ONE_LINE), | ||
| Map.entry("keep.method.body.on.one.line", DefaultCodeFormatterConstants.FORMATTER_KEEP_METHOD_BODY_ON_ONE_LINE), | ||
| Map.entry("insert.space.after.closing.angle.bracket.in.type.arguments", DefaultCodeFormatterConstants.FORMATTER_INSERT_SPACE_AFTER_CLOSING_ANGLE_BRACKET_IN_TYPE_ARGUMENTS), | ||
| Map.entry("insert.space.after.opening.brace.in.array.initializer", DefaultCodeFormatterConstants.FORMATTER_INSERT_SPACE_AFTER_OPENING_BRACE_IN_ARRAY_INITIALIZER), | ||
| Map.entry("insert.space.before.closing.brace.in.array.initializer", DefaultCodeFormatterConstants.FORMATTER_INSERT_SPACE_BEFORE_CLOSING_BRACE_IN_ARRAY_INITIALIZER), | ||
| Map.entry("brace.position.for.block", DefaultCodeFormatterConstants.FORMATTER_BRACE_POSITION_FOR_BLOCK), | ||
| Map.entry("alignment.for.enum.constants", DefaultCodeFormatterConstants.FORMATTER_ALIGNMENT_FOR_ENUM_CONSTANTS), | ||
| Map.entry("alignment.for.parameters.in.method.declaration", DefaultCodeFormatterConstants.FORMATTER_ALIGNMENT_FOR_PARAMETERS_IN_METHOD_DECLARATION) | ||
| ); | ||
|
|
||
| // < JDTLS camelCase value, eclipse underline value> | ||
| private static Map<String, String> valueMap = Map.ofEntries( | ||
| Map.entry("commonLines", "common_lines"), | ||
| Map.entry("separateLinesIfNotEmpty", "separate_lines_if_not_empty"), | ||
| Map.entry("separateLinesIfWrapped", "separate_lines_if_wrapped"), | ||
| Map.entry("separateLines", "separate_lines"), | ||
| Map.entry("preservePositions", "preserve_positions"), | ||
| Map.entry("never", "one_line_never"), | ||
| Map.entry("ifEmpty", "one_line_if_empty"), | ||
| Map.entry("ifSingleItem", "one_line_if_single_item"), | ||
| Map.entry("always", "one_line_always"), | ||
| Map.entry("preserve", "one_line_preserve"), | ||
| Map.entry("doNotInsert", "do not insert"), | ||
| Map.entry("endOfLine", "end_of_line"), | ||
| Map.entry("nextLine", "next_line"), | ||
| Map.entry("nextLineIndented", "next_line_indented"), | ||
| Map.entry("nextLineOnWrap", "next_line_on_wrap") | ||
| ); | ||
| // @formatter:on | ||
|
|
||
| /** | ||
| * Convert known language server formatter options to eclipse formatter | ||
| * settings. | ||
| * | ||
| * @param lsOptions | ||
| * the given language server formatter options | ||
| * @return the converted eclipse formatter options | ||
| */ | ||
| public static Map<String, String> toEclipseOptions(Map<String, String> lsOptions) { | ||
| return lsOptions.entrySet().stream().filter(option -> eclipseOptions.containsKey(option.getKey())).collect(Collectors.toMap(option -> eclipseOptions.get(option.getKey()), option -> { | ||
| String value = option.getValue(); | ||
| if (valueMap.containsKey(value)) { | ||
| return valueMap.get(value); | ||
| } | ||
| return value; | ||
| })); | ||
| } | ||
|
|
||
| /** | ||
| * Convert language server formatter alignment value to eclipse formatter | ||
| * alignment value. | ||
| * | ||
| * @param alignmentValue | ||
| * the given language server formatter alignment value | ||
| * @return the converted eclipse formatter alignment value | ||
| */ | ||
| public static String getEclipseAlignmentValue(Map<String, Object> alignmentValue) { | ||
| Object forceSplit = alignmentValue.getOrDefault("force.split", Boolean.FALSE); | ||
| Object indentationStyle = alignmentValue.getOrDefault("indentation.style", "indentDefault"); | ||
| Object wrappingStyle = alignmentValue.getOrDefault("wrapping.style", "compact"); | ||
| if (forceSplit instanceof Boolean forceSplitBoolean && indentationStyle instanceof String indentationStyleString && wrappingStyle instanceof String wrappingStyleString) { | ||
| int indentationStyleInt = 0; | ||
| switch (indentationStyleString) { | ||
| case "indentDefault": | ||
| indentationStyleInt = DefaultCodeFormatterConstants.INDENT_DEFAULT; | ||
| break; | ||
| case "indentOnColumn": | ||
| indentationStyleInt = DefaultCodeFormatterConstants.INDENT_ON_COLUMN; | ||
| break; | ||
| case "indentByOne": | ||
| indentationStyleInt = DefaultCodeFormatterConstants.INDENT_BY_ONE; | ||
| break; | ||
| default: | ||
| return null; | ||
| } | ||
| int wrappingStyleInt = 0; | ||
| switch (wrappingStyleString) { | ||
| case "noSplit": | ||
| wrappingStyleInt = DefaultCodeFormatterConstants.WRAP_NO_SPLIT; | ||
| break; | ||
| case "compact": | ||
| wrappingStyleInt = DefaultCodeFormatterConstants.WRAP_COMPACT; | ||
| break; | ||
| case "compactFirstBreak": | ||
| wrappingStyleInt = DefaultCodeFormatterConstants.WRAP_COMPACT_FIRST_BREAK; | ||
| break; | ||
| case "onePerLine": | ||
| wrappingStyleInt = DefaultCodeFormatterConstants.WRAP_ONE_PER_LINE; | ||
| break; | ||
| case "nextShifted": | ||
| wrappingStyleInt = DefaultCodeFormatterConstants.WRAP_NEXT_SHIFTED; | ||
| break; | ||
| case "nextPerLine": | ||
| wrappingStyleInt = DefaultCodeFormatterConstants.WRAP_NEXT_PER_LINE; | ||
| break; | ||
| default: | ||
| return null; | ||
| } | ||
| return DefaultCodeFormatterConstants.createAlignmentValue(forceSplitBoolean, wrappingStyleInt, indentationStyleInt); | ||
| } | ||
| return null; | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently this file is directly copied from https://github.com/google/google-java-format/blob/master/eclipse_plugin/src/com/google/googlejavaformat/java/GoogleJavaFormatter.java, since the google-java-format plugin is not available in the maven central.