caddyfile: Implement heredoc support #5385
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
francislavoie
added
feature ⚙️
This was referenced Feb 20, 2023
mholt
approved these changes
Feb 24, 2023
francislavoie
force-pushed
the
caddyfile-heredoc
branch
from
877a634 to
b7649be
Compare
|
Oh yeah, good point. Forgot to handle the case where we run out of runes to lex but we didn't find the heredoc marker. Adding a condition for that. I still want to add some more tests to this before merging. I'll do that next chance I get. |
francislavoie
force-pushed
the
caddyfile-heredoc
branch
from
869c862 to
fc38852
Compare
matthewpi
added a commit
to caddyserver/vscode-caddyfile
that referenced
this pull request
Feb 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm reopening my old feature branch from #3802 since I still think this should be implemented. Closes #5357
I've made some improvements to the implementation, some of which were possible because of improvements to the lexer we've made since 2020 when I first tried this.
This branch has a few commits at the end of the branch with some unrelated changes, mainly cleanup to some Caddyfile parsing/dispensing code that I noticed I could improve while reading around.
Copying the text from my previous PR:
Adds support for heredoc syntax to the Caddyfile, inspired by HCL (HashiCorp Config Language), and PHP 7.3's flexible syntax (trimming the front of every line based on the indentation of the ending marker: https://wiki.php.net/rfc/flexible_heredoc_nowdoc_syntaxes)
Here's an example:
Adapted JSON:
{ "apps": { "http": { "servers": { "srv0": { "listen": [ ":443" ], "routes": [ { "match": [ { "host": [ "example.com" ] } ], "handle": [ { "handler": "subroute", "routes": [ { "handle": [ { "body": "<html>\n <head><title>Foo</title>\n <body>Foo</body>\n</html>\n", "handler": "static_response", "status_code": 200 } ] } ] } ], "terminal": true } ] } } } } }Notice that the response body has the leading whitespace on each line stripped away.
This could use some more tests in
lexer.gobefore merging. There is an adapt test which is enough at a minimum for the moment.