Use “squiggly” heredocs. #19600
Use “squiggly” heredocs. #19600
Conversation
Formula/abcm2ps.rb
Outdated
| @@ -20,7 +20,7 @@ def install | |||
| end | |||
|
|
|||
| test do | |||
| (testpath/"voices.abc").write <<-EOF.undent | |||
| (testpath/"voices.abc").write <<~EOF | |||
There was a problem hiding this comment.
@ilovezfs If you're feeling really pedantic I'd change these to EOS too but feel free to 👎 that.
There was a problem hiding this comment.
The set of all heredoc delimiters used in core is
EOS
'EOS'
XML
XSL
EOS_CONFIG
'EOS_CONFIG'
HTML
EOF
'EOF'
EOPLIST
EOI
'EOS_SRC'
EOM
EOCNF
PYTHON
PROTO
PLODRC
TEST_SCRIPT
ERR
Are there others besides EOF we also no longer ❤️ ?
There was a problem hiding this comment.
@ilovezfs Personally I hate all non-EOS ones 😁. I think 'EOS' has different behaviour, though, in terms of quoting etc. Will defer to you on them.
There was a problem hiding this comment.
I'm in favour of <<~LANGUAGE where it makes sense, because TextMate supports nested syntax highlighting this way, and other editors may too. EOS for the remaining cases.
There was a problem hiding this comment.
@reitermarkus which of them are taking advantage of that?
EOS
'EOS'
XML
XSL
EOS_CONFIG
'EOS_CONFIG'
HTML
EOF
'EOF'
EOPLIST
EOI
'EOS_SRC'
EOM
EOCNF
PYTHON
PROTO
PLODRC
TEST_SCRIPT
ERR
I'm guessing XML, XSL, HTML, and PYTHON? And maybe PROTO?
There was a problem hiding this comment.
I pushed an all-EOS commit 7a81b5a but can consider backing some of those out.
Also, what is the magic delimiter for C? I assume we don't want to go down that road given how many C code examples we have.
Personally I think just standardizing on EOS is probably the simplest thing to do at least in formulae.
There was a problem hiding this comment.
I'm guessing XML, XSL, HTML, and PYTHON? And maybe PROTO?
and maybe EOPLIST?
There was a problem hiding this comment.
Also, what is the magic delimiter for C?
Just C.
and maybe EOPLIST?
plist doesn't have its own, but XML works. (PLIST_XML works too, or anything like *_XML.)
There was a problem hiding this comment.
Full list: HTML, XML, CSS, SQL, CPP, C, JS|JAVASCRIPT, JQUERY, SH|SHELL, LUA, RUBY.
There was a problem hiding this comment.
@reitermarkus for now I'd like to proceed with standardizing on EOS but we could consider supporting editor heredoc syntax highlighting at some point if that becomes a broadly supported feature in editors beyond TextMate. However, I think the value proposition is pretty low if the language has to be manually specified via the heredoc delimiter because it's currently something humans would need to police, as opposed to something that could be automatically enforced.
|
Yikes. This is quite some |
ilovezfs
force-pushed
the
squiggly-heredocs
branch
from
7a81b5a
to
2f6fac3
Compare
|
Test part of |
|
There's a form feed character on line 68 causing it. |
brew install --build-from-source <formula>, where<formula>is the name of the formula you're submitting?brew audit --strict <formula>(after doingbrew install <formula>)?Goes together with Homebrew/brew#3319.
CC @reitermarkus @MikeMcQuaid