Auto-indent HCL with Ctrl+Shift+F

CHANGELOG.md

@@ -4,11 +4,13 @@
 
 ### Added
 
+- Auto-indentation via <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>F</kbd> [#69](https://github.com/avenga/couper-vscode/pull/69)
 - `log_level` attribute for `settings` block [#62](https://github.com/avenga/couper-vscode/pull/62)
 - `disable_private_caching` attribute for `jwt` block [#65](https://github.com/avenga/couper-vscode/pull/65)
 - `beta_scope_map` attribute for `jwt` block [#66](https://github.com/avenga/couper-vscode/pull/66)
 - `backend_request` and `backend_response` variables [#64](https://github.com/avenga/couper-vscode/pull/64)
 
+
 ### Fixed
 
 - type of `custom_log_fields` [#62](https://github.com/avenga/couper-vscode/pull/62)

src/extension.js

@@ -4,8 +4,9 @@ Object.defineProperty(exports, "__esModule", { value: true })
 
 const Completion = require("./completion")
 const Definition = require("./definition")
+const Formatter = require("./formatter")
 
 exports.activate = (context) => {
-	context.subscriptions.concat(Completion.providers, Definition.providers)
+	context.subscriptions.concat(Completion.providers, Definition.providers, Formatter.providers)
 	console.info("Extension loaded: Couper Configuration")
 }

src/formatter.js

@@ -0,0 +1,65 @@
+"use strict"
+
+const vscode = require('vscode')
+
+const selector = { language: 'couper' }
+
+const HEREDOC_REGEX = /^\s*[\w-]+\s*=\s*<<(-?)([\w-]+)\s*$/
+const LBRACE_REGEX = /[{(\[]\s*$/
+const RBRACE_REGEX = /^\s*[})\]]\s*$/
+
+const providers = []
+
+const formattingProvider = vscode.languages.registerDocumentFormattingEditProvider(selector, {
+	provideDocumentFormattingEdits(document, options) {
+		const padding = options.insertSpaces ? " " : "\t"
+		const indentFactor = options.insertSpaces ? options.tabSize : 1
+
+		let edits = []
+		let indentDepth = 0
+		let hereDocDelimiter
+		let isHereDoc = false
+		let isIndentedHereDoc = false
+		let hereDocEndRegex
+
+		for (let i = 0; i < document.lineCount; i++) {
+			const line = document.lineAt(i)
+			if (!isHereDoc && RBRACE_REGEX.test(line.text)) {
+				indentDepth--
+			} else if (isHereDoc) {
+				const foundHereDocEnd = hereDocEndRegex.test(line.text)
+				if (foundHereDocEnd && isIndentedHereDoc) {
+					indentDepth--
+				}
+				isHereDoc = !foundHereDocEnd
+			}
+
+			if (!isHereDoc || isIndentedHereDoc) {
+				const text = line.text.substring(line.firstNonWhitespaceCharacterIndex)
+				const indentation = "".padStart(indentDepth * indentFactor, padding)
+				edits.push(vscode.TextEdit.replace(line.range, indentation + text))
+			}
+
+			if (!isHereDoc && LBRACE_REGEX.test(line.text)) {
+				indentDepth++
+				continue
+			}
+
+			const matches = line.text.match(HEREDOC_REGEX)
+			if (matches !== null) {
+				isIndentedHereDoc = matches[1] === "-"
+				hereDocDelimiter = matches[2]
+				isHereDoc = true
+				hereDocEndRegex = new RegExp('^\\s*' + hereDocDelimiter + '\\s*$')
+				if (isIndentedHereDoc) {
+					indentDepth++
+				}
+			}
+		}
+		return edits
+	}
+})
+
+providers.push(formattingProvider)
+
+exports.providers = providers

syntaxes/hcl.json

@@ -316,7 +316,7 @@
       "patterns" : [
         {
           "comment" : "Heredoc string",
-          "begin": "<<-?(\\w+)",
+          "begin": "<<-?([\\w-]+)",
           "beginCaptures": {
             "0": { "name": "entity.name.tag.hcl" }
           },