Package Health Score

70 / 100

security
No known security issues
popularity
Influential project
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
3.1.0	\|	10/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.0	\|	09/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.9.0	\|	05/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.20.0	\|	03/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.19.0	\|	02/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Influential project

Weekly Downloads (2,520,507)

GitHub Stars: 753
Forks: 26
Contributors: 20

Direct Usage Popularity

The npm package lowlight receives a total of 2,520,507 downloads a week. As such, we scored lowlight popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package lowlight, we found that it has been starred 753 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: Yes

With more than 10 contributors for the lowlight repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like lowlight is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 3
Open PR: 0
Last Release: 1 year ago
Last Commit: 2 months ago

Further analysis of the maintenance status of lowlight based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for lowlight is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 9 years
Dependencies: 3 Direct
Versions: 43
Install Size: 59.5 kB
Dist-tags: 1
# of Files: 11
Maintainers: 1
TS Typings: Yes

lowlight has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use lowlight?

To help you get started, we've collected the most common ways that lowlight is being used within popular public projects.

patternplate / patternplate / packages / client / src / app / components / common / code / highlight.js View on Github

import scss from "highlight.js/lib/languages/scss.js";
import stylus from "highlight.js/lib/languages/stylus.js";

import js from "highlight.js/lib/languages/javascript.js";
import ts from "highlight.js/lib/languages/typescript.js";
import json from "highlight.js/lib/languages/json.js";

import xml from "highlight.js/lib/languages/xml.js";
import md from "highlight.js/lib/languages/markdown.js";

import bash from "highlight.js/lib/languages/bash.js";

// CSS and friends
low.registerLanguage("css", css);
low.registerLanguage("less", less);
low.registerLanguage("scss", scss);
low.registerLanguage("stylus", stylus);

// JS and friends
low.registerLanguage("js", js);
low.registerLanguage("javascript", js);
low.registerLanguage("jsx", js);
low.registerLanguage("ts", ts);
low.registerLanguage("tsx", ts);
low.registerLanguage("typescript", ts);
low.registerLanguage("json", json);

// HTML and friends
low.registerLanguage("html", xml);
low.registerLanguage("xml", xml);
low.registerLanguage("md", md);
low.registerLanguage("markdown", md);

View more ways to use lowlight

lowlight

Virtual syntax highlighting for virtual DOMs and non-HTML things based on highlight.js.

What is this?

This package uses highlight.js for syntax highlighting and outputs objects (ASTs) instead of a string of HTML. It can support 190+ programming languages.

When should I use this?

This package is useful when you want to perform syntax highlighting in a place where serialized HTML wouldn’t work or wouldn’t work well. For example, you can use lowlight when you want to show code in a CLI by rendering to ANSI sequences, when you’re using virtual DOM frameworks (such as React or Preact) so that diffing can be performant, or when you’re working with ASTs (rehype).

You can use the similar refractor if you want to use Prism grammars instead. If you’re looking for a really good (but rather heavy) alternative, use starry-night.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install lowlight

In Deno with esm.sh:

import {all, common, createLowlight} from 'https://esm.sh/lowlight@3'

In browsers with esm.sh:

Use

import {common, createLowlight} from 'lowlight'

const lowlight = createLowlight(common)

const tree = lowlight.highlight('js', '"use strict";')

console.dir(tree, {depth: undefined})

Yields:

{
  type: 'root',
  children: [
    {
      type: 'element',
      tagName: 'span',
      properties: {className: ['hljs-meta']},
      children: [{type: 'text', value: '"use strict"'}]
    },
    {type: 'text', value: ';'}
  ],
  data: {language: 'js', relevance: 10}
}

API

This package exports the identifiers all, common, and createLowlight. There is no default export.

`all`

Map of all (±190) grammars (Record).

`common`

Map of common (37) grammars (Record).

`createLowlight([grammars])`

Create a lowlight instance.

Parameters

grammars (Record, optional) — grammars to add

Returns

Lowlight (Lowlight).

`lowlight.highlight(language, value[, options])`

Highlight value (code) as language (name).

Parameters

language (string) — programming language name
value (string) — code to highlight
options (Options, optional) — configuration

Returns

Tree (Root); with the following data fields: language (string), detected programming language name; relevance (number), how sure lowlight is that the given code is in the language.

Example

import {common, createLowlight} from 'lowlight'

const lowlight = createLowlight(common)

console.log(lowlight.highlight('css', 'em { color: red }'))

Yields:

{type: 'root', children: [Array], data: {language: 'css', relevance: 3}}

`lowlight.highlightAuto(value[, options])`

Highlight value (code) and guess its programming language.

Parameters

value (string) — code to highlight
options (AutoOptions, optional) — configuration

Returns

Tree (Root); with the following data fields: language (string), detected programming language name; relevance (number), how sure lowlight is that the given code is in the language.

Example

import {common, createLowlight} from 'lowlight'

const lowlight = createLowlight(common)

console.log(lowlight.highlightAuto('"hello, " + name + "!"'))

Yields:

{type: 'root', children: [Array], data: {language: 'arduino', relevance: 2}}

`lowlight.listLanguages()`

List registered languages.

Returns

Names of registered language (Array).

Example

import {createLowlight} from 'lowlight'
import markdown from 'highlight.js/lib/languages/markdown'

const lowlight = createLowlight()

console.log(lowlight.listLanguages()) // =&gt; []

lowlight.register({markdown})

console.log(lowlight.listLanguages()) // =&gt; ['markdown']

`lowlight.register(grammars)`

Signatures

register(name, grammar)
register(grammars)

Parameters

name (string) — programming language name
grammar (LanguageFn) — grammar
grammars (Record, optional) — grammars

Returns

Nothing (undefined).

Example

import {createLowlight} from 'lowlight'
import xml from 'highlight.js/lib/languages/xml'

const lowlight = createLowlight()

lowlight.register({xml})

// Note: `html` is an alias for `xml`.
console.log(lowlight.highlight('html', '<em>Emphasis</em>'))

Yields:

{type: 'root', children: [Array], data: {language: 'html', relevance: 2}}

`lowlight.registerAlias(aliases)`

Signatures

registerAlias(aliases)
registerAlias(name, alias)

Parameters

aliases (Record | string>) — map of programming language names to one or more aliases
name (string) — programming language name
alias (Array | string) — one or more aliases for the programming language

Returns

Nothing (undefined).

Example

import {createLowlight} from 'lowlight'
import markdown from 'highlight.js/lib/languages/markdown'

const lowlight = createLowlight()

lowlight.register({markdown})

// lowlight.highlight('mdown', '<em>Emphasis</em>')
// ^ would throw: Error: Unknown language: `mdown` is not registered

lowlight.registerAlias({markdown: ['mdown', 'mkdn', 'mdwn', 'ron']})
lowlight.highlight('mdown', '<em>Emphasis</em>')
// ^ Works!

`lowlight.registered(aliasOrlanguage)`

Check whether an alias or name is registered.

Parameters

aliasOrlanguage (string) — name of a language or alias for one

Returns

Whether aliasOrName is registered (boolean).

Example

import {createLowlight} from 'lowlight'
import javascript from 'highlight.js/lib/languages/javascript'

const lowlight = createLowlight({javascript})

console.log(lowlight.registered('funkyscript')) // =&gt; `false`

lowlight.registerAlias({javascript: 'funkyscript'})
console.log(lowlight.registered('funkyscript')) // =&gt; `true`

`AutoOptions`

Configuration for highlightAuto (TypeScript type).

Fields

prefix (string, default: 'hljs-') — class prefix
subset (Array, default: all registered languages) — list of allowed languages

`LanguageFn`

Highlight.js grammar (TypeScript type).

Type

type {LanguageFn} from 'highlight.js'

`Options`

Configuration for highlight (TypeScript type).

Fields

prefix (string, default: 'hljs-') — class prefix

Examples

Example: serializing hast as html

hast trees as returned by lowlight can be serialized with hast-util-to-html:

import {common, createLowlight} from 'lowlight'
import {toHtml} from 'hast-util-to-html'

const lowlight = createLowlight(common)

const tree = lowlight.highlight('js', '"use strict";')

console.log(toHtml(tree))

Yields:

<span class="hljs-meta">"use strict"</span>;

Example: turning hast into preact, react, etc

hast trees as returned by lowlight can be turned into nodes of any framework that supports JSX, such as preact, react, solid, svelte, vue, and more, with hast-util-to-jsx-runtime:

import {toJsxRuntime} from 'hast-util-to-jsx-runtime'
// @ts-expect-error: react types don’t type these.
import {Fragment, jsx, jsxs} from 'react/jsx-runtime'
import {common, createLowlight} from 'lowlight'

const lowlight = createLowlight(common)

const tree = lowlight.highlight('js', '"use strict";')

console.log(toJsxRuntime(tree, {Fragment, jsx, jsxs}))

Yields:

{
  $$typeof: Symbol(react.element),
  type: Symbol(react.fragment),
  key: null,
  ref: null,
  props: {children: [[Object], ';']},
  _owner: null,
  _store: {}
}

Types

This package is fully typed with TypeScript. It exports the additional types AutoOptions, LanguageFn, and Options.

It also registers root.data with @types/hast. If you’re working with the data fields, make sure to import this package somewhere in your types, as that registers the new fields on the file.

/**
 * @typedef {import('hast').Root} Root
 *
 * @typedef {import('lowlight')}
 */

import {VFile} from 'vfile'

/** @type {Root} */
const root = {type: 'root', children: []}

console.log(root.data?.language) //=&gt; TS now knows that this is a `string?`.

Data

If you’re using createLowlight(), no syntaxes are included yet. You can import all or common and pass them, such as with createLowlight(all). Checked syntaxes are included in common. All syntaxes are included in all.

You can also manually import syntaxes from highlight.js/lib/languages/xxx, where xxx is the name, such as 'highlight.js/lib/languages/wasm'.

[ ] 1c — 1C:Enterprise
[ ] abnf — Augmented Backus-Naur Form
[ ] accesslog — Apache Access Log
[ ] actionscript (as) — ActionScript
[ ] ada — Ada
[ ] angelscript (asc) — AngelScript
[ ] apache (apacheconf) — Apache config
[ ] applescript (osascript) — AppleScript
[ ] arcade — ArcGIS Arcade
[x] arduino (ino) — Arduino
[ ] armasm (arm) — ARM Assembly
[ ] asciidoc (adoc) — AsciiDoc
[ ] aspectj — AspectJ
[ ] autohotkey (ahk) — AutoHotkey
[ ] autoit — AutoIt
[ ] avrasm — AVR Assembly
[ ] awk — Awk
[ ] axapta (x++) — X++
[x] bash (sh) — Bash
[ ] basic — BASIC
[ ] bnf — Backus–Naur Form
[ ] brainfuck (bf) — Brainfuck
[x] c (h) — C
[ ] cal — C/AL
[ ] capnproto (capnp) — Cap’n Proto
[ ] ceylon — Ceylon
[ ] clean (icl, dcl) — Clean
[ ] clojure (clj, edn) — Clojure
[ ] clojure-repl — Clojure REPL
[ ] cmake (cmake.in) — CMake
[ ] coffeescript (coffee, cson, iced) — CoffeeScript
[ ] coq — Coq
[ ] cos (cls) — Caché Object Script
[x] cpp (cc, c++, h++, hpp, hh, hxx, cxx) — C++
[ ] crmsh (crm, pcmk) — crmsh
[ ] crystal (cr) — Crystal
[x] csharp (cs, c#) — C#
[ ] csp — CSP
[x] css — CSS
[ ] d — D
[ ] dart — Dart
[ ] delphi (dpr, dfm, pas, pascal) — Delphi
[x] diff (patch) — Diff
[ ] django (jinja) — Django
[ ] dns (bind, zone) — DNS Zone
[ ] dockerfile (docker) — Dockerfile
[ ] dos (bat, cmd) — Batch file (DOS)
[ ] dsconfig — undefined
[ ] dts — Device Tree
[ ] dust (dst) — Dust
[ ] ebnf — Extended Backus-Naur Form
[ ] elixir (ex, exs) — Elixir
[ ] elm — Elm
[ ] erb — ERB
[ ] erlang (erl) — Erlang
[ ] erlang-repl — Erlang REPL
[ ] excel (xlsx, xls) — Excel formulae
[ ] fix — FIX
[ ] flix — Flix
[ ] fortran (f90, f95) — Fortran
[ ] fsharp (fs, f#) — F#
[ ] gams (gms) — GAMS
[ ] gauss (gss) — GAUSS
[ ] gcode (nc) — G-code (ISO 6983)
[ ] gherkin (feature) — Gherkin
[ ] glsl — GLSL
[ ] gml — GML
[x] go (golang) — Go
[ ] golo — Golo
[ ] gradle — Gradle
[x] graphql (gql) — GraphQL
[ ] groovy — Groovy
[ ] haml — HAML
[ ] handlebars (hbs, html.hbs, html.handlebars, htmlbars) — Handlebars
[ ] haskell (hs) — Haskell
[ ] haxe (hx) — Haxe
[ ] hsp — HSP
[ ] http (https) — HTTP
[ ] hy (hylang) — Hy
[ ] inform7 (i7) — Inform 7
[x] ini (toml) — TOML, also INI
[ ] irpf90 — IRPF90
[ ] isbl — ISBL
[x] java (jsp) — Java
[x] javascript (js, jsx, mjs, cjs) — JavaScript
[ ] jboss-cli (wildfly-cli) — JBoss CLI
[x] json — JSON
[ ] julia — Julia
[ ] julia-repl (jldoctest) — Julia REPL
[x] kotlin (kt, kts) — Kotlin
[ ] lasso (ls, lassoscript) — Lasso
[ ] latex (tex) — LaTeX
[ ] ldif — LDIF
[ ] leaf — Leaf
[x] less — Less
[ ] lisp — Lisp
[ ] livecodeserver — LiveCode
[ ] livescript (ls) — LiveScript
[ ] llvm — LLVM IR
[ ] lsl — LSL (Linden Scripting Language)
[x] lua — Lua
[x] makefile (mk, mak, make) — Makefile
[x] markdown (md, mkdown, mkd) — Markdown
[ ] mathematica (mma, wl) — Mathematica
[ ] matlab — Matlab
[ ] maxima — Maxima
[ ] mel — MEL
[ ] mercury (m, moo) — Mercury
[ ] mipsasm (mips) — MIPS Assembly
[ ] mizar — Mizar
[ ] mojolicious — Mojolicious
[ ] monkey — Monkey
[ ] moonscript (moon) — MoonScript
[ ] n1ql — N1QL
[ ] nestedtext (nt) — Nested Text
[ ] nginx (nginxconf) — Nginx config
[ ] nim — Nim
[ ] nix (nixos) — Nix
[ ] node-repl — Node REPL
[ ] nsis — NSIS
[x] objectivec (mm, objc, obj-c, obj-c++, objective-c++) — Objective-C
[ ] ocaml (ml) — OCaml
[ ] openscad (scad) — OpenSCAD
[ ] oxygene — Oxygene
[ ] parser3 — Parser3
[x] perl (pl, pm) — Perl
[ ] pf (pf.conf) — Packet Filter config
[ ] pgsql (postgres, postgresql) — PostgreSQL
[x] php — undefined
[x] php-template — PHP template
[x] plaintext (text, txt) — Plain text
[ ] pony — Pony
[ ] powershell (pwsh, ps, ps1) — PowerShell
[ ] processing (pde) — Processing
[ ] profile — Python profiler
[ ] prolog — Prolog
[ ] properties — .properties
[ ] protobuf (proto) — Protocol Buffers
[ ] puppet (pp) — Puppet
[ ] purebasic (pb, pbi) — PureBASIC
[x] python (py, gyp, ipython) — Python
[x] python-repl (pycon) — undefined
[ ] q (k, kdb) — Q
[ ] qml (qt) — QML
[x] r — R
[ ] reasonml (re) — ReasonML
[ ] rib — RenderMan RIB
[ ] roboconf (graph, instances) — Roboconf
[ ] routeros (mikrotik) — MikroTik RouterOS script
[ ] rsl — RenderMan RSL
[x] ruby (rb, gemspec, podspec, thor, irb) — Ruby
[ ] ruleslanguage — Oracle Rules Language
[x] rust (rs) — Rust
[ ] sas — SAS
[ ] scala — Scala
[ ] scheme (scm) — Scheme
[ ] scilab (sci) — Scilab
[x] scss — SCSS
[x] shell (console, shellsession) — Shell Session
[ ] smali — Smali
[ ] smalltalk (st) — Smalltalk
[ ] sml (ml) — SML (Standard ML)
[ ] sqf — SQF
[x] sql — SQL
[ ] stan (stanfuncs) — Stan
[ ] stata (do, ado) — Stata
[ ] step21 (p21, step, stp) — STEP Part 21
[ ] stylus (styl) — Stylus
[ ] subunit — SubUnit
[x] swift — Swift
[ ] taggerscript — Tagger Script
[ ] tap — Test Anything Protocol
[ ] tcl (tk) — Tcl
[ ] thrift — Thrift
[ ] tp — TP
[ ] twig (craftcms) — Twig
[x] typescript (ts, tsx, mts, cts) — TypeScript
[ ] vala — Vala
[x] vbnet (vb) — Visual Basic .NET
[ ] vbscript (vbs) — VBScript
[ ] vbscript-html — VBScript in HTML
[ ] verilog (v, sv, svh) — Verilog
[ ] vhdl — VHDL
[ ] vim — Vim Script
[x] wasm — WebAssembly
[ ] wren — Wren
[ ] x86asm — Intel x86 Assembly
[ ] xl (tao) — XL
[x] xml (html, xhtml, rss, atom, xjb, xsd, xsl, plist, wsf, svg) — HTML, XML
[ ] xquery (xpath, xq, xqm) — XQuery
[x] yaml (yml) — YAML
[ ] zephir (zep) — Zephir

CSS

lowlight does not inject CSS for the syntax highlighted code (because well, lowlight doesn’t have to be turned into HTML and might not run in a browser!). If you are in a browser, you can use any highlight.js theme. For example, to get GitHub Dark from cdnjs:

Compatibility

This package is compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, lowlight@^3, compatible with Node.js 16.

Security

This package is safe.

refractor — the same as lowlight but with Prism
starry-night — similar but like GitHub and really good

Projects

emphasize — syntax highlighting in ANSI (for the terminal)
react-lowlight — syntax highlighter for React
react-syntax-highlighter — React component for syntax highlighting
rehype-highlight — rehype plugin to highlight code blocks
jstransformer-lowlight — syntax highlighting for JSTransformers and Pug

Contribute

Yes please! See How to Contribute to Open Source.

License

lowlight dependencies

@types/hast devlop highlight.js

lowlight development dependencies

@types/mdast @types/node @types/unist c8 chalk estree-util-is-identifier-name hast-util-to-html mdast-zone prettier remark-cli remark-preset-wooorm type-coverage typescript unified xo

FAQs

What is lowlight?

Virtual syntax highlighting for virtual DOMs and non-HTML things. Visit Snyk Advisor to see a full health score report for lowlight, including popularity, security, maintenance & community analysis.

Is lowlight popular?

The npm package lowlight receives a total of 2,520,507 weekly downloads. As such, lowlight popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is lowlight well maintained?

We found indications that lowlight is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is lowlight safe to use?

The npm package lowlight was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 November-2024, at 20:52 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (2,520,507)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use lowlight?

lowlight

Contents

What is this?

When should I use this?

Install

Use

API

all

common

createLowlight([grammars])

Parameters

Returns

lowlight.highlight(language, value[, options])

Parameters

Returns

Example

lowlight.highlightAuto(value[, options])

Parameters

Returns

Example

lowlight.listLanguages()

Returns

Example

lowlight.register(grammars)

Signatures

Parameters

Returns

Example

lowlight.registerAlias(aliases)

Signatures

Parameters

Returns

Example

lowlight.registered(aliasOrlanguage)

Parameters

Returns

Example

AutoOptions

Fields

LanguageFn

Type

Options

Fields

Examples

Example: serializing hast as html

Example: turning hast into preact, react, etc

Types

Data

CSS

Compatibility

Security

Related

Projects

Contribute

License

lowlight dependencies

lowlight development dependencies

FAQs

What is lowlight?

Is lowlight popular?

Is lowlight well maintained?

Is lowlight safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

`all`

`common`

`createLowlight([grammars])`

`lowlight.highlight(language, value[, options])`

`lowlight.highlightAuto(value[, options])`

`lowlight.listLanguages()`

`lowlight.register(grammars)`

`lowlight.registerAlias(aliases)`

`lowlight.registered(aliasOrlanguage)`

`AutoOptions`

`LanguageFn`

`Options`