Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 3 months 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 (almost 4 years ago)
Default Branch: master
Last Pushed: 2024-09-06T07:14:04.000Z (5 months ago)
Last Synced: 2024-10-11T22:09:11.723Z (4 months ago)
Topics: beautify, format, formatter, html, indentation, javascript, js-beautify, markup, nodejs, prettify, whitespace
Language: JavaScript
Homepage:
Size: 115 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 13
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # pretti

Based on [pretty ![npm downloads](https://img.shields.io/npm/dt/pretty.svg?style=flat-square)](https://www.npmjs.com/package/pretty)

[![NPM version](https://img.shields.io/npm/v/pretti.svg?style=flat)](https://www.npmjs.com/package/pretti)

[![codecov](https://codecov.io/gh/goatandsheep/pretti/branch/master/graph/badge.svg?token=tgPNrZoH4k)](https://codecov.io/gh/goatandsheep/pretti)

[![NPM monthly downloads](https://img.shields.io/npm/dm/pretti.svg?style=flat)](https://npmjs.org/package/pretti)

[![Known Vulnerabilities](https://snyk.io/test/github/goatandsheep/pretti/badge.svg)](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._