Merge pull request #110 from fonsecas72/improve-hcl

src/hcl/hcl.ts

@@ -22,134 +22,29 @@ export const conf: IRichLanguageConfiguration = {
 		{ open: '{', close: '}' },
 		{ open: '[', close: ']' },
 		{ open: '(', close: ')' },
-		{ open: '"', close: '"', notIn: ['string'] },
+		{ open: '"', close: '"', notIn: ['string'] }
-		{ open: "'", close: "'", notIn: ['string', 'comment'] }
 	],
 	surroundingPairs: [
 		{ open: '{', close: '}' },
 		{ open: '[', close: ']' },
 		{ open: '(', close: ')' },
-		{ open: '"', close: '"' },
+		{ open: '"', close: '"' }
-		{ open: "'", close: "'" }
 	]
 };
 
 export const language = <ILanguage>{
 	defaultToken: '',
-	tokenPostfix: '.tf',
+	tokenPostfix: '.hcl',
 
 	keywords: [
 		'var',
 		'local',
-		'module',
-		'data',
 		'path',
-		'terraform',
+		'for_each',
-		'resource',
-		'provider',
-		'variable',
-		'output',
-		'locals',
 		'any',
 		'string',
 		'number',
 		'bool',
-		'abs',
-		'ceil',
-		'floor',
-		'log',
-		'max',
-		'min',
-		'pow',
-		'signum',
-		'chomp',
-		'format',
-		'formatlist',
-		'indent',
-		'join',
-		'lower',
-		'regex',
-		'regexall',
-		'replace',
-		'split',
-		'strrev',
-		'substr',
-		'title',
-		'trimspace',
-		'upper',
-		'chunklist',
-		'coalesce',
-		'coalescelist',
-		'compact',
-		'concat',
-		'contains',
-		'distinct',
-		'element',
-		'flatten',
-		'index',
-		'keys',
-		'length',
-		'list',
-		'lookup',
-		'map',
-		'matchkeys',
-		'merge',
-		'range',
-		'reverse',
-		'setintersection',
-		'setproduct',
-		'setunion',
-		'slice',
-		'sort',
-		'transpose',
-		'values',
-		'zipmap',
-		'base64decode',
-		'base64encode',
-		'base64gzip',
-		'csvdecode',
-		'jsondecode',
-		'jsonencode',
-		'urlencode',
-		'yamldecode',
-		'yamlencode',
-		'abspath',
-		'dirname',
-		'pathexpand',
-		'basename',
-		'file',
-		'fileexists',
-		'fileset',
-		'filebase64',
-		'templatefile',
-		'formatdate',
-		'timeadd',
-		'timestamp',
-		'base64sha256',
-		'base64sha512',
-		'bcrypt',
-		'filebase64sha256',
-		'filebase64sha512',
-		'filemd5',
-		'filemd1',
-		'filesha256',
-		'filesha512',
-		'md5',
-		'rsadecrypt',
-		'sha1',
-		'sha256',
-		'sha512',
-		'uuid',
-		'uuidv5',
-		'cidrhost',
-		'cidrnetmask',
-		'cidrsubnet',
-		'tobool',
-		'tolist',
-		'tomap',
-		'tonumber',
-		'toset',
-		'tostring',
 		'true',
 		'false',
 		'null',
@@ -162,6 +57,7 @@ export const language = <ILanguage>{
 	],
 
 	operators: [
+		'=',
 		'>=',
 		'<=',
 		'==',
@@ -181,28 +77,45 @@ export const language = <ILanguage>{
 		':'
 	],
 
-	// we include these common regular expressions
 	symbols: /[=><!~?:&|+\-*\/\^%]+/,
 	escapes: /\\(?:[abfnrtv\\"']|x[0-9A-Fa-f]{1,4}|u[0-9A-Fa-f]{4}|U[0-9A-Fa-f]{8})/,
-	variable: /\${?[\w]+}?/,
+	terraformFunctions: /(abs|ceil|floor|log|max|min|pow|signum|chomp|format|formatlist|indent|join|lower|regex|regexall|replace|split|strrev|substr|title|trimspace|upper|chunklist|coalesce|coalescelist|compact|concat|contains|distinct|element|flatten|index|keys|length|list|lookup|map|matchkeys|merge|range|reverse|setintersection|setproduct|setunion|slice|sort|transpose|values|zipmap|base64decode|base64encode|base64gzip|csvdecode|jsondecode|jsonencode|urlencode|yamldecode|yamlencode|abspath|dirname|pathexpand|basename|file|fileexists|fileset|filebase64|templatefile|formatdate|timeadd|timestamp|base64sha256|base64sha512|bcrypt|filebase64sha256|filebase64sha512|filemd5|filemd1|filesha256|filesha512|md5|rsadecrypt|sha1|sha256|sha512|uuid|uuidv5|cidrhost|cidrnetmask|cidrsubnet|tobool|tolist|tomap|tonumber|toset|tostring)/,
-
+	terraformMainBlocks: /(module|data|terraform|resource|provider|variable|output|locals)/,
-	// The main tokenizer for our languages
 	tokenizer: {
 		root: [
-			// identifiers and keywords
+			// highlight main blocks
 			[
-				/[a-zA-Z_]\w*/,
+				/^@terraformMainBlocks([ \t]*)([\w-]+|"[\w-]+"|)([ \t]*)([\w-]+|"[\w-]+"|)([ \t]*)(\{)/,
+				['type', '', 'string', '', 'string', '', '@brackets']
+			],
+			// highlight all the remaining blocks
+			[
+				/(\w+[ \t]+)([ \t]*)([\w-]+|"[\w-]+"|)([ \t]*)([\w-]+|"[\w-]+"|)([ \t]*)(\{)/,
+				['identifier', '', 'string', '', 'string', '', '@brackets']
+			],
+			// highlight block
+			[
+				/(\w+[ \t]+)([ \t]*)([\w-]+|"[\w-]+"|)([ \t]*)([\w-]+|"[\w-]+"|)(=)(\{)/,
+				['identifier', '', 'string', '', 'operator', '', '@brackets']
+			],
+			// terraform general highlight - shared with expressions
+			{ include: '@terraform' }
+		],
+		terraform: [
+			// highlight terraform functions
+			[/@terraformFunctions(\()/, ['type', '@brackets']],
+			// all other words are variables or keywords
+			[
+				/[a-zA-Z_]\w*-*/, // must work with variables such as foo-bar and also with negative numbers
 				{
 					cases: {
 						'@keywords': { token: 'keyword.$0' },
-						'@default': 'identifier'
+						'@default': 'variable'
 					}
 				}
 			],
-
-			// whitespace
 			{ include: '@whitespace' },
-
+			{ include: '@heredoc' },
 			// delimiters and operators
 			[/[{}()\[\]]/, '@brackets'],
 			[/[<>](?!@symbols)/, '@brackets'],
@@ -210,44 +123,72 @@ export const language = <ILanguage>{
 				/@symbols/,
 				{
 					cases: {
-						'@operators': 'delimiter',
+						'@operators': 'operator',
 						'@default': ''
 					}
 				}
 			],
-
 			// numbers
 			[/\d*\d+[eE]([\-+]?\d+)?/, 'number.float'],
 			[/\d*\.\d+([eE][\-+]?\d+)?/, 'number.float'],
 			[/\d[\d']*/, 'number'],
 			[/\d/, 'number'],
-
+			[/[;,.]/, 'delimiter'], // delimiter: after number because of .\d floats
-			// delimiter: after number because of .\d floats
-			[/[;,.]/, 'delimiter'],
-
 			// strings
-			[/"([^"\\]|\\.)*$/, 'string.invalid'], // non-teminated string
+			[/"/, 'string', '@string'], // this will include expressions
-			[/"/, 'string', '@string']
+			[/'/, 'invalid']
+		],
+		heredoc: [
+			[
+				/<<[-]*\s*["]?([\w\-]+)["]?/,
+				{ token: 'string.heredoc.delimiter', next: '@heredocBody.$1' }
+			]
+		],
+		heredocBody: [
+			[
+				/^([\w\-]+)$/,
+				{
+					cases: {
+						'$1==$S2': [
+							{
+								token: 'string.heredoc.delimiter',
+								next: '@popall'
+							}
+						],
+						'@default': 'string.heredoc'
+					}
+				}
+			],
+			[/./, 'string.heredoc']
 		],
-
 		whitespace: [
 			[/[ \t\r\n]+/, ''],
 			[/\/\*/, 'comment', '@comment'],
 			[/\/\/.*$/, 'comment'],
 			[/#.*$/, 'comment']
 		],
-
 		comment: [
 			[/[^\/*]+/, 'comment'],
 			[/\*\//, 'comment', '@pop'],
 			[/[\/*]/, 'comment']
 		],
-
 		string: [
+			[/\$\{/, { token: 'delimiter', next: '@stringExpression' }],
+			[/[^\\"\$]+/, 'string'],
+			[/@escapes/, 'string.escape'],
+			[/\\./, 'string.escape.invalid'],
+			[/"/, 'string', '@popall']
+		],
+		stringInsideExpression: [
 			[/[^\\"]+/, 'string'],
 			[/@escapes/, 'string.escape'],
 			[/\\./, 'string.escape.invalid'],
 			[/"/, 'string', '@pop']
+		],
+		stringExpression: [
+			[/\}/, { token: 'delimiter', next: '@pop' }],
+			[/"/, 'string', '@stringInsideExpression'],
+			{ include: '@terraform' }
 		]
 	}
 };