@osdlc/yaml-splice 0.0.1-stage → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## 0.1.4
+
+### Patch Changes
+
+- fa792c7: The first release on npm. Versions 0.1.0 to 0.1.3 were used only during development and were never published. It edits top-level fields of a YAML mapping in place, on bytes: set, remove or rename a field, and every byte outside the edited span stays as it was, including comments, key order, quoting, a BOM and line endings. It runs the `yaml-splice` Rust crate through WebAssembly, so it has no runtime dependencies and no native code.
+  
+  - `editYaml(source, edits)` applies a batch of `FieldEdit`s (`Set`, `Remove`, `Rename`) in order and returns an `EditOutcome` (`bytes` and `changed`). The batch is atomic: a refused edit throws an `EditError` with an `EditErrorCode` and, where known, an `EditSpan`, and nothing is returned.
+  - Keys match case-insensitively.
+  
+  Fixed since the last development version:
+  
+  - `Set` on a quoted value with a comment after it (`title: 'Draft'  # note`) no longer deletes the comment.
+  - `Set` on a block scalar (`|` or `>`) no longer joins the next key onto the new value's line, and `Remove` on one no longer deletes the next line too.
+  - A comment indented less than a block scalar is kept: `Set` no longer joins it onto the new value's line, and `Remove` no longer deletes it.
+  - An empty block scalar (`a: |`, also with a tag or an anchor) can now be set and removed. Both were refused.
+  - When a new value is written as a block, the old value's trailing comment moves to the block's header line instead of becoming part of the value.
+  - A keep-chomped (`|+`) value keeps its trailing line breaks: setting `"kept\n\n"` no longer writes `"kept\n"`.
+  - `editYaml` checks each edit against what it asked for. It throws `EditError('InvalidResult', …)` when an edit would change the value or order of a key it does not address, or when the addressed key would not read back as set, removed or renamed. Before, it returned that document. A `.nan` value in another key no longer counts as a change.
+  
+  All seven exports are stable. Node.js 22 or later and Bun; no browser or bundler build yet. Shipped as compiled JavaScript with type declarations. Tested on Linux and macOS. Licensed `MIT OR Apache-2.0`.
+
 ## History before the first public release
 
 These versions were developed in a private repository before the package moved here, and

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdlc/yaml-splice",
-  "version": "0.0.1-stage",
+  "version": "0.1.4",
   "description": "Edit top-level fields of a YAML mapping in place, on bytes: set, remove or rename a field, and every byte outside the edited span stays as it was, including comments, key order, quoting, a BOM and line endings. The yaml-splice Rust crate, built to WebAssembly. Node.js and Bun.",
   "license": "MIT OR Apache-2.0",
   "author": "sksizer",