feat: add comments support

Fix #133

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [4.3.3](https://github.com/scriptcoded/sql-highlight/compare/v4.1.1...v4.2.0) (2022-08-08)
+
+
+### Features
+
+* add comments support ([#133](https://github.com/scriptcoded/sql-highlight/issues/133)) ([#139](https://github.com/scriptcoded/sql-highlight/issues/139))
+
 ## [4.3.2](https://github.com/scriptcoded/sql-highlight/compare/v4.3.1...v4.3.2) (2023-03-16)
 
 ### Bug Fixes

README.md

@@ -89,6 +89,7 @@ The following options may be passed to the `highlight` function.
   string: '\x1b[32m',   // Strings
   special: '\x1b[33m',  // Special characters
   bracket: '\x1b[33m',  // Brackets (parentheses)
+  bracket: '\x1b[90m',  // Comments
   clear: '\x1b[0m'      // Clear (inserted after each match)
 }
 ```

lib/index.js

@@ -14,6 +14,7 @@ const DEFAULT_OPTIONS = {
     string: '\x1b[32m',
     special: '\x1b[33m',
     bracket: '\x1b[33m',
+    comment: '\x1b[90m',
     clear: '\x1b[0m'
   }
 }
@@ -28,6 +29,10 @@ const highlighters = [
     group: 1,
     regex: new RegExp(`(^|${SPLIT_CHARS})(${keywords.join('|')})(?=${SPLIT_CHARS}|$)`, 'gi')
   },
+  {
+    name: 'comment',
+    regex: /(\/\*(?:\*|.)*?\*\/|--.*?(?:\n|$)|#.*?(?:\n|$))/gms
+  },
   {
     name: 'special',
     regex: /(=|!=|%|\/|\*|-|,|;|:|\+|<|>)/g

test/debug.js

@@ -27,3 +27,5 @@ console.log(highlight('DROP PROCEDURE IF EXISTS `some-database`.`some-table`;'))
 console.log(highlight('SELECT * FROM a;SELECT * FROM b;'))
 
 console.log(highlight("select * from a where b = 'array<map<string,string>>';", { html: true }))
+
+console.log(highlight('SELECT */* table.* */ FROM a;\nSELECT * FROM b; # comment\nSELECT * FROM c; -- comment\nSELECT * FROM d; /* multi\nline\ncomment */'))

test/index.test.js

@@ -8,6 +8,7 @@ const OPTIONS = {
     string: '[string]',
     special: '[special]',
     bracket: '[bracket]',
+    comment: '[comment]',
     clear: '[clear]'
   }
 }
@@ -85,6 +86,21 @@ describe('unicode', () => {
       .toBe('[bracket]([clear]f1[bracket])[clear]')
   })
 
+  it('comment /**/', () => {
+    expect(hlUni('/*/*comment\nsecondline*/*/'))
+      .toBe('[comment]/*/*comment\nsecondline*/[clear][special]*[clear][special]/[clear]')
+  })
+
+  it('comment #', () => {
+    expect(hlUni('#comment\n#comment'))
+      .toBe('[comment]#comment\n[clear][comment]#comment[clear]')
+  })
+
+  it('comment --', () => {
+    expect(hlUni('--comment\n--comment'))
+      .toBe('[comment]--comment\n[clear][comment]--comment[clear]')
+  })
+
   it('functions', () => {
     expect(hlUni('COUNT(`id`)'))
       .toBe('[function]COUNT[clear][bracket]([clear][string]`id`[clear][bracket])[clear]')
@@ -177,6 +193,21 @@ describe('html', () => {
       .toBe('<span class="sql-hl-bracket">(</span>f1<span class="sql-hl-bracket">)</span>')
   })
 
+  it('comment /**/', () => {
+    expect(hlHtml('/*/*comment\nsecondline*/*/'))
+      .toBe('<span class="sql-hl-comment">/*/*comment\nsecondline*/</span><span class="sql-hl-special">*</span><span class="sql-hl-special">/</span>')
+  })
+
+  it('comment #', () => {
+    expect(hlHtml('#comment\n#comment'))
+      .toBe('<span class="sql-hl-comment">#comment\n</span><span class="sql-hl-comment">#comment</span>')
+  })
+
+  it('comment --', () => {
+    expect(hlHtml('--comment\n--comment'))
+      .toBe('<span class="sql-hl-comment">--comment\n</span><span class="sql-hl-comment">--comment</span>')
+  })
+
   it('functions', () => {
     expect(hlHtml('COUNT(`id`)'))
       .toBe('<span class="sql-hl-function">COUNT</span><span class="sql-hl-bracket">(</span><span class="sql-hl-string">`id`</span><span class="sql-hl-bracket">)</span>')