Preserves the presence or lack thereof of whitespace surrounding HTML comments
npm install @ciolabs/html-preserve-comment-whitespace> Preserves the presence or lack thereof of whitespace surrounding HTML comments.
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
``
npm install @ciolabs/preserve-comment-whitespace
`js
import { preserve, restore } from '@ciolabs/preserve-comment-whitespace';
import beautify from 'js-beautify';
const html =
;const comments = preserve(html);
const formatted = beautify.html(html);
//=>
\n \n \n \n
const formattedAndRestored = restore(formatted, comments);
//=> \n \n
`API
$3
Returns an Array containing the objects describing the HTML comments.
$3
Returns a string where the whitespace around the HTML comments is restored.
Note: the processing between
and restore should not 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 | requiredString of HTML after any formatting that would have affected the whitespace.
#### comments
>
CommentData[] | defaults to []The Array returned from
.#### options
>
RestoreOptions | defaults to { restoreInline: true }Configuration for how to restore the comment whitespace.
Accept
. 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.Types
$3
`typescript
interface CommentData {
leadingWhitespace: string;
trailingWhitespace: string;
hasLeadingWhitespace: boolean;
hasTrailingWhitespace: boolean;
}
`$3
typescript
interface RestoreOptions {
restoreInline: boolean;
}
``