Add support to HCL grammar for escaped backslash #6117

kbrockhoff · 2025-10-09T19:11:37Z

What's changed?

Added escaped backslash "\" to HCL grammar and reran Antlr generator.

What's your motivation?

HCL parsing fails in the edge case where an escaped backslash is the last value in a string.

Any additional context

This situation can arise when configuring AWS SecretsManager password rotation Lambdas.

Checklist

I've added unit tests to cover both positive and negative cases
I've read and applied the recipe conventions and best practices
I've used the IntelliJ IDEA auto-formatter on affected files

github-actions · 2025-10-10T01:31:52Z

rewrite-hcl/src/main/java/org/openrewrite/hcl/internal/grammar/HCLLexer.java

+import org.antlr.v4.runtime.Lexer;
+import org.antlr.v4.runtime.CharStream;
+import org.antlr.v4.runtime.Token;
+import org.antlr.v4.runtime.TokenStream;
 import org.antlr.v4.runtime.*;
-import org.antlr.v4.runtime.atn.ATN;
-import org.antlr.v4.runtime.atn.ATNDeserializer;
-import org.antlr.v4.runtime.atn.LexerATNSimulator;
-import org.antlr.v4.runtime.atn.PredictionContextCache;
+import org.antlr.v4.runtime.atn.*;


Suggested change

import org.antlr.v4.runtime.Lexer;

import org.antlr.v4.runtime.CharStream;

import org.antlr.v4.runtime.Token;

import org.antlr.v4.runtime.TokenStream;

import org.antlr.v4.runtime.*;

import org.antlr.v4.runtime.atn.ATN;

import org.antlr.v4.runtime.atn.ATNDeserializer;

import org.antlr.v4.runtime.atn.LexerATNSimulator;

import org.antlr.v4.runtime.atn.PredictionContextCache;

import org.antlr.v4.runtime.atn.*;

import org.antlr.v4.runtime.atn.ATN;

import org.antlr.v4.runtime.atn.ATNDeserializer;

import org.antlr.v4.runtime.atn.LexerATNSimulator;

import org.antlr.v4.runtime.atn.PredictionContextCache;

github-actions · 2025-10-10T01:31:52Z

rewrite-hcl/src/main/java/org/openrewrite/hcl/internal/grammar/HCLLexer.java

+		FOR_BRACE=1, FOR_BRACK=2, IF=3, IN=4, BooleanLiteral=5, NULL=6, LBRACE=7, 
+		RBRACE=8, ASSIGN=9, Identifier=10, WS=11, COMMENT=12, LINE_COMMENT=13, 
+		NEWLINE=14, NumericLiteral=15, QUOTE=16, HEREDOC_START=17, PLUS=18, AND=19, 
+		EQ=20, LT=21, COLON=22, LBRACK=23, LPAREN=24, MINUS=25, OR=26, NEQ=27, 
+		GT=28, QUESTION=29, RBRACK=30, RPAREN=31, MUL=32, NOT=33, LEQ=34, DOT=35, 
+		DIV=36, GEQ=37, ARROW=38, COMMA=39, MOD=40, ELLIPSIS=41, TILDE=42, TEMPLATE_INTERPOLATION_START=43, 
+		TemplateStringLiteral=44, TemplateStringLiteralChar=45, HP_WS=46, HP_COMMENT=47, 


Suggested change

FOR_BRACE=1, FOR_BRACK=2, IF=3, IN=4, BooleanLiteral=5, NULL=6, LBRACE=7,

RBRACE=8, ASSIGN=9, Identifier=10, WS=11, COMMENT=12, LINE_COMMENT=13,

NEWLINE=14, NumericLiteral=15, QUOTE=16, HEREDOC_START=17, PLUS=18, AND=19,

EQ=20, LT=21, COLON=22, LBRACK=23, LPAREN=24, MINUS=25, OR=26, NEQ=27,

GT=28, QUESTION=29, RBRACK=30, RPAREN=31, MUL=32, NOT=33, LEQ=34, DOT=35,

DIV=36, GEQ=37, ARROW=38, COMMA=39, MOD=40, ELLIPSIS=41, TILDE=42, TEMPLATE_INTERPOLATION_START=43,

TemplateStringLiteral=44, TemplateStringLiteralChar=45, HP_WS=46, HP_COMMENT=47,

FOR_BRACE=1, FOR_BRACK=2, IF=3, IN=4, BooleanLiteral=5, NULL=6, LBRACE=7,

RBRACE=8, ASSIGN=9, Identifier=10, WS=11, COMMENT=12, LINE_COMMENT=13,

NEWLINE=14, NumericLiteral=15, QUOTE=16, HEREDOC_START=17, PLUS=18, AND=19,

EQ=20, LT=21, COLON=22, LBRACK=23, LPAREN=24, MINUS=25, OR=26, NEQ=27,

GT=28, QUESTION=29, RBRACK=30, RPAREN=31, MUL=32, NOT=33, LEQ=34, DOT=35,

DIV=36, GEQ=37, ARROW=38, COMMA=39, MOD=40, ELLIPSIS=41, TILDE=42, TEMPLATE_INTERPOLATION_START=43,

TemplateStringLiteral=44, TemplateStringLiteralChar=45, HP_WS=46, HP_COMMENT=47,

github-actions · 2025-10-10T01:31:52Z

rewrite-hcl/src/main/java/org/openrewrite/hcl/internal/grammar/HCLLexer.java

+			"FOR_BRACE", "FOR_BRACK", "IF", "IN", "BooleanLiteral", "NULL", "LBRACE", 
+			"RBRACE", "ASSIGN", "StringLiteralChar", "Identifier", "WS", "COMMENT", 
+			"LINE_COMMENT", "NEWLINE", "LetterOrDigit", "Letter", "EscapeSequence", 
+			"HexDigit", "NumericLiteral", "ExponentPart", "QUOTE", "HEREDOC_START", 
+			"PLUS", "AND", "EQ", "LT", "COLON", "LBRACK", "LPAREN", "MINUS", "OR", 
+			"NEQ", "GT", "QUESTION", "RBRACK", "RPAREN", "MUL", "NOT", "LEQ", "DOT", 
+			"DIV", "GEQ", "ARROW", "COMMA", "MOD", "ELLIPSIS", "TILDE", "TEMPLATE_INTERPOLATION_START", 
+			"TemplateStringLiteral", "TemplateStringLiteralChar", "END_QUOTE", "HP_NEWLINE", 
+			"HP_WS", "HP_COMMENT", "HP_LINE_COMMENT", "HPIdentifier", "H_NEWLINE", 


Suggested change

"FOR_BRACE", "FOR_BRACK", "IF", "IN", "BooleanLiteral", "NULL", "LBRACE",

"RBRACE", "ASSIGN", "StringLiteralChar", "Identifier", "WS", "COMMENT",

"LINE_COMMENT", "NEWLINE", "LetterOrDigit", "Letter", "EscapeSequence",

"HexDigit", "NumericLiteral", "ExponentPart", "QUOTE", "HEREDOC_START",

"PLUS", "AND", "EQ", "LT", "COLON", "LBRACK", "LPAREN", "MINUS", "OR",

"NEQ", "GT", "QUESTION", "RBRACK", "RPAREN", "MUL", "NOT", "LEQ", "DOT",

"DIV", "GEQ", "ARROW", "COMMA", "MOD", "ELLIPSIS", "TILDE", "TEMPLATE_INTERPOLATION_START",

"TemplateStringLiteral", "TemplateStringLiteralChar", "END_QUOTE", "HP_NEWLINE",

"HP_WS", "HP_COMMENT", "HP_LINE_COMMENT", "HPIdentifier", "H_NEWLINE",

"FOR_BRACE", "FOR_BRACK", "IF", "IN", "BooleanLiteral", "NULL", "LBRACE",

"RBRACE", "ASSIGN", "StringLiteralChar", "Identifier", "WS", "COMMENT",

"LINE_COMMENT", "NEWLINE", "LetterOrDigit", "Letter", "EscapeSequence",

"HexDigit", "NumericLiteral", "ExponentPart", "QUOTE", "HEREDOC_START",

"PLUS", "AND", "EQ", "LT", "COLON", "LBRACK", "LPAREN", "MINUS", "OR",

"NEQ", "GT", "QUESTION", "RBRACK", "RPAREN", "MUL", "NOT", "LEQ", "DOT",

"DIV", "GEQ", "ARROW", "COMMA", "MOD", "ELLIPSIS", "TILDE", "TEMPLATE_INTERPOLATION_START",

"TemplateStringLiteral", "TemplateStringLiteralChar", "END_QUOTE", "HP_NEWLINE",

"HP_WS", "HP_COMMENT", "HP_LINE_COMMENT", "HPIdentifier", "H_NEWLINE",

github-actions · 2025-10-10T01:31:52Z

rewrite-hcl/src/main/java/org/openrewrite/hcl/internal/grammar/HCLLexer.java

+			null, null, null, "'if'", "'in'", null, "'null'", "'{'", "'}'", "'='", 
+			null, null, null, null, null, null, null, null, "'+'", "'&&'", "'=='", 
+			"'<'", "':'", "'['", "'('", "'-'", "'||'", "'!='", "'>'", "'?'", "']'", 
+			"')'", "'*'", "'!'", "'<='", "'.'", "'/'", "'>='", "'=>'", "','", "'%'", 
+			"'...'", "'~'"
+		};
+	}
+	private static final String[] _LITERAL_NAMES = makeLiteralNames();
+	private static String[] makeSymbolicNames() {
+		return new String[] {
+			null, "FOR_BRACE", "FOR_BRACK", "IF", "IN", "BooleanLiteral", "NULL", 


Suggested change

null, null, null, "'if'", "'in'", null, "'null'", "'{'", "'}'", "'='",

null, null, null, null, null, null, null, null, "'+'", "'&&'", "'=='",

"'<'", "':'", "'['", "'('", "'-'", "'||'", "'!='", "'>'", "'?'", "']'",

"')'", "'*'", "'!'", "'<='", "'.'", "'/'", "'>='", "'=>'", "','", "'%'",

"'...'", "'~'"

};

}

private static final String[] _LITERAL_NAMES = makeLiteralNames();

private static String[] makeSymbolicNames() {

return new String[] {

null, "FOR_BRACE", "FOR_BRACK", "IF", "IN", "BooleanLiteral", "NULL",

null, null, null, "'if'", "'in'", null, "'null'", "'{'", "'}'", "'='",

null, null, null, null, null, null, null, null, "'+'", "'&&'", "'=='",

"'<'", "':'", "'['", "'('", "'-'", "'||'", "'!='", "'>'", "'?'", "']'",

"')'", "'*'", "'!'", "'<='", "'.'", "'/'", "'>='", "'=>'", "','", "'%'",

null, "FOR_BRACE", "FOR_BRACK", "IF", "IN", "BooleanLiteral", "NULL",

"LBRACE", "RBRACE", "ASSIGN", "Identifier", "WS", "COMMENT", "LINE_COMMENT",

"NEWLINE", "NumericLiteral", "QUOTE", "HEREDOC_START", "PLUS", "AND",

"EQ", "LT", "COLON", "LBRACK", "LPAREN", "MINUS", "OR", "NEQ", "GT",

"QUESTION", "RBRACK", "RPAREN", "MUL", "NOT", "LEQ", "DOT", "DIV", "GEQ",

"ARROW", "COMMA", "MOD", "ELLIPSIS", "TILDE", "TEMPLATE_INTERPOLATION_START",

"TemplateStringLiteral", "TemplateStringLiteralChar", "HP_WS", "HP_COMMENT",

github-actions · 2025-10-10T01:31:53Z

rewrite-hcl/src/main/java/org/openrewrite/hcl/internal/grammar/HCLLexer.java

+	    private Stack<CurlyType> leftCurlyStack = new Stack<CurlyType>();
+	    private Stack<String> heredocIdentifier = new Stack<String>();


Suggested change

private Stack<CurlyType> leftCurlyStack = new Stack<CurlyType>();

private Stack<String> heredocIdentifier = new Stack<String>();

private Stack<CurlyType> leftCurlyStack = new Stack<>();

private Stack<String> heredocIdentifier = new Stack<>();

github-actions · 2025-10-10T01:31:53Z

rewrite-hcl/src/main/java/org/openrewrite/hcl/internal/grammar/JsonPathLexer.java

+import org.antlr.v4.runtime.Lexer;
+import org.antlr.v4.runtime.CharStream;
+import org.antlr.v4.runtime.Token;
+import org.antlr.v4.runtime.TokenStream;
 import org.antlr.v4.runtime.*;
-import org.antlr.v4.runtime.atn.ATN;
-import org.antlr.v4.runtime.atn.ATNDeserializer;
-import org.antlr.v4.runtime.atn.LexerATNSimulator;
-import org.antlr.v4.runtime.atn.PredictionContextCache;
+import org.antlr.v4.runtime.atn.*;


Suggested change

import org.antlr.v4.runtime.Lexer;

import org.antlr.v4.runtime.CharStream;

import org.antlr.v4.runtime.Token;

import org.antlr.v4.runtime.TokenStream;

import org.antlr.v4.runtime.*;

import org.antlr.v4.runtime.atn.ATN;

import org.antlr.v4.runtime.atn.ATNDeserializer;

import org.antlr.v4.runtime.atn.LexerATNSimulator;

import org.antlr.v4.runtime.atn.PredictionContextCache;

import org.antlr.v4.runtime.atn.*;

import org.antlr.v4.runtime.atn.ATN;

import org.antlr.v4.runtime.atn.ATNDeserializer;

import org.antlr.v4.runtime.atn.LexerATNSimulator;

import org.antlr.v4.runtime.atn.PredictionContextCache;

github-actions · 2025-10-10T01:31:53Z

rewrite-hcl/src/main/java/org/openrewrite/hcl/internal/grammar/JsonPathLexer.java

+		WS=1, UTF_8_BOM=2, MATCHES_REGEX_OPEN=3, LBRACE=4, RBRACE=5, LBRACK=6, 
+		RBRACK=7, LPAREN=8, RPAREN=9, AT=10, DOT=11, DOT_DOT=12, ROOT=13, WILDCARD=14, 
+		COLON=15, QUESTION=16, CONTAINS=17, TRUE=18, FALSE=19, NULL=20, Identifier=21, 
+		StringLiteral=22, PositiveNumber=23, NegativeNumber=24, NumericLiteral=25, 
+		COMMA=26, TICK=27, QUOTE=28, MATCHES=29, LOGICAL_OPERATOR=30, AND=31, 
+		OR=32, EQUALITY_OPERATOR=33, EQ=34, NE=35, MATCHES_REGEX_CLOSE=36, S=37, 


Suggested change

WS=1, UTF_8_BOM=2, MATCHES_REGEX_OPEN=3, LBRACE=4, RBRACE=5, LBRACK=6,

RBRACK=7, LPAREN=8, RPAREN=9, AT=10, DOT=11, DOT_DOT=12, ROOT=13, WILDCARD=14,

COLON=15, QUESTION=16, CONTAINS=17, TRUE=18, FALSE=19, NULL=20, Identifier=21,

StringLiteral=22, PositiveNumber=23, NegativeNumber=24, NumericLiteral=25,

COMMA=26, TICK=27, QUOTE=28, MATCHES=29, LOGICAL_OPERATOR=30, AND=31,

OR=32, EQUALITY_OPERATOR=33, EQ=34, NE=35, MATCHES_REGEX_CLOSE=36, S=37,

WS=1, UTF_8_BOM=2, MATCHES_REGEX_OPEN=3, LBRACE=4, RBRACE=5, LBRACK=6,

RBRACK=7, LPAREN=8, RPAREN=9, AT=10, DOT=11, DOT_DOT=12, ROOT=13, WILDCARD=14,

COLON=15, QUESTION=16, CONTAINS=17, TRUE=18, FALSE=19, NULL=20, Identifier=21,

StringLiteral=22, PositiveNumber=23, NegativeNumber=24, NumericLiteral=25,

COMMA=26, TICK=27, QUOTE=28, MATCHES=29, LOGICAL_OPERATOR=30, AND=31,

OR=32, EQUALITY_OPERATOR=33, EQ=34, NE=35, MATCHES_REGEX_CLOSE=36, S=37,

github-actions · 2025-10-10T01:31:53Z

rewrite-hcl/src/main/java/org/openrewrite/hcl/internal/grammar/JsonPathLexer.java

+			"WS", "UTF_8_BOM", "MATCHES_REGEX_OPEN", "LBRACE", "RBRACE", "LBRACK", 
+			"RBRACK", "LPAREN", "RPAREN", "AT", "DOT", "DOT_DOT", "ROOT", "WILDCARD", 
+			"COLON", "QUESTION", "CONTAINS", "TRUE", "FALSE", "NULL", "Identifier", 
+			"StringLiteral", "PositiveNumber", "NegativeNumber", "NumericLiteral", 
+			"COMMA", "TICK", "QUOTE", "MATCHES", "LOGICAL_OPERATOR", "AND", "OR", 
+			"EQUALITY_OPERATOR", "EQ", "NE", "ESCAPE_SEQUENCE", "UNICODE", "HEX_DIGIT", 
+			"SAFE_CODE_POINT", "EXPONENT_PART", "MINUS", "MATCHES_REGEX_CLOSE", "S", 


Suggested change

"WS", "UTF_8_BOM", "MATCHES_REGEX_OPEN", "LBRACE", "RBRACE", "LBRACK",

"RBRACK", "LPAREN", "RPAREN", "AT", "DOT", "DOT_DOT", "ROOT", "WILDCARD",

"COLON", "QUESTION", "CONTAINS", "TRUE", "FALSE", "NULL", "Identifier",

"StringLiteral", "PositiveNumber", "NegativeNumber", "NumericLiteral",

"COMMA", "TICK", "QUOTE", "MATCHES", "LOGICAL_OPERATOR", "AND", "OR",

"EQUALITY_OPERATOR", "EQ", "NE", "ESCAPE_SEQUENCE", "UNICODE", "HEX_DIGIT",

"SAFE_CODE_POINT", "EXPONENT_PART", "MINUS", "MATCHES_REGEX_CLOSE", "S",

"WS", "UTF_8_BOM", "MATCHES_REGEX_OPEN", "LBRACE", "RBRACE", "LBRACK",

"RBRACK", "LPAREN", "RPAREN", "AT", "DOT", "DOT_DOT", "ROOT", "WILDCARD",

"COLON", "QUESTION", "CONTAINS", "TRUE", "FALSE", "NULL", "Identifier",

"StringLiteral", "PositiveNumber", "NegativeNumber", "NumericLiteral",

"COMMA", "TICK", "QUOTE", "MATCHES", "LOGICAL_OPERATOR", "AND", "OR",

"EQUALITY_OPERATOR", "EQ", "NE", "ESCAPE_SEQUENCE", "UNICODE", "HEX_DIGIT",

"SAFE_CODE_POINT", "EXPONENT_PART", "MINUS", "MATCHES_REGEX_CLOSE", "S",

github-actions · 2025-10-10T01:31:53Z

rewrite-hcl/src/main/java/org/openrewrite/hcl/internal/grammar/JsonPathLexer.java

+			null, null, "'\\uFEFF'", null, "'{'", "'}'", "'['", "']'", "'('", "')'", 
+			"'@'", "'.'", "'..'", "'$'", "'*'", "':'", "'?'", "'contains'", "'true'", 
+			"'false'", "'null'", null, null, null, null, null, "','", "'''", "'\"'", 
+			"'=~'", null, "'&&'", "'||'", null, "'=='", "'!='"
+		};
+	}
+	private static final String[] _LITERAL_NAMES = makeLiteralNames();
+	private static String[] makeSymbolicNames() {


Suggested change

null, null, "'\\uFEFF'", null, "'{'", "'}'", "'['", "']'", "'('", "')'",

"'@'", "'.'", "'..'", "'$'", "'*'", "':'", "'?'", "'contains'", "'true'",

"'false'", "'null'", null, null, null, null, null, "','", "'''", "'\"'",

"'=~'", null, "'&&'", "'||'", null, "'=='", "'!='"

};

}

private static final String[] _LITERAL_NAMES = makeLiteralNames();

private static String[] makeSymbolicNames() {

null, null, "'\\uFEFF'", null, "'{'", "'}'", "'['", "']'", "'('", "')'",

"'@'", "'.'", "'..'", "'$'", "'*'", "':'", "'?'", "'contains'", "'true'",

"'false'", "'null'", null, null, null, null, null, "','", "'''", "'\"'",

null, "WS", "UTF_8_BOM", "MATCHES_REGEX_OPEN", "LBRACE", "RBRACE", "LBRACK",

"RBRACK", "LPAREN", "RPAREN", "AT", "DOT", "DOT_DOT", "ROOT", "WILDCARD",

"COLON", "QUESTION", "CONTAINS", "TRUE", "FALSE", "NULL", "Identifier",

"StringLiteral", "PositiveNumber", "NegativeNumber", "NumericLiteral",

"COMMA", "TICK", "QUOTE", "MATCHES", "LOGICAL_OPERATOR", "AND", "OR",

github-actions · 2025-10-10T01:31:53Z

rewrite-hcl/src/main/java/org/openrewrite/hcl/internal/grammar/JsonPathParserBaseListener.java

+	 * <p>The default implementation does nothing.</p>
+	 */
+	@Override public void visitErrorNode(ErrorNode node) { }
+}


Suggested change

}

}

add support to grammer for escaped backslash

7a329cd

github-project-automation bot added this to OpenRewrite Oct 9, 2025

github-project-automation bot moved this to In Progress in OpenRewrite Oct 9, 2025

jkschneider approved these changes Oct 10, 2025

View reviewed changes

github-project-automation bot moved this from In Progress to Ready to Review in OpenRewrite Oct 10, 2025

jkschneider merged commit 9242ddc into openrewrite:main Oct 10, 2025
2 checks passed

github-project-automation bot moved this from Ready to Review to Done in OpenRewrite Oct 10, 2025

jkschneider changed the title ~~Add support to HCL grammer for escaped backslash~~ Add support to HCL grammar for escaped backslash Oct 10, 2025

github-actions bot reviewed Oct 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add support to HCL grammar for escaped backslash #6117

Add support to HCL grammar for escaped backslash #6117

Uh oh!

kbrockhoff commented Oct 9, 2025

Uh oh!

Uh oh!

github-actions bot Oct 10, 2025

Uh oh!

github-actions bot Oct 10, 2025

Uh oh!

github-actions bot Oct 10, 2025

Uh oh!

github-actions bot Oct 10, 2025

Uh oh!

github-actions bot Oct 10, 2025

Uh oh!

github-actions bot Oct 10, 2025

Uh oh!

github-actions bot Oct 10, 2025

Uh oh!

github-actions bot Oct 10, 2025

Uh oh!

github-actions bot Oct 10, 2025

Uh oh!

github-actions bot Oct 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		private Stack<CurlyType> leftCurlyStack = new Stack<CurlyType>();
		private Stack<String> heredocIdentifier = new Stack<String>();

Add support to HCL grammar for escaped backslash #6117

Add support to HCL grammar for escaped backslash #6117

Uh oh!

Conversation

kbrockhoff commented Oct 9, 2025

What's changed?

What's your motivation?

Any additional context

Checklist

Uh oh!

Uh oh!

github-actions bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants