Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

xml-beautify

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

xml-beautify

XML pretty formatter that corresponds to the self-closing empty elements.

1.2.3
latest
Source
npm

Version published: 3 years ago

Weekly downloads: 3.6K; decreased by-10.37%

Maintainers: 1

Weekly downloads

Created: 6 years ago

Source

xml-beautify

xml-beautify - pretty-print text in XML formats.

It is licensed under MIT license.

How to use?

var beautifiedXmlText = new XmlBeautify().beautify(srcXmlText, 
    {
        indent: "  ",  //indent pattern like white spaces
        useSelfClosingElement: true //true:use self-closing element when empty element.
    });

Example of result

[BEFORE] source XML

<?xml version="1.0" encoding="utf-8"?><example version="2.0">
  <head>
    <title>Original Title</title>
  </head>
  <body>
    <element message="Greeting" title="Chapter1">
      <element message="We say good morning in the morning."></element><element message="We say hello at noon."/>
      <element message="We say good evening at night."/>
    </element>
    <element message="Thank" title="Chapter2">
      <element>value</element>
      <element></element><foo><![CDATA[ < > & ]]></foo>
    </element>
  </body>
</example>

[AFTER] beautified XML

<?xml version="1.0" encoding="utf-8"?>
<example version="2.0">
  <head>
    <title>Original Title</title>
  </head>
  <body>
    <element message="Greeting" title="Chapter1">
      <element message="We say good morning in the morning." />
      <element message="We say hello at noon." />
      <element message="We say good evening at night." />
    </element>
    <element message="Thank" title="Chapter2">
      <element>value</element>
      <element />
      <foo><![CDATA[ < > & ]]></foo>
    </element>
  </body>
</example>

Install

install via npm

npm install xml-beautify

use from CDN

<script src="https://cdn.jsdelivr.net/npm/xml-beautify@1.2.1/dist/XmlBeautify.js"></script>

Demo

demo on the web

https://riversun.github.io/xml-beautify/index.html

demo on node.js

clone this project and type

git clone https://github.com/riversun/xml-beautify.git
npm start

Run on Browser

<!DOCTYPE html>
<html lang="en">
<body>
<script src="https://cdn.jsdelivr.net/npm/xml-beautify@1.2.1/dist/XmlBeautify.js"></script>
<script>
  const srcXmlText = `<?xml version="1.0" encoding="utf-8"?><example version="2.0">
  <head>
    <title>Original Title</title>
  </head>
  <body>
    <element message="Greeting" title="Chapter1">
      <element message="We say good morning in the morning."></element><element message="We say hello at noon."/>
      <element message="We say good evening at night."/>
    </element>
    <element message="Thank" title="Chapter2">
      <element>value</element>
      <element></element>
    </element>
  </body>
</example>`;

  const beautifiedXmlText = new XmlBeautify().beautify(srcXmlText);
  console.log(beautifiedXmlText);


</script>
</body>
</html>

Run on Node.js

To run XmlBeautify on node.js, need to install an external DOMParser like as follows.

npm install xmldom

And specify it as follows,

new XmlBeautify({ parser: DOMParser })

Example for Node.js

const XmlBeautify = require('xml-beautify');
const { DOMParser } = require('xmldom');// When used in a node.js environment, DOMParser is needed.
const srcXmlText = `<?xml version="1.0" encoding="utf-8"?><example version="2.0">
  <head>
    <title>Original Title</title>
  </head>
  <body>
    <element message="Greeting" title="Chapter1">
      <element message="We say good morning in the morning."></element><element message="We say hello at noon."/>
      <element message="We say good evening at night."/>
    </element>
    <element message="Thank" title="Chapter2">
      <element>value</element>
      <element></element>
    </element>
  </body>
</example>`;

const beautifiedXmlText = new XmlBeautify({ parser: DOMParser }).beautify(srcXmlText);
console.log(beautifiedXmlText);

Keywords

FAQs

What is xml-beautify?

Is xml-beautify popular?

Is xml-beautify well maintained?

Package last updated on 15 Apr 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install