xml-disassembler 1.5.0 → 1.6.0

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 (17) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +13 -39
  3. package/disassemble.log +179 -158
  4. package/dist/index.cjs +16 -1
  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 +20 -5
  13. package/dist/index.mjs.map +1 -1
  14. package/dist/index.umd.js +19 -5
  15. package/dist/index.umd.js.map +1 -1
  16. package/dist/typings/transformers/transformers.d.ts +1 -0
  17. package/package.json +12 -3
package/CHANGELOG.md CHANGED
@@ -5,6 +5,20 @@
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.6.0](https://github.com/mcarvin8/xml-disassembler/compare/v1.5.1...v1.6.0) (2025-04-12)
9
+
10
+
11
+ ### Features
12
+
13
+ * add toml as a disassembled format ([9d0e6b8](https://github.com/mcarvin8/xml-disassembler/commit/9d0e6b8a314720d372ccc3b40152c201f2b37314))
14
+
15
+ ## [1.5.1](https://github.com/mcarvin8/xml-disassembler/compare/v1.5.0...v1.5.1) (2025-04-11)
16
+
17
+
18
+ ### Bug Fixes
19
+
20
+ * upgrade fast-xml-parser ([bae93c6](https://github.com/mcarvin8/xml-disassembler/commit/bae93c671e96bb3df05d04e8a3eac08ef3491a8d))
21
+
8
22
  ## [1.5.0](https://github.com/mcarvin8/xml-disassembler/compare/v1.4.0...v1.5.0) (2025-04-11)
9
23
 
10
24
 
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [![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)
4
4
 
5
- Disassemble XML files into smaller, more manageable files (XML/JSON/JSON5/YAML) and reassemble the XML when needed.
5
+ Disassemble XML files into smaller, more manageable files (XML/JSON/JSON5/TOML/YAML) and reassemble the XML when needed.
6
6
 
7
7
  This tool simplifies version control, improves diff readability, and streamlines collaboration when dealing with large XML files.
8
8
 
@@ -17,7 +17,7 @@ This tool simplifies version control, improves diff readability, and streamlines
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
20
- - **Multiple Formats** - The disassembled file format can be XML, JSON, JSON5, or YAML based on preference. The reassembler will reassemble the original XML structure from these formats.
20
+ - **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.
21
21
 
22
22
  <!-- TABLE OF CONTENTS -->
23
23
  <details>
@@ -53,7 +53,7 @@ npm install xml-disassembler
53
53
 
54
54
  ## Disassembling Files
55
55
 
56
- Disassemble a single XML file or multiple XML files within a directory into smaller files (XML/JSON/JSON5/YAML).
56
+ Disassemble a single XML file or multiple XML files within a directory into smaller files (XML/JSON/JSON5/TOML/YAML).
57
57
 
58
58
  ```typescript
59
59
  /*
@@ -65,7 +65,7 @@ FLAGS
65
65
  - postPurge: Delete the XML file after disassembling it.
66
66
 
67
67
  - ignorePath: Path to an XML disassembly ignore file.
68
- - format: File format for the disassembled files ("xml", "json", "json5", "yaml")
68
+ - format: File format for the disassembled files ("xml", "json", "json5", "toml", "yaml")
69
69
  Defaults to "xml" if the format isn't supported or provided.
70
70
  */
71
71
  import { DisassembleXMLFileHandler } from "xml-disassembler";
@@ -84,7 +84,7 @@ await handler.disassemble({
84
84
 
85
85
  ## Reassembling Files
86
86
 
87
- Reassemble a directory of disassembled files (XML/JSON/JSON5/YAML) into a single XML file.
87
+ Reassemble a directory of disassembled files (XML/JSON/JSON5/TOML/YAML) into a single XML file.
88
88
 
89
89
  ```typescript
90
90
  /*
@@ -155,41 +155,15 @@ await handler.reassemble({
155
155
  </PermissionSet>
156
156
  ```
157
157
 
158
- **Disassembled XML Directory**
158
+ **Disassembled Directory Samples**
159
159
 
160
- <img src="https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled.png">
161
- <p><em>Disassembled XML files using unique ID elements</em></p>
162
- <br>
163
-
164
- <img src="https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-hashes.png">
165
- <p><em>Disassembled XML files using SHA-256 hashes</em></p>
166
-
167
- **Disassembled YAML Directory**
168
-
169
- <img src="https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-yaml.png">
170
- <p><em>Disassembled YAML files using unique ID elements</em></p>
171
- <br>
172
-
173
- <img src="https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-hashes-yaml.png">
174
- <p><em>Disassembled YAML files using SHA-256 hashes</em></p>
175
-
176
- **Disassembled JSON Directory**
177
-
178
- <img src="https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-json.png">
179
- <p><em>Disassembled JSON files using unique ID elements</em></p>
180
- <br>
181
-
182
- <img src="https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-hashes-json.png">
183
- <p><em>Disassembled JSON files using SHA-256 hashes</em></p>
184
-
185
- **Disassembled JSON5 Directory**
186
-
187
- <img src="https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-json5.png">
188
- <p><em>Disassembled JSON5 files using unique ID elements</em></p>
189
- <br>
190
-
191
- <img src="https://raw.githubusercontent.com/mcarvin8/xml-disassembler/main/.github/images/disassembled-hashes-json5.png">
192
- <p><em>Disassembled JSON5 files using SHA-256 hashes</em></p>
160
+ | Format | Unique ID Elements | SHA-256 Hashes |
161
+ | --------- | ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
162
+ | **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> |
163
+ | **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> |
164
+ | **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> |
165
+ | **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> |
166
+ | **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> |
193
167
 
194
168
  ## Use Case
195
169