Skip to content

fix(bash): arguments highlight #4293

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Core Grammars:
- enh(json) add json5 support [Kerry Shetline][]
- fix(css) `unicode-range` parsing, issue #4253 [Kerry Shetline][]
- fix(csharp) Support digit separators [te-ing][]
- fix(bash) arguments highlight for Bash/Shell, issue #4288 [tuyen-at-work][]

Documentation:

Expand Down Expand Up @@ -55,6 +56,7 @@ CONTRIBUTORS
[te-ing]: https://github.com/te-ing
[Anthony Martin]: https://github.com/anthony-c-martin
[NriotHrreion]: https://github.com/NriotHrreion
[tuyen-at-work]: https://github.com/tuyen-at-work


## Version 11.11.1
Expand Down
11 changes: 11 additions & 0 deletions src/languages/bash.js
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,16 @@ export default function(hljs) {
relevance: 0
};

const BASH_ARGUMENTS = {
variants: [
{
className: "attr",
begin: /[\t\u0020](-){1,2}[\w\d-]+/,
relevance: 0,
},
],
};

const KEYWORDS = [
"if",
"then",
Expand Down Expand Up @@ -392,6 +402,7 @@ export default function(hljs) {
contains: [
KNOWN_SHEBANG, // to catch known shells and boost relevancy
hljs.SHEBANG(), // to catch unknown shells but still highlight the shebang
BASH_ARGUMENTS,
FUNCTION,
ARITHMETIC,
COMMENT,
Expand Down
2 changes: 1 addition & 1 deletion test/markup/bash/escaped-quote.expect.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<span class="hljs-comment"># Escaped double-quote is not a string</span>
<span class="hljs-built_in">echo</span> <span class="hljs-string">&#x27;&quot;quoted&quot;&#x27;</span> | <span class="hljs-built_in">tr</span> -d \&quot; &gt; text.txt
<span class="hljs-built_in">echo</span> <span class="hljs-string">&#x27;&quot;quoted&quot;&#x27;</span> | <span class="hljs-built_in">tr</span><span class="hljs-attr"> -d</span> \&quot; &gt; text.txt
2 changes: 1 addition & 1 deletion test/markup/bash/no-numbers.expect.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<span class="hljs-comment"># numbers aren&#x27;t highlighted in bash as their semantics is</span>
<span class="hljs-comment"># not strictly defined for command line parameters</span>
$ <span class="hljs-built_in">tail</span> -10 access.log
$ <span class="hljs-built_in">tail</span><span class="hljs-attr"> -10</span> access.log
4 changes: 2 additions & 2 deletions test/markup/bash/strings.expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ SCRIPT_DIR=<span class="hljs-string">&quot;<span class="hljs-subst">$( cd <span
TLS_DIR=<span class="hljs-string">&quot;<span class="hljs-variable">$SCRIPT_DIR</span>/../src/main/resources/tls&quot;</span>
ROOT_DIR=<span class="hljs-string">&quot;<span class="hljs-variable">$SCRIPT_DIR</span>/..&quot;</span>

jshell -s - &lt;&lt; <span class="hljs-string">EOF
jshell<span class="hljs-attr"> -s</span> - &lt;&lt; <span class="hljs-string">EOF
System.out.printf(&quot;Procs: %s%n&quot;, getdata())
EOF</span>

jshell -s - &lt;&lt;&lt;<span class="hljs-string">&#x27;System.out.printf(&quot;Procs: %s%n&quot;, getdata())&#x27;</span>
jshell<span class="hljs-attr"> -s</span> - &lt;&lt;&lt;<span class="hljs-string">&#x27;System.out.printf(&quot;Procs: %s%n&quot;, getdata())&#x27;</span>

<span class="hljs-built_in">cat</span> &lt;&lt;&lt; <span class="hljs-string">&#x27;$VARIABLE&#x27;</span>
<span class="hljs-built_in">cat</span> &lt;&lt;&lt; <span class="hljs-string">&quot;<span class="hljs-variable">$VARIABLE</span>&quot;</span>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
git remote set-url<span class="hljs-attr"> --push</span> origin https://github.com/highlightjs/highlight.js.git
1 change: 1 addition & 0 deletions test/markup/bash/subcommand-starts-with-built-in.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
git remote set-url --push origin https://github.com/highlightjs/highlight.js.git
2 changes: 1 addition & 1 deletion test/markup/bash/token-containing-keyword.expect.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<span class="hljs-comment"># a keyword as part of an option</span>
mycmd --disable-foo
mycmd<span class="hljs-attr"> --disable-foo</span>

<span class="hljs-comment"># a keyword as part of a parameter</span>
some-cmd set-some-setting
Expand Down
2 changes: 1 addition & 1 deletion test/markup/dockerfile/default.expect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<span class="hljs-keyword">COPY</span><span class="language-bash"> www.conf /etc/php5/fpm/pool.d/</span>

<span class="hljs-keyword">RUN</span><span class="language-bash"> apt-get update \
&amp;&amp; apt-get install -y php5-fpm php-apc php5-curl php5-gd php5-intl php5-mysql</span>
&amp;&amp; apt-get install<span class="hljs-attr"> -y</span> php5-fpm php-apc php5-curl php5-gd php5-intl php5-mysql</span>
<span class="hljs-keyword">RUN</span><span class="language-bash"> <span class="hljs-built_in">mkdir</span> /tmp/sessions</span>

<span class="hljs-keyword">ENV</span> APPLICATION_ENV dev
Expand Down
16 changes: 8 additions & 8 deletions test/markup/shell/command-continuation.expect.txt
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<span class="hljs-meta prompt_">$ </span><span class="language-bash">docker run \
--publish=7474:7474 --publish=7687:7687 \
--volume=/neo4j/data:/data \
--volume=/neo4j/plugins:/plugins \
--volume=/neo4j/conf:/conf \
--volume=/logs/neo4j:/logs \
--user=<span class="hljs-string">&quot;<span class="hljs-subst">$(id -u neo4j)</span>:<span class="hljs-subst">$(id -g neo4j)</span>&quot;</span> \
--group-add=<span class="hljs-variable">$groups</span> \
<span class="hljs-attr"> --publish</span>=7474:7474<span class="hljs-attr"> --publish</span>=7687:7687 \
<span class="hljs-attr"> --volume</span>=/neo4j/data:/data \
<span class="hljs-attr"> --volume</span>=/neo4j/plugins:/plugins \
<span class="hljs-attr"> --volume</span>=/neo4j/conf:/conf \
<span class="hljs-attr"> --volume</span>=/logs/neo4j:/logs \
<span class="hljs-attr"> --user</span>=<span class="hljs-string">&quot;<span class="hljs-subst">$(id -u neo4j)</span>:<span class="hljs-subst">$(id -g neo4j)</span>&quot;</span> \
<span class="hljs-attr"> --group-add</span>=<span class="hljs-variable">$groups</span> \
neo4j:3.4</span>
<span class="hljs-meta prompt_">&gt; </span><span class="language-bash">/bin/cat \.travis.yml\
-b | <span class="hljs-built_in">head</span> -n1</span>
<span class="hljs-attr"> -b</span> | <span class="hljs-built_in">head</span><span class="hljs-attr"> -n1</span></span>
1 language: node_js
<span class="hljs-meta prompt_">&gt; </span><span class="language-bash"><span class="hljs-built_in">echo</span> <span class="hljs-string">&#x27;hello&#x27;</span></span>
hello
2 changes: 1 addition & 1 deletion test/markup/shell/single.expect.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<span class="hljs-meta prompt_">$ </span><span class="language-bash"><span class="hljs-built_in">echo</span> <span class="hljs-string">&quot;<span class="hljs-variable">$HOME</span>&quot;</span> -n</span>
<span class="hljs-meta prompt_">$ </span><span class="language-bash"><span class="hljs-built_in">echo</span> <span class="hljs-string">&quot;<span class="hljs-variable">$HOME</span>&quot;</span><span class="hljs-attr"> -n</span></span>