Socket
Socket
Sign inDemoInstall

pretty-html-log

Package Overview
Dependencies
9
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    pretty-html-log

pretty-html-log is a npm module that pretty prints a raw html string to the console. It indents and highlights your code.


Version published
Weekly downloads
15K
increased by5.09%
Maintainers
1
Install size
9.37 MB
Created
Weekly downloads
 

Changelog

Source

1.1.1 (2020-04-19)

Bug Fixes

  • deps: update deps and fix vulnerabilities (f2fc94e)

Features

  • prettier: use prettier config if available (2b63635)

Readme

Source

Pretty HTML log

Logo

pretty-html-log is a tool that allows you to highlight and pretty print your html string to console.

pretty html log demo

Getting started 🚀

There are two ways to use pretty-html-log

  • Use it in your typescript / javascript code
  • Use it via command line or in your npm scripts

The module is available as node module and can be installed with the following command.

npm install pretty-html-log

☝️ If you use it via command line tool you can always directly execute the bin with npx (no npm install needed).

  npx pretty-html-log '<html><h1 class="test"></h1></html>'

API

  • htmlString (required) a raw html string
  • theme (optional) an optional theme (more bellow)

Themes 🎨

Currently pretty-html-log provides 3 different themes:

  • Dracula (default)
  • Material
  • Vscode

Usage over Javascript or Typescript 👨‍💻

If you want to use this module inside your code you can simply import the hightlight function from pretty-html-log.

Simple usage

Choose your theme

The highlight function also accepts a theme as a second optional argument. A theme can be imported and then passed to the module.

Use as Script 📜

Sometimes it makes sense to pretty print an HTML string inside your build process or maybe you want to just pretty print a string over the console.

Simple usage

To just pretty print and highlight a HTML string simply type the following command:

Choose your theme

The command line tool also allows you to choose your theme. Simply use -t or --theme and pass one of the following strings as an argument:

  • vscode
  • material
  • dracula

Help menu

Of course you don't have to remember those commands - theres a help menu available which you can use at any point to look up the docs.

Simply type

pretty-html-log --help

or

pretty-html-log -h

Credits

The core alogrithm is taken from highlight.js. The algorithm from highlight has been rewritten in this module to specifically support HTML and not all languages. Therefore the engine is much smaller. Furthermore the code of pretty-html-log is written in Typescript and optimized for HTML highlighting in the console.

Keywords

FAQs

Last updated on 19 Apr 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc