fix: Type definitions

humanwhocodes · Jun 19, 2024 · 9c41c91 · 9c41c91
1 parent b661d79
commit 9c41c91
Show file tree

Hide file tree

Showing 10 changed files with 60 additions and 53 deletions.
diff --git a/js/rollup.config.js b/js/rollup.config.js
@@ -16,8 +16,8 @@ export default [
         plugins: [
             copy({
                 targets: [
-                    { src: "src/typings.d.ts", dest: "dist/" },
-                    { src: "src/typings.d.ts", dest: "temp/" }
+                    { src: "src/typedefs.ts", dest: "dist/" },
+                    { src: "src/typedefs.ts", dest: "temp/" }
                 ]
             })
         ]

diff --git a/js/src/errors.js b/js/src/errors.js
@@ -7,8 +7,8 @@
 // Typedefs
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("./typings").Location} Location */
-/** @typedef {import("./typings").Token} Token */
+/** @typedef {import("./typedefs").Location} Location */
+/** @typedef {import("./typedefs").Token} Token */
 
 //-----------------------------------------------------------------------------
 // Errors

diff --git a/js/src/evaluate.js b/js/src/evaluate.js
@@ -7,19 +7,19 @@
 // Typedefs
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("./typings").Node} Node */
-/** @typedef {import("./typings").NodeParts} NodeParts */
-/** @typedef {import("./typings").DocumentNode} DocumentNode */
-/** @typedef {import("./typings").StringNode} StringNode */
-/** @typedef {import("./typings").NumberNode} NumberNode */
-/** @typedef {import("./typings").BooleanNode} BooleanNode */
-/** @typedef {import("./typings").MemberNode} MemberNode */
-/** @typedef {import("./typings").ObjectNode} ObjectNode */
-/** @typedef {import("./typings").ElementNode} ElementNode */
-/** @typedef {import("./typings").ArrayNode} ArrayNode */
-/** @typedef {import("./typings").NullNode} NullNode */
-/** @typedef {import("./typings").AnyNode} AnyNode */
-/** @typedef {import("./typings").JSONValue} JSONValue */
+/** @typedef {import("./typedefs").Node} Node */
+/** @typedef {import("./typedefs").NodeParts} NodeParts */
+/** @typedef {import("./typedefs").DocumentNode} DocumentNode */
+/** @typedef {import("./typedefs").StringNode} StringNode */
+/** @typedef {import("./typedefs").NumberNode} NumberNode */
+/** @typedef {import("./typedefs").BooleanNode} BooleanNode */
+/** @typedef {import("./typedefs").MemberNode} MemberNode */
+/** @typedef {import("./typedefs").ObjectNode} ObjectNode */
+/** @typedef {import("./typedefs").ElementNode} ElementNode */
+/** @typedef {import("./typedefs").ArrayNode} ArrayNode */
+/** @typedef {import("./typedefs").NullNode} NullNode */
+/** @typedef {import("./typedefs").AnyNode} AnyNode */
+/** @typedef {import("./typedefs").JSONValue} JSONValue */
 
 //-----------------------------------------------------------------------------
 // Exports

diff --git a/js/src/parse.js b/js/src/parse.js
@@ -17,21 +17,21 @@ import { UnexpectedToken, ErrorWithLocation, UnexpectedEOF } from "./errors.js";
 // Typedefs
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("./typings").Location} Location */
-/** @typedef {import("./typings").Token} Token */
-/** @typedef {import("./typings").TokenType} TokenType */
-/** @typedef {import("./typings").Node} Node */
-/** @typedef {import("./typings").Mode} Mode */
-/** @typedef {import("./typings").ParseOptions} ParseOptions */
-/** @typedef {import("./typings").DocumentNode} DocumentNode */
-/** @typedef {import("./typings").StringNode} StringNode */
-/** @typedef {import("./typings").NumberNode} NumberNode */
-/** @typedef {import("./typings").BooleanNode} BooleanNode */
-/** @typedef {import("./typings").MemberNode} MemberNode */
-/** @typedef {import("./typings").ObjectNode} ObjectNode */
-/** @typedef {import("./typings").ElementNode} ElementNode */
-/** @typedef {import("./typings").ArrayNode} ArrayNode */
-/** @typedef {import("./typings").NullNode} NullNode */
+/** @typedef {import("./typedefs").Location} Location */
+/** @typedef {import("./typedefs").Token} Token */
+/** @typedef {import("./typedefs").TokenType} TokenType */
+/** @typedef {import("./typedefs").Node} Node */
+/** @typedef {import("./typedefs").Mode} Mode */
+/** @typedef {import("./typedefs").ParseOptions} ParseOptions */
+/** @typedef {import("./typedefs").DocumentNode} DocumentNode */
+/** @typedef {import("./typedefs").StringNode} StringNode */
+/** @typedef {import("./typedefs").NumberNode} NumberNode */
+/** @typedef {import("./typedefs").BooleanNode} BooleanNode */
+/** @typedef {import("./typedefs").MemberNode} MemberNode */
+/** @typedef {import("./typedefs").ObjectNode} ObjectNode */
+/** @typedef {import("./typedefs").ElementNode} ElementNode */
+/** @typedef {import("./typedefs").ArrayNode} ArrayNode */
+/** @typedef {import("./typedefs").NullNode} NullNode */
 
 //-----------------------------------------------------------------------------
 // Helpers

diff --git a/js/src/print.js b/js/src/print.js
@@ -13,8 +13,8 @@ import { evaluate } from "./evaluate.js";
 // Typedefs
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("./typings").Location} Location */
-/** @typedef {import("./typings").AnyNode} AnyNode */
+/** @typedef {import("./typedefs").Location} Location */
+/** @typedef {import("./typedefs").AnyNode} AnyNode */
 
 //-----------------------------------------------------------------------------
 // Exports

diff --git a/js/src/syntax.js b/js/src/syntax.js
@@ -7,7 +7,7 @@
 // Types
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("./typings").TokenType} TokenType */
+/** @typedef {import("./typedefs").TokenType} TokenType */
 
 //-----------------------------------------------------------------------------
 // Predefined Tokens

diff --git a/js/src/tokens.js b/js/src/tokens.js
@@ -14,10 +14,10 @@ import { UnexpectedChar, UnexpectedEOF } from "./errors.js";
 // Typedefs
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("./typings").Location} Location */
-/** @typedef {import("./typings").Token} Token */
-/** @typedef {import("./typings").TokenType} TokenType */
-/** @typedef {import("./typings").TokenizeOptions} TokenizeOptions */
+/** @typedef {import("./typedefs").Location} Location */
+/** @typedef {import("./typedefs").Token} Token */
+/** @typedef {import("./typedefs").TokenType} TokenType */
+/** @typedef {import("./typedefs").TokenizeOptions} TokenizeOptions */
 
 //-----------------------------------------------------------------------------
 // Helpers

diff --git a/js/src/traversal.js b/js/src/traversal.js
@@ -7,7 +7,8 @@
 // Typedefs
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("./typings").Node} Node */
+/** @typedef {import("./typedefs").Node} Node */
+/** @typedef {import("./typedefs").TraversalPhase} TraversalPhase */
 
 //-----------------------------------------------------------------------------
 // Data
@@ -103,7 +104,7 @@ export function traverse(root, visitor) {
  * @param {Node} root The root AST node to traverse. 
  * @param {FilterPredicate} [filter] A filter function to determine which steps to
  *      return;
- * @returns {Iterator} An iterator over the AST.  
+ * @returns {IterableIterator<{node:Node,parent:Node|undefined,phase:TraversalPhase}>} An iterator over the AST.  
  */
 export function iterator(root, filter = () => true) {
 

diff --git a/js/src/typings.d.ts → js/src/typedefs.ts b/js/src/typings.d.ts → js/src/typedefs.ts
@@ -10,6 +10,11 @@
  */
 export type Mode = "json" | "jsonc";
 
+/**
+ * The phase of the traversal step.
+ */
+export type TraversalPhase = "enter" | "exit";
+
 /**
  * Tokenization options.
  */
@@ -64,6 +69,7 @@ export interface Node {
 export interface DocumentNode extends Node {
     type: "Document";
     body: ValueNode;
+    tokens?: Array<Token>;
 }
 
 export interface NullNode extends Node {

diff --git a/js/src/types.js b/js/src/types.js
@@ -7,18 +7,18 @@
 // Typedefs
 //-----------------------------------------------------------------------------
 
-/** @typedef {import("./typings").Location} Location */
-/** @typedef {import("./typings").NodeParts} NodeParts */
-/** @typedef {import("./typings").DocumentNode} DocumentNode */
-/** @typedef {import("./typings").StringNode} StringNode */
-/** @typedef {import("./typings").NumberNode} NumberNode */
-/** @typedef {import("./typings").BooleanNode} BooleanNode */
-/** @typedef {import("./typings").MemberNode} MemberNode */
-/** @typedef {import("./typings").ObjectNode} ObjectNode */
-/** @typedef {import("./typings").ElementNode} ElementNode */
-/** @typedef {import("./typings").ArrayNode} ArrayNode */
-/** @typedef {import("./typings").NullNode} NullNode */
-/** @typedef {import("./typings").ValueNode} ValueNode */
+/** @typedef {import("./typedefs").Location} Location */
+/** @typedef {import("./typedefs").NodeParts} NodeParts */
+/** @typedef {import("./typedefs").DocumentNode} DocumentNode */
+/** @typedef {import("./typedefs").StringNode} StringNode */
+/** @typedef {import("./typedefs").NumberNode} NumberNode */
+/** @typedef {import("./typedefs").BooleanNode} BooleanNode */
+/** @typedef {import("./typedefs").MemberNode} MemberNode */
+/** @typedef {import("./typedefs").ObjectNode} ObjectNode */
+/** @typedef {import("./typedefs").ElementNode} ElementNode */
+/** @typedef {import("./typedefs").ArrayNode} ArrayNode */
+/** @typedef {import("./typedefs").NullNode} NullNode */
+/** @typedef {import("./typedefs").ValueNode} ValueNode */
 
 //-----------------------------------------------------------------------------
 // Exports