https://github.com/goatandsheep/pretti
Sensible presets and some tweaks for beautifying HTML with js-beautify according to my preferences.
https://github.com/goatandsheep/pretti
beautify format formatter html indentation javascript js-beautify markup nodejs prettify whitespace
Last synced: over 1 year ago
JSON representation
Sensible presets and some tweaks for beautifying HTML with js-beautify according to my preferences.
- Host: GitHub
- URL: https://github.com/goatandsheep/pretti
- Owner: goatandsheep
- License: mit
- Created: 2021-02-13T04:49:13.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-02-10T21:32:00.000Z (over 1 year ago)
- Last Synced: 2025-02-27T10:35:22.278Z (over 1 year ago)
- Topics: beautify, format, formatter, html, indentation, javascript, js-beautify, markup, nodejs, prettify, whitespace
- Language: JavaScript
- Homepage:
- Size: 99.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# pretti
Based on [pretty ](https://www.npmjs.com/package/pretty)
[](https://www.npmjs.com/package/pretti)
[](https://codecov.io/gh/goatandsheep/pretti)
[](https://npmjs.org/package/pretti)
[](https://snyk.io/test/github/goatandsheep/pretti)
> Some tweaks for beautifying HTML with js-beautify according to my preferences.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save pretti
```
Install with [yarn](https://yarnpkg.com):
```sh
$ yarn add pretti
```
## Usage
```js
var pretty = require('pretti');
pretty(STRING_OF_HTML);
```
Before
```html
Home
This is content.
```
After
```html
Home
This is content.
```
## Options
### ocd
```js
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](../../issues/new).
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && 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:
```sh
$ npm install && npm test
```
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 13, 2017._