JSBeautifier Python Library

1.15.4 · active · verified Thu Apr 09

jsbeautifier is the official Python wrapper for the popular js-beautify project, providing JavaScript, HTML, and CSS code formatting and beautification capabilities. It is actively maintained with releases typically aligning with the core JavaScript library, currently at version 1.15.4.

Warnings

gotcha The PyPI metadata for `jsbeautifier` incorrectly states `requires_python: None`. The actual minimum Python version required by `jsbeautifier` 1.15.4 and newer is Python 3.7.
Fix: Ensure your environment uses Python 3.7 or higher. Always consult the `python_requires` metadata in the official source distribution or `pyproject.toml` for the most accurate requirement.
gotcha Beautifier options must be passed as an `options` object, typically initialized via `jsbeautifier.default_options()`, rather than directly as keyword arguments to `beautify()`, `html_beautify()`, or `css_beautify()`.
Fix: Create an options object: `opts = jsbeautifier.default_options(); opts.indent_size = 4; beautified = jsbeautifier.beautify(code, opts)`.
gotcha The `jsbeautifier` Python package's version directly reflects the version of the underlying `js-beautify` JavaScript project. Breaking changes in the core `js-beautify` library will implicitly affect the Python wrapper, even if the Python API surface itself doesn't change.
Fix: Always consult the changelog of the main `beautify-web/js-beautify` GitHub repository for potential behavioral changes or deprecations when upgrading `jsbeautifier`.

Install

pip install jsbeautifier Install latest version

Imports

beautify
```
from jsbeautifier import beautify
```
html_beautify
```
from jsbeautifier import html_beautify
```
css_beautify
```
from jsbeautifier import css_beautify
```

default_options

from jsbeautifier import default_options

Quickstart

This quickstart demonstrates how to beautify JavaScript and HTML code using `jsbeautifier`. It shows how to import the necessary functions, create and customize an options object, and apply it to format code strings.

import jsbeautifier

# Example for JavaScript beautification
js_code = "function test( ){ var x=1;if(x){ return x;} else { return 0;}}"

# Create and customize options object
options = jsbeautifier.default_options()
options.indent_size = 2
options.space_in_paren = True
options.keep_array_indentation = True

beautified_js = jsbeautifier.beautify(js_code, options)

print("Original JS:\n", js_code)
print("\nBeautified JS:\n", beautified_js)

# Example for HTML beautification (using the same options)
html_code = "<html><head><title>Test</title></head><body><h1>Hello</h1>  <p>World</p></body></html>"
beautified_html = jsbeautifier.html_beautify(html_code, options)

print("\nOriginal HTML:\n", html_code)
print("\nBeautified HTML:\n", beautified_html)

view raw JSON →