strings in the output of highlight function with html: true maybe malformed

[SidneyTTW]

Describe the bug
strings in the output of highlight function with html: true maybe malformed when the sql query contains special characters in hardcoded string
It seems that the special characters should be escaped in the output

To Reproduce
Steps to reproduce the behavior:

• Use code below

const { highlight } = require('sql-highlight')
let sqlString = "select * from a where b = 'array<map<string,string>>';"
let highlighted = highlight(sqlString, { html: true })
console.log(highlighted)

• And execute it with nodejs

Actual behavior

• It prints
  <span class="sql-hl-keyword">select</span> <span class="sql-hl-special">*</span> <span class="sql-hl-keyword">from</span> a <span class="sql-hl-keyword">where</span> b <span class="sql-hl-special">=</span> <span class="sql-hl-string">'array<map<string,string>>'</span><span class="sql-hl-special">;</span>
• And if I try to put the 'array<map<string,string>>' into html
  The browser will treat it as
  
  And user will see
  

Expected behavior

• It prints
  <span class="sql-hl-keyword">select</span> <span class="sql-hl-special">*</span> <span class="sql-hl-keyword">from</span> a <span class="sql-hl-keyword">where</span> b <span class="sql-hl-special">=</span> <span class="sql-hl-string">'array&ltmap&ltstring,string&gt&gt'</span><span class="sql-hl-special">;</span>
• And if I put the 'array&ltmap&ltstring,string&gt&gt' into html
  The browser will treat it as
  
  And user will see
  

Node.js (please complete the following information):

• Version v16.17.1

Browser (please complete the following information):

• OS: MacOS
• Browser Chrome
• Version 108.0.5359.124

[scriptcoded]

Thank you for reporting this! I agree that escaping should be considered expected behavior.

I've added basic HTML entity escaping in v4.3.0 which is now live on NPM. It uses a basic escaper based on escape-html. This can be configured using options.

I opted to escape quotes on top of brackets and ampersands as you suggested in your issue.

Please verify that this fix resolves your issue.

Have a nice weekend!
Malcolm

[SidneyTTW]

Looks great. Thanks for the quick response!

[scriptcoded]

P.S. to anyone interested, explanation for why this is a minor release and not a patch can be found in 672fc9c