What is pretty?
The 'pretty' npm package is designed to beautify the formatting of various types of content, making it more readable and aesthetically pleasing. It primarily focuses on improving the appearance of HTML, CSS, and JavaScript code. By reformatting code with consistent spacing, indentation, and line breaks, 'pretty' helps developers maintain a clean and organized codebase.
What are pretty's main functionalities?
HTML Beautification
This feature allows you to beautify HTML content by reformatting it with proper indentation and spacing. The code sample demonstrates how to use 'pretty' to transform a compact, hard-to-read HTML string into a more readable and well-formatted version.
"const pretty = require('pretty');
const uglyHTML = '<div><p>lorem</p></div>';
const beautifulHTML = pretty(uglyHTML);
console.log(beautifulHTML);"
Custom Indentation
This feature allows users to customize the indentation and formatting of the output. By passing an options object, users can adjust the behavior of 'pretty' to meet specific formatting standards or preferences. The code sample illustrates how to enable the 'ocd' option for even more meticulous formatting.
"const pretty = require('pretty');
const uglyHTML = '<div><p>lorem</p></div>';
const options = {ocd: true};
const beautifulHTML = pretty(uglyHTML, options);
console.log(beautifulHTML);"
Other packages similar to pretty
js-beautify
Similar to 'pretty', 'js-beautify' is a package that provides beautification for HTML, CSS, and JavaScript. It offers a wide range of configuration options allowing for detailed customization of the output. Compared to 'pretty', 'js-beautify' might be considered more versatile due to its extensive configuration capabilities.
prettier
Prettier is a widely used code formatter that supports many languages beyond HTML, CSS, and JavaScript, including frameworks and template languages. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary. While 'pretty' focuses on beautifying code, 'prettier' emphasizes consistency and supports a broader range of languages.
pretty
Some tweaks for beautifying HTML with js-beautify according to my preferences.
Install
Install with npm:
$ npm install --save pretty
Install with yarn:
$ yarn add pretty
Usage
var pretty = require('pretty');
pretty(STRING_OF_HTML);
Before
<!DOCTYPE html> <html lang="en"> <head>
<meta charset="UTF-8"> <title>Home</title>
</head> <body> This is content. </body> </html>
After
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Home</title>
</head>
<body>
This is content.
</body>
</html>
Options
ocd
pretty(STRING_OF_HTML, {ocd: true});
Type: Boolean
Default: undefined
- condenses multiple newlines to a single newline
- trims leading and trailing whitespace
- ensures that a trailing newline is inserted
- normalizes whitespace before code comments
About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb
Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Author
Jon Schlinkert
License
Copyright © 2017, Jon Schlinkert.
Released under the MIT License.
This file was generated by verb-generate-readme, v0.5.0, on April 13, 2017.