xml-disassembler 1.9.0 → 1.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +8 -10
  3. package/disassemble.log +556 -294
  4. package/dist/index.cjs +31 -12
  5. package/dist/index.cjs.map +1 -1
  6. package/dist/index.min.cjs +1 -1
  7. package/dist/index.min.cjs.map +1 -1
  8. package/dist/index.min.mjs +1 -1
  9. package/dist/index.min.mjs.map +1 -1
  10. package/dist/index.min.umd.js +1 -1
  11. package/dist/index.min.umd.js.map +1 -1
  12. package/dist/index.mjs +31 -12
  13. package/dist/index.mjs.map +1 -1
  14. package/dist/index.umd.js +31 -12
  15. package/dist/index.umd.js.map +1 -1
  16. package/dist/typings/builders/buildXMLString.d.ts +1 -1
  17. package/dist/typings/parsers/stripWhitespace.d.ts +1 -0
  18. package/package.json +6 -6
package/CHANGELOG.md CHANGED
@@ -5,6 +5,22 @@
5
5
 
6
6
  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.
7
7
 
8
+ ## [1.9.2](https://github.com/mcarvin8/xml-disassembler/compare/v1.9.1...v1.9.2) (2025-05-07)
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * remove extra indenting ([f30b7b6](https://github.com/mcarvin8/xml-disassembler/commit/f30b7b6c8b2a70f97634542e245f8030f4ea5dd8))
14
+ * update xml parser options ([c0420c0](https://github.com/mcarvin8/xml-disassembler/commit/c0420c0335a33f4914d1cfad4e8372d54bc627ab))
15
+
16
+ ## [1.9.1](https://github.com/mcarvin8/xml-disassembler/compare/v1.9.0...v1.9.1) (2025-05-06)
17
+
18
+
19
+ ### Bug Fixes
20
+
21
+ * **deps:** bump ignore from 7.0.3 to 7.0.4 ([95cf6d1](https://github.com/mcarvin8/xml-disassembler/commit/95cf6d10212bd8105b27285574cdb1c190c42e75))
22
+ * **deps:** bump smol-toml from 1.3.1 to 1.3.4 ([0e40592](https://github.com/mcarvin8/xml-disassembler/commit/0e40592ff81d99378d60708345d467c9002d26e3))
23
+
8
24
  ## [1.9.0](https://github.com/mcarvin8/xml-disassembler/compare/v1.8.0...v1.9.0) (2025-04-21)
9
25
 
10
26
 
package/README.md CHANGED
@@ -13,7 +13,7 @@ This tool simplifies version control, improves diff readability, and streamlines
13
13
  - **Disassemble XML Files** – Break down XML files into structured directories.
14
14
  - **Reassemble XML Files** – Recreate the original XML structure from disassembled parts.
15
15
  > **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.
16
- - **Unique Identifiers** – Use specific XML elements as file names or fallback to SHA-256 hashes.
16
+ - **Multiple Disassembly Strategies** – Provides 2 strategies to disassemble an XML file.
17
17
  - **Ignore Files** – Specify XML files to exclude from disassembly.
18
18
  - **Logging** – Enable detailed debugging logs.
19
19
  - **Integrations** – Works with tools like Salesforce CLI
@@ -27,6 +27,8 @@ This tool simplifies version control, improves diff readability, and streamlines
27
27
  - [Install](#install)
28
28
  - [Disassembling Files](#disassembling-files)
29
29
  - [Disassembly Strategies](#disassembly-strategies)
30
+ - [unique-id (default)](#unique-id-default)
31
+ - [grouped-by-tag](#grouped-by-tag)
30
32
  - [Reassembling Files](#reassembling-files)
31
33
  - [Use Case](#use-case)
32
34
  - [Ignore File](#ignore-file)
@@ -89,7 +91,7 @@ await handler.disassemble({
89
91
 
90
92
  `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().
91
93
 
92
- 🔹 unique-id (default)
94
+ ### unique-id (default)
93
95
 
94
96
  > This is the strategy all previous versions of the `xml-disassembler` follow.
95
97
 
@@ -103,7 +105,7 @@ Best for maximum diff granularity and precision in version control.
103
105
 
104
106
  **Disassembled Directory Samples for Unique IDs**
105
107
 
106
- | Format | Unique ID Elements | SHA-256 Hashes |
108
+ | Format | Sample Directory - UIDs | Sample Directory - SHA-256 Hashes |
107
109
  | --------- | ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
108
110
  | **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> |
109
111
  | **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.
112
114
  | **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> |
113
115
  | **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> |
114
116
 
115
- 🔸 grouped-by-tag
117
+ ### grouped-by-tag
116
118
 
117
119
  Groups all nested elements by tag name into a single file (e.g., all `<fieldPermissions>` into `fieldPermissions.xml`).
118
120
 
@@ -122,7 +124,7 @@ Useful for simplifying diff views and reducing file count in large projects.
122
124
 
123
125
  **Disassembled Directory Samples for Grouped by Tag**
124
126
 
125
- | Format | Unique ID Elements |
127
+ | Format | Sample Directory |
126
128
  | --------- | ----------------------------------------------------------------------------------------------------------------------------- |
127
129
  | **XML** | ![XML tag](https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-tags.png)<br> |
128
130
  | **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({
155
157
 
156
158
  ## Use Case
157
159
 
158
- See [`sf-decomposer`](https://github.com/mcarvin8/sf-decomposer) for a Salesforce CLI use case:
159
-
160
- - [Disassemble Use Case](https://github.com/mcarvin8/sf-decomposer/blob/main/src/service/decomposeFileHandler.ts)
161
- - [Reassemble Use Case](https://github.com/mcarvin8/sf-decomposer/blob/main/src/service/recomposeFileHandler.ts)
160
+ See [`sf-decomposer`](https://github.com/mcarvin8/sf-decomposer) for a Salesforce CLI use case.
162
161
 
163
162
  ## Ignore File
164
163
 
@@ -173,7 +172,6 @@ Uses [`fast-xml-parser`](https://github.com/NaturalIntelligence/fast-xml-parser)
173
172
  - Character Data (CDATA): `"![CDATA["`
174
173
  - Comments: `"!---"`
175
174
  - Attributes: `"@__**"`
176
- - XML Declaration Attributes
177
175
 
178
176
  ## Logging
179
177