SQL syntax highlight (w/ Typescript)

A simple and lightweight syntax highlighting library for SQL

This is a fork made with Typescript for use in a local project. I'll add tests and see if the original package owner wants to use them at a later date.

SQL Highlight is a small package that highlights SQL queries. It can output to both the terminal with Unicode escape sequences, as well as to normal HTML. Oh, and there are no external dependencies 😉

Install via Yarn:

yarn add sql-highlight

Install via NPM:

npm install sql-highlight

Note that we're using ES6 import statements here. Usage with require works just as well.

In its most basic form:

import { highlight } from "sql-highlight";

const sqlString =
  "SELECT `id`, `username` FROM `users` WHERE `email` = '[email protected]'";

const highlighted = highlight(sqlString);

console.log(highlighted);

Output:

HTML mode:

import { highlight } from "sql-highlight";

const sqlString =
  "SELECT `id`, `username` FROM `users` WHERE `email` = '[email protected]'";

const highlighted = highlight(sqlString, {
  html: true,
});

document.body.innerHTML += highlighted;

Output:

<span class="sql-hl-keyword">SELECT</span>
<span class="sql-hl-string">`id`</span>
<span class="sql-hl-special">,</span>
<span class="sql-hl-string">`username`</span>
<span class="sql-hl-keyword">FROM</span>
<span class="sql-hl-string">`users`</span>
<span class="sql-hl-keyword">WHERE</span>
<span class="sql-hl-string">`email`</span>
<span class="sql-hl-special">=</span>
<span class="sql-hl-string">'[email protected]'</span>

The following options may be passed to the highlight function.

* colors option default value

{
  keyword: '\x1b[35m',  // SQL reserved keywords
  function: '\x1b[31m', // Functions
  number: '\x1b[32m',   // Numbers
  string: '\x1b[32m',   // Strings
  special: '\x1b[33m',  // Special characters
  bracket: '\x1b[33m'   // Brackets (parentheses)
}

1. Fork it (https://github.com/scriptcoded/sql-highlight/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

Malcolm Nihlén - [email protected]

Distributed under the MIT licence. See LICENCE for more information.

https://github.com/scriptcoded

This was initially a fork from https://github.com/pomahtuk/sequilize-highlight. The repo wasn't being updated, NPM wasn't serving the latest version and there was a severe memory leak. Though the latest version now exists on NPM, issues still persist. This repo serves to address those problems, as well as providing a cleaner interface that's not bound to Sequelize.

With version 3.0.0 the library was almost completely rewritten, which leaves very little similarity with the original repo.