Added folding setting to keep displaying the closing tag after folding #1209
Conversation
Signed-off-by: Jessica He <jhe@redhat.com>
There was a problem hiding this comment.
Features working as intended:
A couple of changes, and add/change tests in https://github.com/eclipse/lemminx/blob/master/org.eclipse.lemminx/src/test/java/org/eclipse/lemminx/services/XMLFoldingsTest.java with the setting enabled/disabled.
| private boolean includeClosingTagInFold; | ||
|
|
||
| public XMLFoldingSettings() { | ||
| this.includeClosingTagInFold = DEFAULT_INCLUDE_CLOSING_TAG_IN_FOLD; |
There was a problem hiding this comment.
Since you have 2 constructors, you can use the overloaded one in the other, i.e. call XMLFoldingSettings(DEFAULT_INCLUDE_CLOSING_TAG_IN_FOLD); instead
There was a problem hiding this comment.
Indeed it is a good practive to have just one constructor which initialize all fields.
| return includeClosingTagInFold; | ||
| } | ||
|
|
||
| public void merge(XMLFoldingSettings newSettings) { |
There was a problem hiding this comment.
Add JavaDoc here similar to other merge definitions:
|
It shoud be nice to have test with this new settings. I suggest that you: define a new static method in private static void assertRanges(String[] lines, ExpectedIndentRange[] expected) {
assertRanges(lines, expected, "", null, new XMLFoldingSettings());
}
private static void assertRanges(String[] lines, ExpectedIndentRange[] expected, XMLFoldingSettings settings) {
assertRanges(lines, expected, "", null, settings);
}
private static void assertRanges(String[] lines, ExpectedIndentRange[] expected, String message, Integer nRanges) {
assertRanges(lines, expected, message, nRanges, new XMLFoldingSettings());
}
private static void assertRanges(String[] lines, ExpectedIndentRange[] expected, String message, Integer nRanges, XMLFoldingSettings settings)
TextDocument document = new TextDocument(String.join("\n", lines), "test://foo/bar.json");
DOMDocument xmlDocument = DOMParser.getInstance().parse(document, null);
XMLLanguageService languageService = new XMLLanguageService();
FoldingRangeCapabilities context = new FoldingRangeCapabilities();
context.setRangeLimit(nRanges);
settings.setCapabilities(context);
List<FoldingRange> actual = languageService.getFoldingRanges(xmlDocument, settings);
List<ExpectedIndentRange> actualRanges = new ArrayList<>();
for (FoldingRange f : actual) {
actualRanges.add(r(f.getStartLine(), f.getEndLine(), f.getKind()));
}
Collections.sort(actualRanges, (r1, r2) -> r1.startLine - r2.startLine);
assertArrayEquals(expected, actualRanges.toArray(), message);
}after that you can duplicate test and set your new settings includeClosingTagInFold: @Test
public void testFoldOneLevelWithincludeClosingTagInFoldAsFalse () {
String[] input = new String[] {
/*0*/"<html>",
/*1*/"Hello",
/*2*/"</html>"
};
XMLFoldingSettings settings = new XMLFoldingSettings ();
settings.setIncludeClosingTagInFold(false)
assertRanges(input, new ExpectedIndentRange[] {r(0, 2)}, );
}Please not the test will fail, please adjust the proper ranges. And you can do the same thing for existing tests. |
Signed-off-by: Jessica He <jhe@redhat.com>
| @@ -49,6 +49,10 @@ public XMLFoldings(XMLExtensionsRegistry extensionsRegistry) { | |||
| this.extensionsRegistry = extensionsRegistry; | |||
| } | |||
|
|
|||
| public boolean isIncludeClosingTagInFold(XMLFoldingSettings context) { | |||
There was a problem hiding this comment.
As it is not an important method, I will move it after getFoldingRanges which is main entry method. More this method is used only in this class, so you can set to private. At the end, this method don't need some fields of the XMLFoldings, so I will add static, in other words :
private static isIncludeClosingTagInFold(XMLFoldingSettings foldingSettings)
| @@ -32,4 +32,35 @@ public FoldingRangeCapabilities getCapabilities() { | |||
| public Integer getRangeLimit() { | |||
| return capabilities != null ? capabilities.getRangeLimit() : null; | |||
| } | |||
|
|
|||
| public static final boolean DEFAULT_INCLUDE_CLOSING_TAG_IN_FOLD = false; | |||
There was a problem hiding this comment.
this static filed is used only in this class, set it to private.
| } | ||
|
|
||
| @Test | ||
| public void testFoldTwoLevelWithincludeClosingTagInFoldAsTrue () { |
There was a problem hiding this comment.
remove tabs with space (public void test...). Do the samething for other test methods
Signed-off-by: Jessica He <jhe@redhat.com>
|
Great job @JessicaJHee ! |
angelozerr
changed the title
Requires redhat-developer/vscode-xml/pull/714
Signed-off-by: Jessica He jhe@redhat.com