Skip to content

Add YAML file type support in Explorer perspective #7632

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.

Sign up for GitHub

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

Open
leehaut wants to merge 1 commit into
base: main
Choose a base branch
from
+1,007 −45
Open

Add YAML file type support in Explorer perspective #7632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 67 additions & 42 deletions rcp/src/main/java/org/apache/hop/ui/hopgui/ContentEditorTm4eSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import java.util.Map;
import org.apache.hop.ui.core.PropsUi;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.TextAttribute;
import org.eclipse.jface.text.rules.IToken;
import org.eclipse.jface.text.rules.Token;
import org.eclipse.swt.graphics.Color;
Expand All @@ -53,14 +54,16 @@ final class ContentEditorTm4eSupport {
private static final String SCOPE_XML = "text.xml";
private static final String SCOPE_SQL = "source.sql";
private static final String SCOPE_PYTHON = "source.python";
private static final String SCOPE_YAML = "source.yaml";

/** Maps TM4E scope names to grammar resource filenames (classpath-relative to grammars/). */
private static final Map<String, String> GRAMMAR_FILES =
Map.of(
SCOPE_JSON, "json.json",
SCOPE_XML, "xml.json",
SCOPE_SQL, "sql.json",
SCOPE_PYTHON, "python.json");
SCOPE_PYTHON, "python.json",
SCOPE_YAML, "yaml.json");

// Same palette as before (light/dark) for consistency
private static final RGB L_COMMENT = new RGB(128, 128, 128);
Expand Down Expand Up @@ -101,20 +104,18 @@ private static boolean isDark() {

/** Returns the grammar scope name for the given language id, or null if not supported by TM4E. */
static String scopeForLanguage(String languageId) {
if (languageId == null) return null;
switch (languageId.toLowerCase(java.util.Locale.ROOT)) {
case "json":
return SCOPE_JSON;
case "xml":
return SCOPE_XML;
case "sql":
return SCOPE_SQL;
case "python":
case "py":
return SCOPE_PYTHON;
default:
return null;
if (languageId == null) {
return null;
}

return switch (languageId.toLowerCase(java.util.Locale.ROOT)) {
case "json" -> SCOPE_JSON;
case "xml" -> SCOPE_XML;
case "sql" -> SCOPE_SQL;
case "python", "py" -> SCOPE_PYTHON;
case "yaml", "yml" -> SCOPE_YAML;
default -> null;
};
}

/**
Expand All @@ -124,10 +125,14 @@ static String scopeForLanguage(String languageId) {
static org.eclipse.jface.text.source.SourceViewerConfiguration createConfiguration(
String languageId, Display display) {
String scopeName = scopeForLanguage(languageId);
if (scopeName == null) return null;
if (scopeName == null) {
return null;
}
ContentEditorTm4eSupport support = new ContentEditorTm4eSupport(display);
IGrammar grammar = support.getGrammar(scopeName);
if (grammar == null) return null;
if (grammar == null) {
return null;
}
return ContentEditorTm4eSupport.createReconciler(support, grammar);
}

Expand Down Expand Up @@ -210,7 +215,9 @@ private org.eclipse.jface.text.TextAttribute scopeToAttribute(List<String> scope
}

private RGB scopeToRgb(List<String> scopes) {
if (scopes == null || scopes.isEmpty()) return isDark() ? D_DEFAULT : L_DEFAULT;
if (scopes == null || scopes.isEmpty()) {
return isDark() ? D_DEFAULT : L_DEFAULT;
}
String scope = String.join(" ", scopes);
boolean dark = isDark();

Expand All @@ -219,33 +226,59 @@ private RGB scopeToRgb(List<String> scopes) {
}

// Comments (all languages)
if (scope.contains("comment")) return dark ? D_COMMENT : L_COMMENT;
if (scope.contains("comment")) {
return dark ? D_COMMENT : L_COMMENT;
}

// JSON keys: must be checked before "string" - VS Code uses "support.type.property-name.json"
if (scope.contains("support.type.property-name") || scope.contains("property-name"))
if (scope.contains("support.type.property-name") || scope.contains("property-name")) {
return dark ? D_JSON_KEY : L_JSON_KEY;
}

// YAML keys: TextMate uses entity.name.tag.yaml (often with string.unquoted.*)
if (scope.contains("entity.name.tag.yaml")) {
return dark ? D_JSON_KEY : L_JSON_KEY;
}

// Strings (JSON: string.quoted.double; XML/SQL: string.quoted.*)
if (scope.contains("string")) return dark ? D_STRING : L_STRING;
// Strings (JSON: string.quoted.double; XML/SQL: string.quoted.*; YAML: string.*)
if (scope.contains("string")) {
return dark ? D_STRING : L_STRING;
}

// Numbers and constants
if (scope.contains("constant.numeric") || scope.contains("number"))
if (scope.contains("constant.numeric") || scope.contains("number")) {
return dark ? D_NUMBER : L_NUMBER;
if (scope.contains("constant.language")) return dark ? D_CONSTANT : L_CONSTANT;
if (scope.contains("constant.other")) return dark ? D_CONSTANT : L_CONSTANT;
}
if (scope.contains("constant.language")) {
return dark ? D_CONSTANT : L_CONSTANT;
}
if (scope.contains("constant.other")) {
return dark ? D_CONSTANT : L_CONSTANT;
}

// Keywords (SQL, etc.)
if (scope.contains("keyword")
|| scope.contains("support.function")
|| scope.contains("support.type")) return dark ? D_KEYWORD : L_KEYWORD;
if (scope.contains("storage.type") || scope.contains("storage.modifier"))
|| scope.contains("support.type")) {
return dark ? D_KEYWORD : L_KEYWORD;
}
if (scope.contains("storage.type") || scope.contains("storage.modifier")) {
return dark ? D_KEYWORD : L_KEYWORD;
if (scope.contains("entity.name.function")) return dark ? D_KEYWORD : L_KEYWORD;
}
if (scope.contains("entity.name.function")) {
return dark ? D_KEYWORD : L_KEYWORD;
}

// XML: <? ?> then tags then attribute names
if (scope.contains("meta.tag.preprocessor")) return dark ? D_XML_HEADER : L_XML_HEADER;
if (scope.contains("entity.name.tag") || scope.contains(".tag")) return dark ? D_TAG : L_TAG;
if (scope.contains("entity.other.attribute-name")) return dark ? D_JSON_KEY : L_JSON_KEY;
if (scope.contains("meta.tag.preprocessor")) {
return dark ? D_XML_HEADER : L_XML_HEADER;
}
if (scope.contains("entity.name.tag") || scope.contains(".tag")) {
return dark ? D_TAG : L_TAG;
}
if (scope.contains("entity.other.attribute-name")) {
return dark ? D_JSON_KEY : L_JSON_KEY;
}

return dark ? D_DEFAULT : L_DEFAULT;
}
Expand Down Expand Up @@ -356,7 +389,9 @@ private java.util.List<ColoredToken> tokenizeLines(
int rangeEnd = Math.min(rangeOffset + rangeLength, len);

for (int lineIndex = 0; lineIndex < lines.length; lineIndex++) {
if (lineIndex >= MAX_LINES_TO_TOKENIZE) break;
if (lineIndex >= MAX_LINES_TO_TOKENIZE) {
break;
}

String raw = lines[lineIndex];
int rawLen = raw.length();
Expand Down Expand Up @@ -409,16 +444,6 @@ private java.util.List<ColoredToken> tokenizeLines(
return result;
}

private static final class ColoredToken {
final int offset;
final int length;
final org.eclipse.jface.text.TextAttribute attribute;

ColoredToken(int offset, int length, org.eclipse.jface.text.TextAttribute attribute) {
this.offset = offset;
this.length = length;
this.attribute = attribute;
}
}
private record ColoredToken(int offset, int length, TextAttribute attribute) {}
}
}
6 changes: 3 additions & 3 deletions rcp/src/main/java/org/apache/hop/ui/hopgui/RuleBasedSourceViewerConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

/**
* Builds a {@link SourceViewerConfiguration} for the content editor. Uses TM4E with TextMate
* grammars for syntax highlighting of JSON, XML, SQL, and Python; other languages get a plain
* grammars for syntax highlighting of JSON, XML, SQL, Python, and YAML; other languages get a plain
* config.
*/
public final class RuleBasedSourceViewerConfiguration {
Expand All @@ -31,9 +31,9 @@ private RuleBasedSourceViewerConfiguration() {}

/**
* Creates a configuration for the given language. Uses TM4E when a grammar is available (json,
* xml, sql, python); otherwise returns a plain configuration with no syntax highlighting.
* xml, sql, python, yaml); otherwise returns a plain configuration with no syntax highlighting.
*
* @param languageId language id (e.g. "json", "xml", "sql"), or null for plain text
* @param languageId language id (e.g. "json", "xml", "sql", "yaml"), or null for plain text
* @return configuration, never null
*/
public static SourceViewerConfiguration create(String languageId) {
Expand Down
Loading
Loading