machy8/xhtml-formatter

Simple, lightweight, customizable (X)HTML and XML formatter / beautifier.

Maintainers

Details

github.com/Machy8/xhtml-formatter

Source

Issues

Installs: 147 123

Dependents: 6

Suggesters: 0

Security: 0

Stars: 10

Watchers: 3

Forks: 2

Open Issues: 0

v1.0.0 2017-08-14 16:31 UTC

Requires

  • php: >=7.0

Requires (Dev)

New BSD License 30976e9d3d6c7124142d3b5bb5f7fb00851168d1

  • Vladimír Macháček <8machy.woop@seznam.cz>

xmlhtmlformatterxhtmlbeautifier

This package is auto-updated.

Last update: 2024-12-11 15:28:46 UTC

README

Build Status

Installation

composer require machy8/xhtml-formatter

Usage

Compiles this 💩

<!DOCTYPE html>
<html lang="en">
    <head><meta charset="utf-8"><title>title</title>
    <link rel="stylesheet" href="style.css">
<script src="script.js"></script></head><body><!-- page content --></body></html>

into this 😱😭

<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8">
		<title>
			title
		</title>
		<link rel="stylesheet" href="style.css">
		<script src="script.js"></script>
	</head>
	<body>
		<!-- page content -->
	</body>
</html>

and all you need is

use XhtmlFormatter\Formatter;

$formatter = new Formatter();

$output = $formatter->format($string);

and if you want to disable formatting

<div>
	<formatter-off>
		<p>
			<b>Unformatted code goes <u>here</u></b>!
		</p>
	</formatter-off>
</div>

Setup

$formatter

	// Change the content type from CONTENT_HTML (default) to CONTENT_XML or CONTENT_XHTML
	->setContentType(Formatter::CONTENT_XML)

	// Add new unpaired element
	->addUnpairedElement('element', Formatter::CONTENT_XML)

	// Add skipped elements
	->addSkippedElement('elementA elementB')

	// Indent file by 4 spaces instead of tabs
	->setSpacesIndentationMethod(4);