Skip to content

enh(elixir) improve heredoc and sigil support #2257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 12, 2019
Merged

enh(elixir) improve heredoc and sigil support #2257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
253f31e
Added markup test for uppercase string sigil with heredoc
Sannis Sep 8, 2015
15745c5
enh(elixir) improve heredoc and sigil support
joshgoebel Nov 5, 2019
3387c84
add sigil tests
joshgoebel Nov 5, 2019
bad5844
remove returnBegin
joshgoebel Nov 5, 2019
eccc895
tighten rules
joshgoebel Nov 5, 2019
45cbe68
escaping not necessary?
joshgoebel Nov 5, 2019
9a0879a
Merge branch 'master' into some_elixir_fixes
joshgoebel Nov 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 65 additions & 1 deletion src/languages/elixir.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,78 @@ function(hljs) {
lexemes: ELIXIR_IDENT_RE,
keywords: ELIXIR_KEYWORDS
};

var SIGIL_DELIMITERS = '[/|([{<"\']'
var LOWERCASE_SIGIL = {
className: 'string',
begin: '~[a-z]' + '(?=' + SIGIL_DELIMITERS + ')',
contains: [
{
endsParent:true,
contains: [{
contains: [hljs.BACKSLASH_ESCAPE, SUBST],
variants: [
{ begin: /"/, end: /"/ },
{ begin: /'/, end: /'/ },
{ begin: /\//, end: /\// },
{ begin: /\|/, end: /\|/ },
{ begin: /\(/, end: /\)/ },
{ begin: /\[/, end: /\]/ },
{ begin: /\{/, end: /\}/ },
{ begin: /</, end: />/ }
]
}]
},
],
};

var UPCASE_SIGIL = {
className: 'string',
begin: '~[A-Z]' + '(?=' + SIGIL_DELIMITERS + ')',
contains: [
{ begin: /"/, end: /"/ },
{ begin: /'/, end: /'/ },
{ begin: /\//, end: /\// },
{ begin: /\|/, end: /\|/ },
{ begin: /\(/, end: /\)/ },
{ begin: /\[/, end: /\]/ },
{ begin: /\{/, end: /\}/ },
{ begin: /\</, end: /\>/ }
]
};

var STRING = {
className: 'string',
contains: [hljs.BACKSLASH_ESCAPE, SUBST],
variants: [
{
begin: /"""/, end: /"""/,
},
{
begin: /'''/, end: /'''/,
},
{
begin: /~S"""/, end: /"""/,
contains: []
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't get... What is the point in empty contains?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's needed to override the contains on line 64... variants "inherit", so it's needed to break that.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah.

},
{
begin: /~S"/, end: /"/,
contains: []
},
{
begin: /~S'''/, end: /'''/,
contains: []
},
{
begin: /~S'/, end: /'/,
contains: []
},
{
begin: /'/, end: /'/
},
{
begin: /"/, end: /"/
}
},
]
};
var FUNCTION = {
Expand All @@ -47,6 +109,8 @@ function(hljs) {
});
var ELIXIR_DEFAULT_CONTAINS = [
STRING,
UPCASE_SIGIL,
LOWERCASE_SIGIL,
hljs.HASH_COMMENT_MODE,
CLASS,
FUNCTION,
Expand Down
23 changes: 23 additions & 0 deletions test/markup/elixir/sigils.expect.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<span class="hljs-string">~R'this + i\s "a" regex too'</span>
<span class="hljs-string">~w(hello <span class="hljs-subst">#{ [<span class="hljs-string">"has"</span> &lt;&gt; <span class="hljs-string">"123"</span>, <span class="hljs-string">'\c\d'</span>, <span class="hljs-string">"\123 interpol"</span> | []] }</span> world)</span>s
<span class="hljs-string">~W(hello #{no "123" \c\d \123 interpol} world)</span>s
<span class="hljs-string">~s{Escapes terminators \{ and \}, but no {balancing}</span> <span class="hljs-comment"># outside of sigil here }</span>
<span class="hljs-string">~S"No escapes \s\t\n and no #{interpolation}"</span>

<span class="hljs-string">~S/hello/</span>
<span class="hljs-string">~S|hello|</span>
<span class="hljs-string">~S"hello"</span>
<span class="hljs-string">~S'hello'</span>
<span class="hljs-string">~S(hello)</span>
<span class="hljs-string">~S[hello]</span>
<span class="hljs-string">~S{hello}</span>
<span class="hljs-string">~S&lt;hello&gt;</span>

<span class="hljs-string">~s/hello <span class="hljs-subst">#{name}</span>/</span>
<span class="hljs-string">~s|hello <span class="hljs-subst">#{name}</span>|</span>
<span class="hljs-string">~s"hello <span class="hljs-subst">#{name}</span>"</span>
<span class="hljs-string">~s'hello <span class="hljs-subst">#{name}</span>'</span>
<span class="hljs-string">~s(hello <span class="hljs-subst">#{name}</span>)</span>
<span class="hljs-string">~s[hello <span class="hljs-subst">#{name}</span>]</span>
<span class="hljs-string">~s{hello <span class="hljs-subst">#{name}</span>}</span>
<span class="hljs-string">~s&lt;hello <span class="hljs-subst">#{name}</span>&gt;</span>
23 changes: 23 additions & 0 deletions test/markup/elixir/sigils.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
~R'this + i\s "a" regex too'
~w(hello #{ ["has" <> "123", '\c\d', "\123 interpol" | []] } world)s
~W(hello #{no "123" \c\d \123 interpol} world)s
~s{Escapes terminators \{ and \}, but no {balancing} # outside of sigil here }
~S"No escapes \s\t\n and no #{interpolation}"

~S/hello/
~S|hello|
~S"hello"
~S'hello'
~S(hello)
~S[hello]
~S{hello}
~S<hello>

~s/hello #{name}/
~s|hello #{name}|
~s"hello #{name}"
~s'hello #{name}'
~s(hello #{name})
~s[hello #{name}]
~s{hello #{name}}
~s<hello #{name}>
4 changes: 4 additions & 0 deletions test/markup/elixir/strings.expect.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
a = <span class="hljs-string">"""test"""</span>
b = <span class="hljs-string">'''test'''</span>
c = <span class="hljs-string">"test"</span>
d = <span class="hljs-string">'test'</span>
4 changes: 4 additions & 0 deletions test/markup/elixir/strings.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
a = """test"""
b = '''test'''
c = "test"
d = 'test'
17 changes: 17 additions & 0 deletions test/markup/elixir/uppercase-string-sigil.expect.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<span class="hljs-class"><span class="hljs-keyword">defmodule</span> <span class="hljs-title">Long.Module.Name</span></span> <span class="hljs-keyword">do</span>
<span class="hljs-variable">@doc</span> <span class="hljs-string">~S'''
No #{interpolation} of any kind.
\000 \x{ff}

\n #{\x{ff}}
'''</span>
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">func</span></span>(a, b \\ []), <span class="hljs-symbol">do:</span> <span class="hljs-symbol">:ok</span>

<span class="hljs-variable">@doc</span> <span class="hljs-string">~S"""
No #{interpolation} of any kind.
\000 \x{ff}

\n #{\x{ff}}
"""</span>
<span class="hljs-function"><span class="hljs-keyword">def</span> <span class="hljs-title">func</span></span>(a, b \\ []), <span class="hljs-symbol">do:</span> <span class="hljs-symbol">:ok</span>
<span class="hljs-keyword">end</span>
17 changes: 17 additions & 0 deletions test/markup/elixir/uppercase-string-sigil.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
defmodule Long.Module.Name do
@doc ~S'''
No #{interpolation} of any kind.
\000 \x{ff}

\n #{\x{ff}}
'''
def func(a, b \\ []), do: :ok

@doc ~S"""
No #{interpolation} of any kind.
\000 \x{ff}

\n #{\x{ff}}
"""
def func(a, b \\ []), do: :ok
end