kmdr-ast - npm Package Compare versions

Comparing version 3.4.0 to 3.5.0

dist/index.d.ts

 import ASTNode from "./astNode";
 import ASTNodePoint from "./astNodePoint";
 import Highlight from "./highlight";
-import { Decorators, NodeDefinition } from "./interfaces";
+import { Decorators, NodeDefinition, DefinitionFeedback } from "./interfaces";
 import Tree from "./tree";
 import TreeCursor from "./treeCursor";
 import { ArgumentNodeDefinition, OptionArgNodeDefinition, OptionNodeDefinition, ProgramNodeDefinition, SubcommandNodeDefinition } from "./nodeDefinition";
-export { ASTNode, ArgumentNodeDefinition, OptionArgNodeDefinition, OptionNodeDefinition, ProgramNodeDefinition, SubcommandNodeDefinition, Tree, TreeCursor, ASTNodePoint, Highlight, NodeDefinition, Decorators };
+export { ASTNode, ArgumentNodeDefinition, OptionArgNodeDefinition, OptionNodeDefinition, ProgramNodeDefinition, DefinitionFeedback, SubcommandNodeDefinition, Tree, TreeCursor, ASTNodePoint, Highlight, NodeDefinition, Decorators, };
 //# sourceMappingURL=index.d.ts.map

dist/interfaces.d.ts

@@ -24,2 +24,9 @@ import { ArgumentSchema, OptionSchema, ProgramSchema, SubcommandSchema } from "kmdr-parser";
 }
+export interface DefinitionFeedback {
+    schemaId: string;
+    schemaVersion: string;
+    path: string[];
+    definitionId?: string;
+    type: string;
+}
 export interface Decorators<T extends Element | Text | string | any> {
@@ -26,0 +33,0 @@ argument(text: string, node?: Node, definition?: NodeDefinition): T;

dist/nodeDefinition/argumentNodeDefinition.d.ts

 import { Argument } from "kmdr-parser";
 import ASTNodePoint from "../astNodePoint";
-import { NodeDefinition } from "../interfaces";
+import { DefinitionFeedback, NodeDefinition } from "../interfaces";
 /**
@@ -12,4 +12,5 @@ *
     readonly metadata: Argument;
-    constructor(startPosition: ASTNodePoint, endPosition: ASTNodePoint, argument: Argument);
+    readonly definitionFeedback?: DefinitionFeedback;
+    constructor(startPosition: ASTNodePoint, endPosition: ASTNodePoint, argument: Argument, definitionFeedback?: DefinitionFeedback);
 }
 //# sourceMappingURL=argumentNodeDefinition.d.ts.map

dist/nodeDefinition/argumentNodeDefinition.js

@@ -7,3 +7,3 @@ "use strict";
 class ArgumentNodeDefinition {
-    constructor(startPosition, endPosition, argument) {
+    constructor(startPosition, endPosition, argument, definitionFeedback) {
         this.type = "argument";
@@ -13,4 +13,5 @@ this.startPosition = startPosition;
         this.metadata = {
-            ...argument
+            ...argument,
         };
+        this.definitionFeedback = definitionFeedback;
     }
@@ -17,0 +18,0 @@ }

dist/nodeDefinition/optionArgNodeDefinition.d.ts

@@ -1,4 +0,4 @@
-import { OptionSchema } from "kmdr-parser";
+import { Option, OptionSchema } from "kmdr-parser";
 import ASTNodePoint from "../astNodePoint";
-import { NodeDefinition } from "../interfaces";
+import { DefinitionFeedback, NodeDefinition } from "../interfaces";
 /**
@@ -12,4 +12,5 @@ *
     readonly metadata: OptionSchema;
-    constructor(startPosition: ASTNodePoint, endPosition: ASTNodePoint, optionSchema: OptionSchema);
+    readonly definitionFeedback?: DefinitionFeedback;
+    constructor(startPosition: ASTNodePoint, endPosition: ASTNodePoint, option: Option, definitionFeedback?: DefinitionFeedback);
 }
 //# sourceMappingURL=optionArgNodeDefinition.d.ts.map

dist/nodeDefinition/optionArgNodeDefinition.js

@@ -7,3 +7,3 @@ "use strict";
 class OptionArgNodeDefinition {
-    constructor(startPosition, endPosition, optionSchema) {
+    constructor(startPosition, endPosition, option, definitionFeedback) {
         this.type = "optionArg";
@@ -13,8 +13,9 @@ this.startPosition = startPosition;
         this.metadata = {
-            summary: optionSchema.summary,
-            expectsArg: optionSchema.expectsValue,
-            defaultValue: optionSchema.defaultValue,
-            long: optionSchema.long,
-            short: optionSchema.short
+            defaultValue: option.defaultValue,
+            expectsArg: option.expectsValue,
+            long: option.long,
+            short: option.short,
+            summary: option.summary,
         };
+        this.definitionFeedback = definitionFeedback;
     }
@@ -21,0 +22,0 @@ }

dist/nodeDefinition/optionNodeDefinition.d.ts

@@ -1,4 +0,4 @@
-import { OptionSchema } from "kmdr-parser";
+import { Option, OptionSchema } from "kmdr-parser";
 import ASTNodePoint from "../astNodePoint";
-import { NodeDefinition } from "../interfaces";
+import { DefinitionFeedback, NodeDefinition } from "../interfaces";
 /**
@@ -12,4 +12,5 @@ *
     readonly metadata: OptionSchema;
-    constructor(startPosition: ASTNodePoint, endPosition: ASTNodePoint, optionSchema: OptionSchema);
+    readonly definitionFeedback?: DefinitionFeedback;
+    constructor(startPosition: ASTNodePoint, endPosition: ASTNodePoint, option: Option, definitionFeedback?: DefinitionFeedback);
 }
 //# sourceMappingURL=optionNodeDefinition.d.ts.map

dist/nodeDefinition/optionNodeDefinition.js

@@ -7,3 +7,3 @@ "use strict";
 class OptionNodeDefinition {
-    constructor(startPosition, endPosition, optionSchema) {
+    constructor(startPosition, endPosition, option, definitionFeedback) {
         this.type = "option";
@@ -13,8 +13,9 @@ this.startPosition = startPosition;
         this.metadata = {
-            summary: optionSchema.summary,
-            expectsArg: optionSchema.expectsValue,
-            defaultValue: optionSchema.defaultValue,
-            long: optionSchema.long,
-            short: optionSchema.short
+            defaultValue: option.defaultValue,
+            expectsArg: option.expectsValue,
+            long: option.long,
+            short: option.short,
+            summary: option.summary,
         };
+        this.definitionFeedback = definitionFeedback;
     }
@@ -21,0 +22,0 @@ }

dist/nodeDefinition/programNodeDefinition.d.ts

@@ -1,4 +0,4 @@
-import { ProgramSchema } from "kmdr-parser";
+import { Program, ProgramSchema } from "kmdr-parser";
 import ASTNodePoint from "../astNodePoint";
-import { NodeDefinition } from "../interfaces";
+import { DefinitionFeedback, NodeDefinition } from "../interfaces";
 /**
@@ -12,4 +12,5 @@ *
     readonly metadata: ProgramSchema;
-    constructor(startPosition: ASTNodePoint, endPosition: ASTNodePoint, programSchema: ProgramSchema);
+    readonly definitionFeedback?: DefinitionFeedback;
+    constructor(startPosition: ASTNodePoint, endPosition: ASTNodePoint, program: Program, definitionFeedback?: DefinitionFeedback);
 }
 //# sourceMappingURL=programNodeDefinition.d.ts.map

dist/nodeDefinition/programNodeDefinition.js

@@ -7,3 +7,3 @@ "use strict";
 class ProgramNodeDefinition {
-    constructor(startPosition, endPosition, programSchema) {
+    constructor(startPosition, endPosition, program, definitionFeedback) {
         this.type = "program";
@@ -13,5 +13,6 @@ this.startPosition = startPosition;
         this.metadata = {
-            name: programSchema.name,
-            summary: programSchema.summary
+            name: program.name,
+            summary: program.summary,
         };
+        this.definitionFeedback = definitionFeedback;
     }
@@ -18,0 +19,0 @@ }

dist/nodeDefinition/subcommandNodeDefinition.d.ts

@@ -1,4 +0,4 @@
-import { SubcommandSchema } from "kmdr-parser";
+import { Subcommand, SubcommandSchema } from "kmdr-parser";
 import ASTNodePoint from "../astNodePoint";
-import { NodeDefinition } from "../interfaces";
+import { DefinitionFeedback, NodeDefinition } from "../interfaces";
 /**
@@ -12,4 +12,5 @@ *
     readonly metadata: SubcommandSchema;
-    constructor(startPosition: ASTNodePoint, endPosition: ASTNodePoint, subcommandSchema: SubcommandSchema);
+    readonly definitionFeedback?: DefinitionFeedback;
+    constructor(startPosition: ASTNodePoint, endPosition: ASTNodePoint, subcommand: Subcommand, definitionFeedback?: DefinitionFeedback);
 }
 //# sourceMappingURL=subcommandNodeDefinition.d.ts.map

dist/nodeDefinition/subcommandNodeDefinition.js

@@ -7,3 +7,3 @@ "use strict";
 class SubcommandNodeDefinition {
-    constructor(startPosition, endPosition, subcommandSchema) {
+    constructor(startPosition, endPosition, subcommand, definitionFeedback) {
         this.type = "subcommand";
@@ -13,5 +13,6 @@ this.startPosition = startPosition;
         this.metadata = {
-            name: subcommandSchema.name,
-            summary: subcommandSchema.summary
+            name: subcommand.name,
+            summary: subcommand.summary,
         };
+        this.definitionFeedback = definitionFeedback;
     }
@@ -18,0 +19,0 @@ }

package.json

 {
   "name": "kmdr-ast",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Traverse the AST of an explanation by kmdr",
@@ -11,3 +11,3 @@ "main": "dist/index.js",
     "@types/react": "^16.9.34",
-    "kmdr-parser": "^2.3.0"
+    "kmdr-parser": "^2.6.1"
   },
@@ -14,0 +14,0 @@ "devDependencies": {

No alert changes

Improved metrics

Total package byte prevSize

60518

increased by3.29%

Lines of code

723

increased by2.41%

Dependency changes

• Updatedkmdr-parser@^2.6.1