gherkin_highlight_rules.js 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  1. /* ***** BEGIN LICENSE BLOCK *****
  2. * Distributed under the BSD license:
  3. *
  4. * Copyright (c) 2014, Ajax.org B.V.
  5. * All rights reserved.
  6. *
  7. * Redistribution and use in source and binary forms, with or without
  8. * modification, are permitted provided that the following conditions are met:
  9. * * Redistributions of source code must retain the above copyright
  10. * notice, this list of conditions and the following disclaimer.
  11. * * Redistributions in binary form must reproduce the above copyright
  12. * notice, this list of conditions and the following disclaimer in the
  13. * documentation and/or other materials provided with the distribution.
  14. * * Neither the name of Ajax.org B.V. nor the
  15. * names of its contributors may be used to endorse or promote products
  16. * derived from this software without specific prior written permission.
  17. *
  18. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  19. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21. * DISCLAIMED. IN NO EVENT SHALL AJAX.ORG B.V. BE LIABLE FOR ANY
  22. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28. *
  29. * ***** END LICENSE BLOCK ***** */
  30. define(function(require, exports, module) {
  31. var oop = require("../lib/oop");
  32. var TextHighlightRules = require("./text_highlight_rules").TextHighlightRules;
  33. var stringEscape = "\\\\(x[0-9A-Fa-f]{2}|[0-7]{3}|[\\\\abfnrtv'\"]|U[0-9A-Fa-f]{8}|u[0-9A-Fa-f]{4})";
  34. var GherkinHighlightRules = function() {
  35. var languages = [{
  36. name: "en",
  37. labels: "Feature|Background|Scenario(?: Outline)?|Examples",
  38. keywords: "Given|When|Then|And|But"
  39. }
  40. /* TODO find a way to enable this when first line in the file is # language: pl
  41. , {
  42. name: "pl",
  43. labels: "Właściwość|Funkcja|Aspekt|Potrzeba biznesowa|Założenia|Scenariusz|Szablon scenariusza|Przykłady",
  44. keywords: "Mając|Zakładając(?:, że)?|Jeżeli|Jeśli|Gdy|Kiedy|Wtedy|Oraz|I|Ale"
  45. }
  46. */];
  47. var labels = languages.map(function(l) {
  48. return l.labels;
  49. }).join("|");
  50. var keywords = languages.map(function(l) {
  51. return l.keywords;
  52. }).join("|");
  53. // need to include constant ints
  54. this.$rules = {
  55. start : [{
  56. token: 'constant.numeric',
  57. regex: "(?:(?:[1-9]\\d*)|(?:0))"
  58. }, {
  59. token : "comment",
  60. regex : "#.*$"
  61. }, {
  62. token : "keyword",
  63. regex : "(?:" + labels + "):|(?:" + keywords + ")\\b",
  64. }, {
  65. token : "keyword",
  66. regex : "\\*",
  67. }, {
  68. token : "string", // multi line """ string start
  69. regex : '"{3}',
  70. next : "qqstring3"
  71. }, {
  72. token : "string", // " string
  73. regex : '"',
  74. next : "qqstring"
  75. }, {
  76. token : "text",
  77. regex : "^\\s*(?=@[\\w])",
  78. next : [{
  79. token : "text",
  80. regex : "\\s+",
  81. }, {
  82. token : "variable.parameter",
  83. regex : "@[\\w]+"
  84. }, {
  85. token : "empty",
  86. regex : "",
  87. next : "start"
  88. }]
  89. }, {
  90. token : "comment",
  91. regex : "<[^>]+>"
  92. }, {
  93. token : "comment",
  94. regex : "\\|(?=.)",
  95. next : "table-item"
  96. }, {
  97. token : "comment",
  98. regex : "\\|$",
  99. next : "start"
  100. }],
  101. "qqstring3" : [ {
  102. token : "constant.language.escape",
  103. regex : stringEscape
  104. }, {
  105. token : "string", // multi line """ string end
  106. regex : '"{3}',
  107. next : "start"
  108. }, {
  109. defaultToken : "string"
  110. }],
  111. "qqstring" : [{
  112. token : "constant.language.escape",
  113. regex : stringEscape
  114. }, {
  115. token : "string",
  116. regex : "\\\\$",
  117. next : "qqstring"
  118. }, {
  119. token : "string",
  120. regex : '"|$',
  121. next : "start"
  122. }, {
  123. defaultToken: "string"
  124. }],
  125. "table-item" : [{
  126. token : "comment",
  127. regex : /$/,
  128. next : "start"
  129. }, {
  130. token : "comment",
  131. regex : /\|/
  132. }, {
  133. token : "string",
  134. regex : /\\./
  135. }, {
  136. defaultToken : "string"
  137. }]
  138. };
  139. this.normalizeRules();
  140. }
  141. oop.inherits(GherkinHighlightRules, TextHighlightRules);
  142. exports.GherkinHighlightRules = GherkinHighlightRules;
  143. });