jsonc-morph 0.1.0 → 0.2.0

package/README.md

@@ -3,39 +3,56 @@
 [![JSR](https://jsr.io/badges/@david/jsonc-morph)](https://jsr.io/@david/jsonc-morph)
 [![npm version](https://badge.fury.io/js/jsonc-morph.svg)](https://badge.fury.io/js/jsonc-morph)
 
+Programmatically edit JSONC in JavaScript.
+
+This is especially useful for making programmatic changes to JSON config files.
+It's not recommended for very large files as this is using
+[jsonc-parser](https://github.com/dprint/jsonc-parser/) via Wasm under the hood.
+
+## Install
+
+Deno:
+
 ```
-# deno
-> deno add @jsr:@david/jsonc-morph
-# npm
-> npm install jsonc-morph
+deno add @jsr:@david/jsonc-morph
 ```
 
-Programmatically edit JSONC files.
+Or with npm:
 
-This is especially useful for user maintained config files that you need to make
-programmatic changes to.
+```
+npm install jsonc-morph
+```
 
 ## Example
 
 ```ts
-import { CstRootNode } from "@david/jsonc-morph";
+import { parse } from "@david/jsonc-morph";
+
+const root = parse(`{
+  // 1
+  "data" /* 2 */: 123 // 3
+} // 4`);
+
+// get the root object
+const rootObj = root.asObjectOrThrow();
 
-const root = CstRootNode.parse(`{
-  // comment
-  "data": 123
-}`);
-let rootObj = root.objectValueOrSet();
+// set its "data" property to have a new value
 rootObj.getOrThrow("data").setValue({
   "nested": true,
 });
+
+// append a new key
 rootObj.append("new_key", [456, 789, false]);
-const output = root.toString();
-// {
-//   // comment
-//   "data": {
-//     "nested": true
-//   },
-//   "new_key": [456, 789, false]
-// }
-console.log(output);
+
+// inspect the output
+assertEquals(
+  root.toString(),
+  `{
+  // 1
+  "data" /* 2 */: {
+    "nested": true
+  }, // 3
+  "new_key": [456, 789, false]
+} // 4`,
+);
 ```