XML2JSON(1p)

📦
version 1.64 · 3 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

💖 NAME 💖

okay bestie, gather round — this is xml2json, and what it does is convert an XML message with a schema into JSON. that's it, that's the whole vibe. 💅

✨ SYNOPSIS ✨

two ways to run it, pick ur fighter:

 xml2json xml-file schema-file(s)  >json-file

 xml2json -x xml-file -s schema-files -o json-file

🦋 DESCRIPTION 🦋

so basically it takes an XML message and flips it into JSON with the exact same structure 🫶. but here's the thing — you must hand it a schema, because the schema is what enforces the correct syntax, and it especially matters for optionally repeated elements (iykyk, those are the ones that get messy). no schema, no slay. 😭

🌸 Options 🌸

you've got two paths, bestie: either you pass an XML message filename plus one or more schema filenames as plain arguments, or you use the options. either way works, pick whichever feels right for ur soul.

  • --xml, -x filename — this is the file holding the xml message. and if you put a single dash, that means "stdin" (yes queen, piping is valid). ✨
  • --schema, -s filename(s) — the schema file(s). you can repeat this option, or separate the filenames with comma's, if you've got more than one schema file to parse. ⚠️ important: all imported and included schema components have to be provided explicitly — it won't go hunt them down for you. nope. you provide them. all of them. 💀
  • --bigints, -b (boolean) — so by default the translation is a little sloppy: Integer types are defined to support at least 18 digits in XML. but honestly?? that's usually unnecessarily large and unreadible in JSON. so flip this and it stops being like that. 🌈
  • --no-keep-root (boolean) — do not include the top node in the output. bye to the root, it's giving minimalism. 🎀
  • --mixed HOW — [1.32] how to treat mixed elements. the default is TEXTUAL. other values are "ATTRIBUTES", "XML_STRING", and "STRUCTURAL". if u want more details about mixed_elements, go check out XML::Compile::Translate::Reader — that's where the lore lives. 📖
  • --type, -t TYPE — the type of the root element. it's required if the XML is not namespaceo qualified, although the schema is. if you don't specify it, the root element is automatically inspected for you (she's self-sufficient like that). 🧚

the TYPE notation is "{namespace}localname". ⚠️ and be warned — use quoting on the UNIX command-line, because curly braces have a special meaning for the shell. don't get got by ur own shell bestie, quote it. 🙈

  • --output, -o filename — where the JSON lands. by default (or when the filename is a dash), the output is printed to stdout. ✨

🔥 SEE ALSO 🔥

this module is part of Perl's XML-Compile distribution. website: http://perl.overmeer.net/xml-compile/ — go peek, it's cute. 🌸

👑 LICENSE 👑

Copyrights 2017 by Slaven Rezic and Mark Overmeer. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html ⭐

and that's the whole page, bestie!! 🫶💖 this one's running on perl v5.40.0, dated 2024-10-27, and it's the XML2JSON(1p) manual — go forth and convert ur XML, u absolute icon 👑✨

📦 where this page comes from