xml-disassembler 1.8.0 → 1.9.1

package/CHANGELOG.md

@@ -5,6 +5,21 @@
 
 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.9.1](https://github.com/mcarvin8/xml-disassembler/compare/v1.9.0...v1.9.1) (2025-05-06)
+
+
+### Bug Fixes
+
+* **deps:** bump ignore from 7.0.3 to 7.0.4 ([95cf6d1](https://github.com/mcarvin8/xml-disassembler/commit/95cf6d10212bd8105b27285574cdb1c190c42e75))
+* **deps:** bump smol-toml from 1.3.1 to 1.3.4 ([0e40592](https://github.com/mcarvin8/xml-disassembler/commit/0e40592ff81d99378d60708345d467c9002d26e3))
+
+## [1.9.0](https://github.com/mcarvin8/xml-disassembler/compare/v1.8.0...v1.9.0) (2025-04-21)
+
+
+### Features
+
+* export the transformers ([46ad06b](https://github.com/mcarvin8/xml-disassembler/commit/46ad06b2b7b4e96c4b69f5b23db72198973de5d5))
+
 ## [1.8.0](https://github.com/mcarvin8/xml-disassembler/compare/v1.7.0...v1.8.0) (2025-04-18)
 
 

package/README.md

@@ -13,7 +13,7 @@ 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. "toml" format sorting varies compared to the other formats.
-- **Unique Identifiers** – Use specific XML elements as file names or fallback to SHA-256 hashes.
+- **Multiple Disassembly Strategies** – Provides 2 strategies to disassemble an XML file.
 - **Ignore Files** – Specify XML files to exclude from disassembly.
 - **Logging** – Enable detailed debugging logs.
 - **Integrations** – Works with tools like Salesforce CLI
@@ -27,6 +27,8 @@ This tool simplifies version control, improves diff readability, and streamlines
 - [Install](#install)
 - [Disassembling Files](#disassembling-files)
 - [Disassembly Strategies](#disassembly-strategies)
+  - [unique-id (default)](#unique-id-default)
+  - [grouped-by-tag](#grouped-by-tag)
 - [Reassembling Files](#reassembling-files)
 - [Use Case](#use-case)
 - [Ignore File](#ignore-file)
@@ -89,7 +91,7 @@ await handler.disassemble({
 
 `xml-disassembler` supports two disassembly strategies to suit different use cases for nested elements. You can choose a strategy by setting the strategy option when calling disassemble().
 
-🔹 unique-id (default)
+### unique-id (default)
 
 > This is the strategy all previous versions of the `xml-disassembler` follow.
 
@@ -103,7 +105,7 @@ Best for maximum diff granularity and precision in version control.
 
 **Disassembled Directory Samples for Unique IDs**
 
-| Format    | Unique ID Elements                                                                                                       | SHA-256 Hashes                                                                                                                   |
+| Format    | Sample Directory - UIDs                                                                                                       | Sample Directory - SHA-256 Hashes                                                                                                                   |
 | --------- | ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
 | **XML**   | ![XML UID](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled.png)<br>         | ![XML Hash](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-hashes.png)<br>         |
 | **YAML**  | ![YAML UID](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-yaml.png)<br>   | ![YAML Hash](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-hashes-yaml.png)<br>   |
@@ -112,7 +114,7 @@ Best for maximum diff granularity and precision in version control.
 | **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>     |
 
-🔸 grouped-by-tag
+### grouped-by-tag
 
 Groups all nested elements by tag name into a single file (e.g., all `<fieldPermissions>` into `fieldPermissions.xml`).
 
@@ -122,7 +124,7 @@ Useful for simplifying diff views and reducing file count in large projects.
 
 **Disassembled Directory Samples for Grouped by Tag**
 
-| Format    | Unique ID Elements                                                                                                            |
+| Format    | Sample Directory                                                                                                            |
 | --------- | ----------------------------------------------------------------------------------------------------------------------------- |
 | **XML**   | ![XML tag](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-tags.png)<br>         |
 | **YAML**  | ![YAML tag](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-tags-yaml.png)<br>   |
@@ -155,10 +157,7 @@ await handler.reassemble({
 
 ## Use Case
 
-See [`sf-decomposer`](https://github.com/mcarvin8/sf-decomposer) for a Salesforce CLI use case:
-
-- [Disassemble Use Case](https://github.com/mcarvin8/sf-decomposer/blob/main/src/service/decomposeFileHandler.ts)
-- [Reassemble Use Case](https://github.com/mcarvin8/sf-decomposer/blob/main/src/service/recomposeFileHandler.ts)
+See [`sf-decomposer`](https://github.com/mcarvin8/sf-decomposer) for a Salesforce CLI use case.
 
 ## Ignore File
 
@@ -173,7 +172,6 @@ Uses [`fast-xml-parser`](https://github.com/NaturalIntelligence/fast-xml-parser)
 - Character Data (CDATA): `"![CDATA["`
 - Comments: `"!---"`
 - Attributes: `"@__**"`
-- XML Declaration Attributes
 
 ## Logging