@trevixal/extension-format-code

Documentation · Live editor · Changelog · Issues

Features

• JSON and XML pretty-printing and minification
• An in-place code-block reformat command
• 1.9 kB minified and gzipped, with TypeScript types in the package

Pretty-print or minify the JSON or XML in the code block at the caret.

npm install @trevixal/extension-format-code

Usage

import { formatCodeBlock, minifyCodeBlock, codeFormatUICommands } from '@trevixal/extension-format-code'

editor.exec(formatCodeBlock('json'))
editor.exec(minifyCodeBlock('xml'))

// Or hand the set to the chrome, which puts them under Tools.
createEditorUI(editor, { codeFormatCommands: codeFormatUICommands(), /* … */ })

The block is rewritten in place as a single undo step, and the command declines when the caret is not in a code block or the content does not parse, so a typo never destroys what you were formatting.

Standalone formatters

formatJSON, minifyJSON, formatXML, minifyXML and normalizeIndent are pure string functions, usable anywhere.

formatJSON parses for real, never eval, never a regex rewrite, so nothing in the source can execute and a malformed document is reported rather than half-formatted.

It measures the nesting depth first, with a flat scan, and declines past 500 levels. JSON.parse and JSON.stringify are both recursive in every engine, so a pathologically nested document ([[[[[…]]]]]) overflows the stack, a RangeError at best and an uncatchable crash at worst. Checking first turns that into an ordinary error message.

License

Apache-2.0