jonschlinkert/pretty

Stars
135
Rank 269,297 (Top 6 %)
Language
JavaScript
License
MIT License
Created about 11 years ago
Updated over 3 years ago

jonschlinkert/pretty

jonschlinkert

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Sensible presets and some tweaks for beautifying HTML with js-beautify according to my preferences.

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#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:

$ 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.

remarkable

Markdown parser, done right. Commonmark support, extensions, syntax plugins, high speed - all in one. Gulp and metalsmith plugins available. Used by Facebook, Docusaurus and many others! Use https://github.com/breakdance/breakdance for HTML-to-markdown conversion. Use https://github.com/jonschlinkert/markdown-toc to generate a table of contents.

gray-matter

Smarter YAML front matter parser, used by metalsmith, Gatsby, Netlify, Assemble, mapbox-gl, phenomic, vuejs vitepress, TinaCMS, Shopify Polaris, Ant Design, Astro, hashicorp, garden, slidev, saber, sourcegraph, and many others. Simple to use, and battle tested. Parses YAML by default but can also parse JSON Front Matter, Coffee Front Matter, TOML Front Matter, and has support for custom parsers. Please follow gray-matter's author: https://github.com/jonschlinkert

markdown-toc

API and CLI for generating a markdown TOC (table of contents) for a README or any markdown files. Uses Remarkable to parse markdown. Used by NASA/openmct, Prisma, Joi, Mocha, Sass, Prettier, Orbit DB, FormatJS, Raneto, hapijs/code, webpack-flow, docusaurus, release-it, ts-loader, json-server, reactfire, bunyan, husky, react-easy-state, react-snap, chakra-ui, carbon, alfresco, repolinter, Assemble, Verb, and thousands of other projects.

gulp-htmlmin

sublime-markdown-extended

Top 100 Sublime Text plugin! Markdown syntax highlighter for Sublime Text, with extended support for GFM fenced code blocks, with language-specific syntax highlighting. YAML Front Matter. Works with ST2/ST3. Goes great with Assemble.

maintainers-guide-to-staying-positive

Don't let the trolls get you down! Use this as a reference to avoid open-source burnout and keep doing what you love: writing code! Contributions and any kind of improvements are very welcome!

sublime-monokai-extended

Extends Monokai from Soda with additional syntax highlighting for Markdown, LESS, HTML, Handlebars and more.

kind-of

Get the native JavaScript type of a value, fast. Used by superstruct, micromatch and many others!

clone-deep

Recursively (deep) clone JavaScript native types, like Object, Array, RegExp, Date as well as primitives. Used by superstruct, merge-deep, and many others!

set-value

Set nested properties on an object using dot-notation.

is-number

JavaScript/Node.js utility. Returns `true` if the value is a number or string number. Useful for checking regex match results, user input, parsed strings, etc.

get-value

Use property paths (`a.b.c`) get a nested value from an object.

word-wrap

Wrap words to a specified length.

randomatic

Easily generate random strings like passwords, with simple options for specifying a length and for using patterns of numeric, alpha-numeric, alphabetical, special or custom characters. (the original "generate-password")

data-store

Easily get, set and persist config data. Fast. Supports dot-notation in keys. No dependencies.

is-plain-object

Returns true if the given value is an object created by the Object constructor.

guide-to-staying-productive

If you're looking for ways to stay motivated and focused, while still having fun, this guide is for you! Contributions and any kind of improvements are very welcome!

parse-github-url

Parse a Github URL into an object. Supports a wide variety of GitHub URL formats.

time-stamp

Get a formatted timestamp. Used in gulp, assemble, generate, and many others.

idiomatic-contributing

A brief guide to being an effective open source contributor.

merge-deep

Recursively merge values in a JavaScript object.

strip-comments

Strip block comments or line comments from JavaScript code.

isobject

Is the value an object, and not an array or null?

normalize-path

Normalize file path slashes to be unix-like forward slashes. Used by chokidar, anymatch, and many others!

gists

Methods for working with the GitHub Gist API. Node.js/JavaScript

copy

Copy files using glob patterns. Sync, async, promise or streams. (node.js utility)

git-branch

Get the current branch for a local git repository

dashify

Convert a string to a dash-separated string (kebab case). Works with camelcase, pascalcase, space-separated, etc.

vertical-rhythm

Put some typographical vertical rhythm in your CSS. LESS, Stylus and SCSS/SASS versions included.

write

Write data to the file system, creating any intermediate directories if they don't already exist. Used by flat-cache and many others!

window-size

Reliable way to to get the height and width of the terminal/console in a node.js environment.

object.omit

Return a copy of an object without the given keys.

mixin-deep

Deeply mix the properties of objects into the first object, while also mixing-in child objects.

assign-deep

Deeply assign the enumerable properties of source objects to a destination object.

grunt-prettify

Grunt plugin for beautifying HTML. Lots of options so that you can format/beautify the generated HTML the way you want it.

template-helpers

Generic JavaScript helpers that can be used with any template engine. Handlebars, Lo-Dash, Underscore, or any engine that supports helper functions.

omit-deep

Recursively omit specified keys from an object.

omit-empty

Recursively omit empty properties from an object. Omits empty objects, arrays, strings, and optionally zero. Similar results to what you would expect with `compact` for arrays.

array-sort

Fast and powerful array sorting. Sort an array of objects by one or more properties. Any number of nested properties or custom comparison functions may be used.

dry

Dry is a new template engine and language, and is a superset of Shopify's Liquid, with first-class support for advanced inheritance features, and more. From the creators of Enquirer, Assemble, Remarkable, and Micromatch.

grunt-refactor

Grunt tasks for re-factoring code.

parse-comments

Parse JavaScript code comments. Works with block and line comments, and should work with CSS, LESS, SASS, or any language with the same comment formats.

utils

Fast, generic JavaScript/node.js utility functions.

github-base

Simple, opinionated node.js interface for creating basic apps with the GitHub API.

arr-flatten

Recursively flatten an array or arrays. This is the fastest implementation of array flatten.

templates

System for creating and managing view collections, rendering, engines, routes and more. See the "dev" branch for most recent updates.

parse-gitignore

Parse a gitignore file into an array of patterns. Comments and empty lines are stripped.

parse-git-config

Parse `.git/config` into a JavaScript object. sync or async.

array-unique

Return an array free of duplicate values. Very fast implementation.

sublime-swig

Swig template syntax highlighting for Sublime Text.

to-regex

Generate a regex from a string or array of strings.

split-string

Split a string on a given character or characters, with support for escaping.

fill-range

Fill in a range of numbers or letters, positive or negative, optionally passing an increment or multiplier to use.

cache-base

Basic object store with methods like get/set/extend/omit

template

Render templates from any engine. Make custom template types, use layouts on pages, partials or any custom template type, custom delimiters, helpers, middleware, routes, loaders, and lots more. Powers Assemble v0.6.0, Verb v0.3.0 and your application.

align-text

Align the text in a string.

grunt-fixmyjs

Automatically fix js-hint errors.

lazy-cache

Cache requires to be lazy-loaded when needed. Uses node's own require system with tried and true, plain-vanilla JavaScript getters.

gulp-prettify

exponential-moving-average

Calculate an exponential moving average from an array of numbers.

pretty-time

Easily format the time from node.js `process.hrtime`. Works with timescales ranging from weeks to nanoseconds.

is-windows

Returns true if the platform is Windows (and Cygwin or MSYS/MinGW for unit tests)

extract-comments

Extract JavaScript code comments from a string or glob of files.

repeat-string

Repeat the given string n times. Fastest implementation for repeating a string (2x faster than the native method)

arr-diff

Returns an array with only the unique values from all given arrays using strict equality for comparisons.

pad-left

Left pad a string with zeros or a specified string. Fastest implementation.

unixify

Convert a windows file path to a unix-style file path.

object.pick

(object pick) returns a filtered copy of an object with only the specified keys, exactly like `pick` from lo-dash / underscore.

delete-empty

Recursively delete all empty folders in a directory and child directories.

handlebars-delimiters

Custom delimiters, for Handlebars templates.

write-yaml

Basic node.js utility for converting JSON to YAML and writing formatting YAML files to disk.

regex-cache

Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in dramatic speed improvements.

unescape

Convert HTML entities to HTML characters, e.g. `>` => `>`.

pascalcase

Convert a string to pascal case (upper camel case). Used by more than 8.7 million projects on GitHub! Please follow this library's author: https://github.com/jonschlinkert

is-primitive

Is the typeof value a javascript primitive?

is-git-url

Regex to validate that a URL is a git URL.

deep-rename-keys

Recursively rename the keys in an object.

unset-value

Delete nested properties from an object using dot notation.

fs-utils

Generalized file and path utils for Node.js projects.

array-last

Return the last element in an array. Faster than `.slice`

relative

Easily calculate the relative path from file A to file B in Node.js project. Will calculate correctly from a file to a directory, file to file, directory to file, and directory to directory.

for-in

Iterate over the enumerable properties of an object, and return an object with properties that evaluate to true from the callback. Exit early by returning `false`.

global-modules

Returns the directory used by NPM for globally installed NPM packages.

extend-shallow

Extend object A with the properties of object B. node.js/javascript util.

eval-estree-expression

Safely evaluate JavaScript (estree) expressions, sync and async.

regex-not

Create a javascript regular expression for matching everything except for the given string.

longest

Get the length of the longest item in an array.

whence

Add context awareness to your apps and frameworks by safely evaluating user-defined conditional expressions. Useful for evaluating expressions in config files, prompts, key bindings, completions, templates, and many other user cases.

markdown-utils

Convert plain text into snippets of markdown.

grunt-readme

DEPRECATED. Use Verb instead

js-comments

Parse JavaScript code comments and generate API documentation.

justified

Wrap, align and justify the words in a string.

is-equal-shallow

Does a shallow comparison of two objects, returning false if the keys or values differ.

shallow-clone

Make a shallow clone of an object, array or primitive.

parse-filepath

Parse a filepath and return an object of path parts. Falls back on native node.js `path.parse` if it exists

yarn-api

Basic API for yarn.

is-directory

Extends `stats.isDirectory()`, returns `true` if a filepath is a directory.

global-prefix

Get the npm global path prefix. Same code used internally by npm.

rename-keys

Modify/rename the keys of the own enumerable properties of an object.

has-value

Returns true if a value exists, false if empty. Works with deeply nested values using object paths.