xml-disassembler 1.6.0 → 1.7.0

package/CHANGELOG.md

@@ -5,6 +5,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.7.0](https://github.com/mcarvin8/xml-disassembler/compare/v1.6.0...v1.7.0) (2025-04-12)
+
+
+### Features
+
+* add ini as a disassembled format ([de91154](https://github.com/mcarvin8/xml-disassembler/commit/de9115481b3b19e53e5e72339082e63cbd83e337))
+
 ## [1.6.0](https://github.com/mcarvin8/xml-disassembler/compare/v1.5.1...v1.6.0) (2025-04-12)
 
 

package/README.md

@@ -2,7 +2,7 @@
 
 [![NPM](https://img.shields.io/npm/v/xml-disassembler.svg?label=xml-disassembler)](https://www.npmjs.com/package/xml-disassembler) [![Downloads/week](https://img.shields.io/npm/dw/xml-disassembler.svg)](https://npmjs.org/package/xml-disassembler)
 
-Disassemble XML files into smaller, more manageable files (XML/JSON/JSON5/TOML/YAML) and reassemble the XML when needed.
+Disassemble XML files into smaller, more manageable files (XML/INI/JSON/JSON5/TOML/YAML) and reassemble the XML when needed.
 
 This tool simplifies version control, improves diff readability, and streamlines collaboration when dealing with large XML files.
 
@@ -12,12 +12,12 @@ This tool simplifies version control, improves diff readability, and streamlines
 
 - **Disassemble XML Files** – Break down XML files into structured directories.
 - **Reassemble XML Files** – Recreate the original XML structure from disassembled parts.
-  > **NOTE**: The `xml-disassembler` aims to reassemble the original XML 100% element-wise, however, the element sorting will vary. The reassembler will sort elements based on how they are sorted in the disassembled directories.
+  > **NOTE**: The `xml-disassembler` aims to reassemble the original XML 100% element-wise, however, the element sorting will vary. The reassembler will sort elements based on how they are sorted in the disassembled directories. "toml" format sorting varies compared to the other formats.
 - **Unique Identifiers** – Use specific XML elements as file names or fallback to SHA-256 hashes.
 - **Ignore Files** – Specify XML files to exclude from disassembly.
 - **Logging** – Enable detailed debugging logs.
 - **Integrations** – Works with tools like Salesforce CLI
-- **Multiple Formats** - The disassembled file format can be XML, JSON, JSON5, TOML, or YAML based on preference. The reassembler will reassemble the original XML structure from these formats.
+- **Multiple Formats** - The disassembled file format can be XML, INI, JSON, JSON5, TOML, or YAML based on preference. The reassembler will reassemble the original XML structure from these formats.
 
 <!-- TABLE OF CONTENTS -->
 <details>
@@ -53,7 +53,7 @@ npm install xml-disassembler
 
 ## Disassembling Files
 
-Disassemble a single XML file or multiple XML files within a directory into smaller files (XML/JSON/JSON5/TOML/YAML).
+Disassemble a single XML file or multiple XML files within a directory into smaller files (XML/INI/JSON/JSON5/TOML/YAML).
 
 ```typescript
 /* 
@@ -65,7 +65,7 @@ FLAGS
 - postPurge:        Delete the XML file after disassembling it.
 
 - ignorePath:       Path to an XML disassembly ignore file.
-- format:           File format for the disassembled files ("xml", "json", "json5", "toml", "yaml")
+- format:           File format for the disassembled files ("xml", "ini", "json", "json5", "toml", "yaml")
                     Defaults to "xml" if the format isn't supported or provided.
 */
 import { DisassembleXMLFileHandler } from "xml-disassembler";
@@ -84,7 +84,7 @@ await handler.disassemble({
 
 ## Reassembling Files
 
-Reassemble a directory of disassembled files (XML/JSON/JSON5/TOML/YAML) into a single XML file.
+Reassemble a directory of disassembled files (XML/INI/JSON/JSON5/TOML/YAML) into a single XML file.
 
 ```typescript
 /* 
@@ -164,6 +164,7 @@ await handler.reassemble({
 | **JSON**  | ![JSON UID](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-json.png)<br>   | ![JSON Hash](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-hashes-json.png)<br>   |
 | **JSON5** | ![JSON5 UID](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-json5.png)<br> | ![JSON5 Hash](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-hashes-json5.png)<br> |
 | **TOML**  | ![TOML UID](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-toml.png)<br>   | ![TOML Hash](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-hashes-toml.png)<br>   |
+| **INI**   | ![INI UID](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-ini.png)<br>     | ![INI Hash](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-hashes-ini.png)<br>     |
 
 ## Use Case