highlightjs · Hirse · Oct 22, 2022 · Oct 27, 2022 · Oct 28, 2022 · Oct 30, 2022
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,7 +2,6 @@
 
 New Grammars:
 
-- Added 3rd party LookML grammar to SUPPORTED_LANGUAGES [Josh Temple][]
 - added 3rd party LookML grammar to SUPPORTED_LANGUAGES [Josh Temple][]
 - added 3rd party FunC grammar to SUPPORTED_LANGUAGES [Nikita Sobolev][]
 
@@ -14,12 +13,16 @@ Grammars:
 - fix(js) do not flag `import()` as a function, rather a keyword [nathnolt][]
 - fix(bash) recognize the `((` keyword [Nick Chambers][]
 - fix(nix) support escaped dollar signs in strings [h7x4][]
+- fix(gherkin) update keyword list [Hirse][]
+- fix(gherkin) variables can't contain whitespace [Hirse][]
+- ehn(gherkin) docstrings can use backticks [Hirse][]
 
 [Josh Goebel]: https://github.com/joshgoebel
 [Josh Temple]: https://github.com/joshtemple
 [nathnolt]: https://github.com/nathnolt
 [Nick Chambers]: https://github.com/uplime
 [h7x4]: https://github.com/h7x4
+[Hirse]: https://github.com/Hirse
 
 
 ## Version 11.6.0

diff --git a/src/languages/gherkin.js b/src/languages/gherkin.js
@@ -9,10 +9,24 @@ export default function(hljs) {
   return {
     name: 'Gherkin',
     aliases: [ 'feature' ],
-    keywords: 'Feature Background Ability Business\ Need Scenario Scenarios Scenario\ Outline Scenario\ Template Examples Given And Then But When',
+    keywords: {
+      // Custom pattern to support keywords with spaces and those ending with a colon
+      $pattern: /[A-Z][a-z]+(?: [A-Z][a-z]+)?:?/,
+      // Add positive lookbehind to ensure keywords are at the beginning of a line
+      // $pattern: /(?<=^[ \t]*)[A-Z][a-z]+(?: [A-Z][a-z]+)?:?/,
+      keyword: [
+        'Feature:',
+        'Rule:',
+        'Example:', 'Scenario:',
+        'Given', 'When', 'Then', 'And', 'But',
+        'Background:',
+        'Scenario Outline:', 'Scenario Template:',
+        'Examples:', 'Scenarios:'
+      ]
+    },
     contains: [
       {
-        className: 'symbol',
+        className: 'keyword',
         begin: '\\*',
         relevance: 0
       },
@@ -32,16 +46,25 @@ export default function(hljs) {
       },
       {
         className: 'variable',
-        begin: '<',
-        end: '>'
+        begin: /<[^>\s]+>/
       },
-      hljs.HASH_COMMENT_MODE,
+      // Comments can only start at the beginning of a line
+      hljs.COMMENT(/^[ \t]*#/, /$/),
+      // Use positive lookbehind (once available) to exclude leading spaces from comment
+      // hljs.COMMENT(/(?<=^[ \t]*)#/, /$/),
       {
         className: 'string',
-        begin: '"""',
-        end: '"""'
-      },
-      hljs.QUOTE_STRING_MODE
+        variants: [
+          {
+            begin: /"""/,
+            end: /"""/
+          },
+          {
+            begin: /```/,
+            end: /```/
+          }
+        ]
+      }
     ]
   };
 }
diff --git a/test/markup/gherkin/default.expect.txt b/test/markup/gherkin/default.expect.txt
@@ -1,12 +1,12 @@
 <span class="hljs-comment"># language: en</span>
-<span class="hljs-keyword">Feature</span>: Addition
+<span class="hljs-keyword">Feature:</span> Addition
   In order to avoid silly mistakes
   As a math idiot
   I want to be told the sum of two numbers
 
   <span class="hljs-meta">@this_is_a_tag</span>
-  <span class="hljs-keyword">Scenario</span> <span class="hljs-keyword">Outline</span>: Add two numbers
-    <span class="hljs-symbol">*</span> I have a calculator
+  <span class="hljs-keyword">Scenario Outline:</span> Add two numbers
+    <span class="hljs-keyword">*</span> I have a calculator
     <span class="hljs-keyword">Given</span> I have entered <span class="hljs-variable">&lt;input_1&gt;</span> into the calculator
     <span class="hljs-keyword">And</span> I have entered <span class="hljs-variable">&lt;input_2&gt;</span> into the calculator
     <span class="hljs-keyword">When</span> I press <span class="hljs-variable">&lt;button&gt;</span>
@@ -18,7 +18,7 @@
     multiline text
     &quot;&quot;&quot;</span>
 
-  <span class="hljs-keyword">Examples</span>:
+  <span class="hljs-keyword">Examples:</span>
     |<span class="hljs-string"> input_1 </span>|<span class="hljs-string"> input_2 </span>|<span class="hljs-string"> button </span>|<span class="hljs-string"> output </span>|
     |<span class="hljs-string"> 20      </span>|<span class="hljs-string"> 30      </span>|<span class="hljs-string"> add    </span>|<span class="hljs-string"> 50     </span>|
     |<span class="hljs-string"> 2       </span>|<span class="hljs-string"> 5       </span>|<span class="hljs-string"> add    </span>|<span class="hljs-string"> 7      </span>|

diff --git a/test/markup/gherkin/docstrings.expect.txt b/test/markup/gherkin/docstrings.expect.txt
@@ -0,0 +1,21 @@
+<span class="hljs-keyword">Given</span> a blog post named &quot;Random&quot; with Markdown body
+  <span class="hljs-string">&quot;&quot;&quot;
+  Some Title, Eh?
+  ===============
+  Here is the first paragraph of my blog post. Lorem ipsum dolor sit amet,
+  consectetur adipiscing elit.
+  &quot;&quot;&quot;</span>
+
+<span class="hljs-keyword">Given</span> a blog post named &quot;Random&quot; with Markdown body
+  <span class="hljs-string">```
+  Some Title, Eh?
+  ===============
+  Here is the first paragraph of my blog post. Lorem ipsum dolor sit amet,
+  consectetur adipiscing elit.
+  ```</span>
+
+<span class="hljs-keyword">Given</span> the following users exist:
+  |<span class="hljs-string"> name   </span>|<span class="hljs-string"> email              </span>|<span class="hljs-string"> twitter         </span>|
+  |<span class="hljs-string"> Aslak  </span>|<span class="hljs-string"> aslak@cucumber.io  </span>|<span class="hljs-string"> @aslak_hellesoy </span>|
+  |<span class="hljs-string"> Julien </span>|<span class="hljs-string"> julien@cucumber.io </span>|<span class="hljs-string"> @jbpros         </span>|
+  |<span class="hljs-string"> Matt   </span>|<span class="hljs-string"> matt@cucumber.io   </span>|<span class="hljs-string"> @mattwynne      </span>|
diff --git a/test/markup/gherkin/docstrings.txt b/test/markup/gherkin/docstrings.txt
@@ -0,0 +1,21 @@
+Given a blog post named "Random" with Markdown body
+  """
+  Some Title, Eh?
+  ===============
+  Here is the first paragraph of my blog post. Lorem ipsum dolor sit amet,
+  consectetur adipiscing elit.
+  """
+
+Given a blog post named "Random" with Markdown body
+  ```
+  Some Title, Eh?
+  ===============
+  Here is the first paragraph of my blog post. Lorem ipsum dolor sit amet,
+  consectetur adipiscing elit.
+  ```
+
+Given the following users exist:
+  | name   | email              | twitter         |
+  | Aslak  | aslak@cucumber.io  | @aslak_hellesoy |
+  | Julien | julien@cucumber.io | @jbpros         |
+  | Matt   | matt@cucumber.io   | @mattwynne      |
diff --git a/test/markup/gherkin/keywords.expect.txt b/test/markup/gherkin/keywords.expect.txt
@@ -0,0 +1,34 @@
+<span class="hljs-keyword">Feature:</span> some feature
+
+  <span class="hljs-keyword">Rule:</span> some rule
+
+    <span class="hljs-keyword">Background:</span>
+      <span class="hljs-keyword">Given</span> some background
+
+    <span class="hljs-keyword">Example:</span> an example
+      <span class="hljs-keyword">Given</span> the conditions
+      <span class="hljs-keyword">And</span> some other conditions
+      <span class="hljs-keyword">*</span> same as and
+      <span class="hljs-keyword">But</span> not these conditions
+      <span class="hljs-keyword">When</span> something happens
+      <span class="hljs-keyword">And</span> something else
+      <span class="hljs-keyword">Then</span> I do this
+
+    <span class="hljs-keyword">Scenario:</span> same as example
+      <span class="hljs-keyword">Given</span> the conditions
+      <span class="hljs-keyword">And</span> some other conditions
+      <span class="hljs-keyword">*</span> same as and
+      <span class="hljs-keyword">But</span> not these conditions
+      <span class="hljs-keyword">When</span> something happens
+      <span class="hljs-keyword">And</span> something else
+      <span class="hljs-keyword">Then</span> I do this
+
+  <span class="hljs-keyword">Scenario Outline:</span> some outline
+    <span class="hljs-keyword">Examples:</span> part of outline
+      <span class="hljs-keyword">When</span> a
+      <span class="hljs-keyword">Then</span> b
+
+  <span class="hljs-keyword">Scenario Template:</span> same as scenario outline
+    <span class="hljs-keyword">Scenarios:</span> same as examples
+      <span class="hljs-keyword">When</span> a
+      <span class="hljs-keyword">Then</span> b
diff --git a/test/markup/gherkin/keywords.txt b/test/markup/gherkin/keywords.txt
@@ -0,0 +1,34 @@
+Feature: some feature
+
+  Rule: some rule
+
+    Background:
+      Given some background
+
+    Example: an example
+      Given the conditions
+      And some other conditions
+      * same as and
+      But not these conditions
+      When something happens
+      And something else
+      Then I do this
+
+    Scenario: same as example
+      Given the conditions
+      And some other conditions
+      * same as and
+      But not these conditions
+      When something happens
+      And something else
+      Then I do this
+
+  Scenario Outline: some outline
+    Examples: part of outline
+      When a
+      Then b
+
+  Scenario Template: same as scenario outline
+    Scenarios: same as examples
+      When a
+      Then b
diff --git a/test/markup/gherkin/variables.expect.txt b/test/markup/gherkin/variables.expect.txt
@@ -0,0 +1,5 @@
+<span class="hljs-keyword">Scenario Outline:</span> Add two numbers
+  <span class="hljs-keyword">Given</span> I have entered <span class="hljs-variable">&lt;input_1&gt;</span> into the calculator
+  <span class="hljs-keyword">And</span> I have entered <span class="hljs-variable">&lt;input_2&gt;</span> into the calculator
+  <span class="hljs-keyword">And</span> first &lt; second and second &gt; first
+  <span class="hljs-keyword">Then</span> second &lt;- first
diff --git a/test/markup/gherkin/variables.txt b/test/markup/gherkin/variables.txt
@@ -0,0 +1,5 @@
+Scenario Outline: Add two numbers
+  Given I have entered <input_1> into the calculator
+  And I have entered <input_2> into the calculator
+  And first < second and second > first
+  Then second <- first