Shellscript Syntax Highlighting never recognizes the end of a <<-EOF delimiter #72

Activity

1. winstliu

   added

   bug

   on Apr 6, 2017
2. winstliu commented on Aug 22, 2017

   

   winstliu

   on Aug 22, 2017

   Contributor

   More actions

   Fixed by #77.
3. winstliu

   closed this as completedon Aug 22, 2017
4. baziliolg commented on Oct 4, 2017

   

   baziliolg

   on Oct 4, 2017

   Last edited by winstliu

   More actions

   Looks like I still have similar issue with Atom 1.21.0.
   This code snippet is rendered incorrectly.

   function blabla() {
       local _s3tag=`python - << END
   import sys, xml.etree.ElementTree as ET
   p = ET.parse("${CODE}/blabla.xml").findall('property')
   for i in p:
       if i.get('name') == "s3tag":
           print i.get('value')
   END`
       # Here we should have normal syntax highlighting but instead it is all red
       [[ -n ${_s3tag} ]] && echo "Found _s3tag: ${_s3tag}"
   }

   Screenshot link
5. winstliu commented on Oct 4, 2017

   

   winstliu

   on Oct 4, 2017

   Contributor

   More actions

   @baziliolg That issue is very hard to fix with the current TextMate-based grammar system. I'm sure you know that heredoc identifiers must end at the end of the line, and so that's what language-shellscript requires. However, since it's in an interpolated string, the "end" of the line is actually the `. Unfortunately, there's no way to tell the heredoc match that without substantial pattern duplication.
6. ryran commented on Sep 26, 2018

   

   ryran

   on Sep 26, 2018

   More actions

   I think there's been a regression. I'm not sure when it started, since I've been doing pretty much only python for quite a few months, but I just opened a shell script in atom-1.32.0-beta0 and immediately noticed the syntax highlighting was off.

   Here's a simple reproducer.

   

   In case it's not clear, the syntax highlighter didn't catch the EOF with tab before it. The following shows what it should look like (though of course the hereword shouldn't have to be left-justified).

   
7. Arcanemagus commented on Oct 10, 2018

   

   Arcanemagus

   on Oct 10, 2018

   More actions

   @ryran It is actually a bug in the TextMate grammar that the tab is allowed before EOF, not the other way around 😉.

   According to the Here Documents reference documentation the closing limit string must start at the first character of a line.

   As to why this changed: The Tree-sitter parsing system was recently enabled by default in the v1.32 betas, as announced. You can switch back to the TextMate parser by disabling the option, but again, your specific scenario is now correct and was previously incorrect.
8. ryran commented on Oct 11, 2018

   

   ryran

   on Oct 11, 2018

   Last edited by ryran

   More actions

   Thanks for the response @Arcanemagus

   According to the Here Documents reference documentation the closing limit string must start at the first character of a line.

   Uhhh ... (1) the Advanced Scripting Guide is not "reference documentation" and (2) it fails to mention anything explicit about where the limit string needs to be when redirection operator is <<-.

   In contrast, the BASH man page makes it crystal clear:

   $ man bash | grep -A2 'If the redirection operator is <<-'
      If the redirection operator is <<-, then all leading tab characters are stripped
      from input lines and the line containing delimiter. This allows here-documents
      within shell scripts to be indented in a natural fashion.
   

   Note that this is a very common idiom for bash scripts. The following script works just fine:

   #!/bin/bash
   usage() {
   	cat <<-EOF
   		Usage: ${0##*/} FOO BAR
   	EOF
   }
   [[ $# -eq 2 ]] && echo $2 $1 || usage

   However, notice that Github's colorization only sees a problem with the following (where I removed the - from the <<-).

   #!/bin/bash
   usage() {
   	cat <<EOF
   		Usage: ${0##*/} FOO BAR
   	EOF
   }
   [[ $# -eq 2 ]] && echo $2 $1 || usage

   And of course it fails when I try to run it.

   $ ./x.sh  a b
   ./x.sh: line 8: warning: here-document at line 3 delimited by end-of-file (wanted `EOF')
   ./x.sh: line 9: syntax error: unexpected end of file
   
9. Arcanemagus commented on Oct 11, 2018

   

   Arcanemagus

   on Oct 11, 2018

   More actions

   Please file a new issue with that information then so this can get fixed, thanks!
10. ryran commented on Oct 11, 2018

    

    ryran

    on Oct 11, 2018

    More actions

    report moved to new #127

    👍React with 👍1Reacted by Landon Abney