npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sql-highlight-semantic-release

v6.1.1

Published

Ignore! Just testing semantic-release!

Downloads

14

Readme

sql-highlight

A simple and lightweight library for highlighting SQL queries written in pure JavaScript

Tests Status Coverage Status NPM Version Bundle Size

What's it all about?

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 😉

Installation

sql-highlight is tested to work with Node.js 14, 16 and 18.

Install with Yarn:

yarn add sql-highlight

Install with NPM:

npm install sql-highlight

Usage

In its most basic form:

const { highlight } = require('sql-highlight')

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

const highlighted = highlight(sqlString)

console.log(highlighted)

Output:

Screenshot

HTML mode:

const { highlight } = require('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>

Options

The following options may be passed to the highlight function.

| Option | Value | Default | Description | | --- | --- | --- | --- | | html | boolean | false | Set to true to render HTML instead of Unicode. | htmlEscaper | (str: string) => string | Basic escaper | Function to escape HTML entities. Uses a basic escaper by default. If HTML mode is used in a browser environment this could be useful to escape strings using the DOM. | classPrefix | string | 'sql-hl-' | Prefix to prepend to classes for HTML span-tags. Is appended with entity name. | colors | Object | See below* | What color codes to use for Unicode rendering. A list of basic color codes can be found here.

* 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)
  comment: '\x1b[2m\x1b[90m', // Comments
  clear: '\x1b[0m'      // Clear (inserted after each match)
}

Custom highlighting

In case you want to do the highlighting yourself you can use getSegments to only let sql-highlight parse the SQL string for you. You can then use the segments to highlight it yourself.

const { getSegments } = require('sql-highlight')

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

const segments = getSegments(sqlString)

console.log(segments)

Output:

[
    { name: 'keyword', content: 'SELECT' },
    { name: 'default', content: ' ' },
    { name: 'string', content: '`id`' },
    { name: 'special', content: ',' },
    { name: 'default', content: ' ' },
    { name: 'string', content: '`username`' },
    { name: 'default', content: ' ' },
    { name: 'keyword', content: 'FROM' },
    { name: 'default', content: ' ' },
    { name: 'string', content: '`users`' },
    { name: 'default', content: ' ' },
    { name: 'keyword', content: 'WHERE' },
    { name: 'default', content: ' ' },
    { name: 'string', content: '`email`' },
    { name: 'default', content: ' ' },
    { name: 'special', content: '=' },
    { name: 'default', content: ' ' },
    { name: 'string', content: "'[email protected]'" }
]

Contributing

See the contribution guidelines.

Tests

We use Jest for running our tests. The test suite can be run by running npm run test. This will run both Jest and ESLint.

Code style

We use ESLint for making sure that our code remains pretty and consistent throughout the project. If your editor doesn't automatically pick up our config you can lint the code using npm run lint.

A note on Dependabot

Dependabot Auto Merge is installed in this repository to automatically merge dependabot PRs for minor version updates. Only PRs that pass the tests get merged. No new releases will be created for dependency updates as there are no production dependencies and a release would therefore be completely unnecessary.

Additional information

Malcolm Nihlén - [email protected]

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

https://github.com/scriptcoded

Disclaimer

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.