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

preserve-comment-whitespace

v0.0.3

Published

Preserves the presence or lack thereof of whitespace surrounding HTML comments.

Downloads

2,261

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

avigoldmanavigoldman

Keywords

htmlcommentswhitespacewhitespacepreservejs-beautifyprettieremail

Readme

preserve-comment-whitespace

Preserves the presence or lack thereof of whitespace surrounding HTML comments.

codecov npm package Twitter Follow

HTML formatters don't always properly handle HTML comments. This package attempts to properly maintain the whitespace around the HTML comments.

Some known issues:

  • https://github.com/beautify-web/js-beautify/issues/1301
  • https://github.com/beautify-web/js-beautify/issues/1823

Install

$ npm install preserve-comment-whitespace

Usage

const { preserve, restore } = require('preserve-comment-whitespace');
const beautify = require('js-beautify').html;

const html = `<div><div><!-- my html comment --></div></div>`

const comments = preserve(html);
const formatted = beautify(html);
//=> <div>\n    <div>\n        <!-- my html comment -->\n    </div>\n</div>
const formattedAndRestored = restore(formatted, comments)
//=> <div>\n    <div><!-- my html comment --></div>\n</div>

API

preserve(html)

Returns an Array containing the objects descripting the HTML comments.

restore(html, comments, options)

Returns a string where the whitespace around the HTML comments is restored.

Note: the processing between preserve and restore should add or remove any comments. If the number of comments given don't match the number of comments found in the given HTML, restore will return the given string, unprocessed.

html

String | required

String of HTML after any formatting that would have affected the whitespace.

comments

Array | defaults to []

The Array returned from preserve.

options

Object | defaults to { restoreInline: true }

Configuration for how to restore the comment whitespace.

Accept restoreInline. If true, comments that were originally inline (i.e. not on their own lines) will be restored to be inline. Otherwise, it will accept the new line placement.

Related