xml-to-sorted-json

🚀 A simple CLI tool that converts XML to JSON and sorts the properties alphabetically for deterministic comparison.

Features

✅ Converts XML to JSON
✅ Sorts object keys alphabetically
✅ Works with nested structures
✅ Automatic output file naming (if no output file is specified)
✅ Easy-to-use CLI

📥 Installation

Global Install (Recommended)

npm install -g xml-to-sorted-json

Local Install (for project usage)

npm install --save-dev xml-to-sorted-json

🚀 Usage

Basic CLI Usage

xml-to-sorted-json <input.xml> [output.json]

Examples

1️⃣ Convert XML to JSON (Automatic Output Name)

xml-to-sorted-json myfile.xml

✅ This will create myfile.json in the same directory.

2️⃣ Convert XML to JSON (Custom Output Name)

xml-to-sorted-json input.xml output.json

✅ This will save the sorted JSON as output.json.

3️⃣ Prevents Overwriting the Input File

xml-to-sorted-json myfile.xml myfile.xml

❌ Error: Prevents overwriting myfile.xml with JSON.

Example Input (input.xml)

<root>
    <b>2</b>
    <a>
        <z>9</z>
        <y>8</y>
    </a>
    <c>
        <d>4</d>
        <a>1</a>
    </c>
</root>

Example Output (input.json)

{
  "root": {
    "a": {
      "y": 8,
      "z": 9
    },
    "b": 2,
    "c": {
      "a": 1,
      "d": 4
    }
  }
}

🛠 Development

Clone the Repository

git clone https://github.com/yourusername/xml-to-sorted-json.git
cd xml-to-sorted-json

Install Dependencies

npm install

Build the Project

npm run build

Run Locally

node dist/index.js input.xml output.json

🏗 Contributing

1. Fork the repo
2. Create a new branch (feature/your-feature)
3. Commit your changes
4. Push to your fork
5. Create a Pull Request

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

🌟 Like this project? Give it a star! ⭐