Support for KDL 2.0

.github/workflows/gh-pages.yml

@@ -4,24 +4,24 @@ on:
   workflow_dispatch:
   push:
     tags:
-    - '*'
+      - '*'
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           submodules: true
           fetch-depth: 0
 
       - name: Setup Node
-        uses: actions/setup-node@v2.1.2
+        uses: actions/setup-node@v4
         with:
-          node-version: '18.x'
+          node-version: '20.x'
 
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.npm
           key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.github/workflows/node.js.yml

@@ -1,6 +1,3 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
 name: Node.js CI
 
 on:
@@ -16,14 +13,14 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x, 22.x]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         submodules: true
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm ci

.gitmodules

@@ -1,6 +1,3 @@
-[submodule "test/kdl4j"]
-	path = test/kdl4j
-	url = https://github.com/hkolbeck/kdl4j
 [submodule "test/kdl-official"]
 	path = test/kdl-official
 	url = https://github.com/kdl-org/kdl

.jsdoc.json

@@ -0,0 +1,28 @@
+{
+  "plugins": ["plugins/markdown"],
+  "markdown": {
+    "idInHeadings": true
+  },
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc", "closure"]
+  },
+  "source": {
+    "include": [
+      "src",
+      "src/parser"
+    ]
+  },
+  "opts": {
+    "destination": "./docs/0.2/",
+    "encoding": "utf8",
+    "readme": "./README.md"
+  },
+  "templates": {
+    "default": {
+      "includeDate": true
+    },
+    "cleverLinks": false,
+    "monospaceLinks": false
+  }
+}

CHANGELOG.md

@@ -122,6 +122,9 @@
 # [0.1.0-rc.0](https://github.com/kdl-org/kdljs/compare/v0.0.3...v0.1.0-rc.0) (2021-08-31)
 
 
+* feat(formatter)!: support KDL serialization ([4c4c94e](https://github.com/kdl-org/kdljs/commit/4c4c94edb14c2867f539288033f0edca97a15410))
+
+
 ### Bug Fixes
 
 * **parser:** allow raw strings as identifiers ([8cea257](https://github.com/kdl-org/kdljs/commit/8cea257261caaf9313303b2f2b1bf0e166ece08b))
@@ -131,9 +134,6 @@
 * **ts:** update types ([3049abe](https://github.com/kdl-org/kdljs/commit/3049abe46343cea4f2c091ef9426573d75771668))
 
 
-* feat(formatter)!: support KDL serialization ([4c4c94e](https://github.com/kdl-org/kdljs/commit/4c4c94edb14c2867f539288033f0edca97a15410))
-
-
 ### Features
 
 * **formatter:** support same output options as kdl4j ([d37df28](https://github.com/kdl-org/kdljs/commit/d37df287cf99a9628e37a14f8e6c35cb7cac5632))

README.md

@@ -54,7 +54,7 @@ smile "😁"
 parse(`
 // Instead of anonymous nodes, nodes and properties can be wrapped
 // in "" for arbitrary node names.
-"!@#$@$%Q#$%~@!40" "1.2.3" "!!!!!"=true
+"!@#$@$%Q#$%~@!40" "1.2.3" "!!!!!"=#true
 `)
 
 // [
@@ -73,15 +73,15 @@ parse(`
 
 parse(`
 // The following is a legal bare identifier:
-foo123~!@#$%^&*.:'|/?+ "weeee"
+foo123~!@$%^&*.:'|?+ "weeee"
 
 // And you can also use unicode!
-ノード お名前＝"☜(ﾟヮﾟ☜)"
+ノード お名前="☜(ﾟヮﾟ☜)"
 `)
 
 // [
 //   {
-//     name: "foo123~!@#$%^&*.:'|/?+",
+//     name: "foo123~!@$%^&*.:'|?+",
 //     properties: {},
 //     values: [ 'weeee' ],
 //     children: [],
@@ -107,7 +107,7 @@ foo123~!@#$%^&*.:'|/?+ "weeee"
 parse(`
 // kdl specifically allows properties and values to be
 // interspersed with each other, much like CLI commands.
-foo bar=true "baz" quux=false 1 2 3
+foo bar=#true "baz" quux=#false 1 2 3
 `)
 
 // [
@@ -131,6 +131,7 @@ package {
   (author)person contact=(email)"example@example.org"
   (contributor)person homepage=(url)"https://example.org/example"
 }
+`)
 
 // [
 //   {
@@ -160,10 +161,10 @@ package {
 //           values: []
 //         }
 //       }
-//     ]
+//     ],
+//     tags: { name: undefined, properties: {}, values: [] }
 //   }
 // ]
-`)
 ```
 
 ### Querying
@@ -178,12 +179,12 @@ const { output: document } = parse(`package {
         winapi "1.0.0" path="./crates/my-winapi-fork"
     }
     dependencies {
-        miette "2.0.0" dev=true
+        miette "2.0.0" dev=#true
     }
 }`)
 
-query(document, 'package name') // or
-query(document, 'top() > package name')
+query(document, 'package >> name') // or
+query(document, 'top() > package >> name')
 
 // [
 //   {
@@ -238,7 +239,7 @@ query(document, 'dependencies > []')
 // MAP OPERATOR
 // ============
 
-query(document, 'package name => val()')
+query(document, 'package >> name => val()')
 // ['foo'].
 
 query(document, 'dependencies[platform] => platform')

index.d.ts

@@ -31,9 +31,9 @@ export type Value = string | number | boolean | null;
  */
 export interface NodeTypeAnnotations {
   /** The type annotation of the Node */
-  name: string;
+  name: string|undefined;
   /** The type annotations of the {@link https://github.com/kdl-org/kdl/blob/main/SPEC.md#argument|Arguments} */
-  values: string[];
+  values: Array<string|undefined>;
   /** The type annotations of the {@link https://github.com/kdl-org/kdl/blob/main/SPEC.md#property|Properties} */
   properties: Record<string, string>;
 }
@@ -64,6 +64,7 @@ export interface FormattingOptions {
   indent?: number;
   indentChar?: string;
   exponentChar?: string;
+  preferIdentifierString?: boolean;
   printEmptyChildren?: boolean;
   printNullArgs?: boolean;
   printNullProps?: boolean;