@ts-graphviz/ast 0.0.0-pr956-20240225073457 → 0.0.0-pr956-20240225091623

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @ts-graphviz/ast
 
-## 0.0.0-pr956-20240225073457
+## 0.0.0-pr956-20240225091623
 
 ### Major Changes
 
@@ -9,4 +9,4 @@
 ### Patch Changes
 
 - Updated dependencies [[`6b2f0e8`](https://github.com/ts-graphviz/ts-graphviz/commit/6b2f0e8349605b4fe0dd950147ba3a8285b24b24)]:
-  - @ts-graphviz/common@0.0.0-pr956-20240225073457
+  - @ts-graphviz/common@0.0.0-pr956-20240225091623

package/package.json

@@ -1,11 +1,30 @@
 {
   "name": "@ts-graphviz/ast",
-  "version": "0.0.0-pr956-20240225073457",
+  "version": "0.0.0-pr956-20240225091623",
   "description": "",
+  "keywords": [],
+  "homepage": "https://github.com/ts-graphviz/ts-graphviz#readme",
+  "bugs": {
+    "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ts-graphviz/ts-graphviz.git",
+    "directory": "packages/ast"
+  },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/ts-graphviz"
+    },
+    {
+      "type": "opencollective",
+      "url": "https://opencollective.com/ts-graphviz"
+    }
+  ],
+  "license": "NIT",
+  "author": "",
   "type": "module",
-  "main": "lib/ast.cjs",
-  "module": "lib/ast.js",
-  "types": "lib/ast.d.ts",
   "exports": {
     ".": {
       "require": {
@@ -19,24 +38,17 @@
     },
     "./package.json": "./package.json"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/ts-graphviz/ts-graphviz.git",
-    "directory": "packages/ast"
-  },
-  "publishConfig": {
-    "access": "public",
-    "provenance": true
-  },
-  "keywords": [],
-  "author": "",
-  "license": "NIT",
-  "bugs": {
-    "url": "https://github.com/ts-graphviz/ts-graphviz/issues"
-  },
-  "homepage": "https://github.com/ts-graphviz/ts-graphviz#readme",
+  "main": "lib/ast.cjs",
+  "module": "lib/ast.js",
+  "types": "lib/ast.d.ts",
+  "files": [
+    "lib",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
   "dependencies": {
-    "@ts-graphviz/common": "^0.0.0-pr956-20240225073457"
+    "@ts-graphviz/common": "^0.0.0-pr956-20240225091623"
   },
   "devDependencies": {
     "peggy": "^3.0.2",
@@ -45,8 +57,15 @@
     "vite": "^5.1.3",
     "vite-plugin-dts": "^3.7.2"
   },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "scripts": {
-    "codegen": "peggy --plugin ts-pegjs --extra-options-file src/dot-shim/parser/peggy.options.json -o src/dot-shim/parser/_parse.ts src/dot-shim/parser/dot.peggy",
-    "build": "vite build"
+    "build": "vite build",
+    "codegen": "peggy --plugin ts-pegjs --extra-options-file src/dot-shim/parser/peggy.options.json -o src/dot-shim/parser/_parse.ts src/dot-shim/parser/dot.peggy"
   }
 }

package/src/ast.ts

@@ -1,8 +0,0 @@
-/**
- * @module ts-graphviz/ast
- * @beta
- */
-export * from './types.js';
-export * from './builder/index.js';
-export * from './dot-shim/index.js';
-export * from './model-shim/index.js';

package/src/builder/__snapshots__/create-element.test.ts.snap

@@ -1,166 +0,0 @@
-// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
-
-exports[`createElement > Attribute 1`] = `
-{
-  "children": [],
-  "key": {
-    "children": [],
-    "location": null,
-    "quoted": false,
-    "type": "Literal",
-    "value": "color",
-  },
-  "location": null,
-  "type": "Attribute",
-  "value": {
-    "children": [],
-    "location": null,
-    "quoted": false,
-    "type": "Literal",
-    "value": "red",
-  },
-}
-`;
-
-exports[`createElement > Coment 1`] = `
-{
-  "children": [],
-  "kind": "Macro",
-  "location": null,
-  "type": "Comment",
-  "value": "This is comment",
-}
-`;
-
-exports[`createElement > Dot 1`] = `
-{
-  "children": [],
-  "location": null,
-  "type": "Dot",
-}
-`;
-
-exports[`createElement > Edge 1`] = `
-{
-  "children": [],
-  "location": null,
-  "targets": [
-    {
-      "children": [],
-      "id": {
-        "children": [],
-        "location": null,
-        "quoted": true,
-        "type": "Literal",
-        "value": "a",
-      },
-      "location": null,
-      "type": "NodeRef",
-    },
-    {
-      "children": [],
-      "id": {
-        "children": [],
-        "location": null,
-        "quoted": true,
-        "type": "Literal",
-        "value": "b",
-      },
-      "location": null,
-      "type": "NodeRef",
-    },
-  ],
-  "type": "Edge",
-}
-`;
-
-exports[`createElement > Graph 1`] = `
-{
-  "children": [],
-  "directed": true,
-  "location": null,
-  "strict": false,
-  "type": "Graph",
-}
-`;
-
-exports[`createElement > Literal 1`] = `
-{
-  "children": [],
-  "location": null,
-  "quoted": true,
-  "type": "Literal",
-  "value": "literal value",
-}
-`;
-
-exports[`createElement > Node 1`] = `
-{
-  "children": [],
-  "id": {
-    "children": [],
-    "location": null,
-    "quoted": false,
-    "type": "Literal",
-    "value": "node_id",
-  },
-  "location": null,
-  "type": "Node",
-}
-`;
-
-exports[`createElement > NodeRef 1`] = `
-{
-  "children": [],
-  "id": {
-    "children": [],
-    "location": null,
-    "quoted": true,
-    "type": "Literal",
-    "value": "b",
-  },
-  "location": null,
-  "type": "NodeRef",
-}
-`;
-
-exports[`createElement > NodeRefGroup 1`] = `
-{
-  "children": [
-    {
-      "children": [],
-      "id": {
-        "children": [],
-        "location": null,
-        "quoted": true,
-        "type": "Literal",
-        "value": "a",
-      },
-      "location": null,
-      "type": "NodeRef",
-    },
-    {
-      "children": [],
-      "id": {
-        "children": [],
-        "location": null,
-        "quoted": true,
-        "type": "Literal",
-        "value": "b",
-      },
-      "location": null,
-      "type": "NodeRef",
-    },
-  ],
-  "location": null,
-  "type": "NodeRefGroup",
-}
-`;
-
-exports[`createElement > Subgraph 1`] = `
-{
-  "children": [],
-  "location": null,
-  "type": "Subgraph",
-}
-`;

package/src/builder/builder.test.ts

@@ -1,36 +0,0 @@
-import { describe, expect, test } from 'vitest';
-import { Builder } from './builder.js';
-
-describe('Builder', () => {
-  test('should create an ASTNode with specified properties', () => {
-    const location = {
-      start: {
-        offset: 0,
-        line: 1,
-        column: 1,
-      },
-      end: {
-        offset: 3,
-        line: 1,
-        column: 3,
-      },
-    };
-    const builder = new Builder({
-      locationFunction: () => location,
-    });
-    const type = 'TestType' as any;
-    const props = { prop1: 'test1', prop2: 'test2' };
-    const children = [
-      { type: 'TestType', props: { prop1: 'test1', prop2: 'test2' } },
-    ] as any[];
-    const expectedResult = {
-      type,
-      ...props,
-      children,
-      location,
-    };
-    expect(builder.createElement(type, props, children)).toStrictEqual(
-      expectedResult,
-    );
-  });
-});

package/src/builder/builder.ts

@@ -1,44 +0,0 @@
-import type { ASTChildNode, ASTNode, FileRange } from '../types.js';
-import { ASTBuilder, BuilderOptions } from './types.js';
-
-/**
- * Builder is an ASTBuilder that provides a method to create an ASTNode.
- *
- * @group Create AST
- */
-export class Builder implements ASTBuilder {
-  /**
-   * Get the current file range or null
-   * @internal
-   */
-  private getLocation(): FileRange | null {
-    return this.options?.locationFunction?.() ?? null;
-  }
-
-  /**
-   * Constructor of Builder
-   * @param options - Options to initialize Builder
-   */
-  constructor(private options?: Partial<BuilderOptions>) {}
-
-  /**
-   * Create an {@link ASTNode} of the specified type
-   *
-   * @param type - Type of the {@link ASTNode}
-   * @param props - Properties of the {@link ASTNode}
-   * @param children - Children of the {@link ASTNode}
-   * @returns An {@link ASTNode}
-   */
-  public createElement<T extends ASTNode>(
-    type: T['type'],
-    props: any,
-    children: ASTChildNode<T>[] = [],
-  ): T {
-    return {
-      location: this.getLocation(),
-      ...props,
-      type,
-      children,
-    };
-  }
-}

package/src/builder/create-element.test.ts

@@ -1,110 +0,0 @@
-import { describe, expect, test } from 'vitest';
-import { createElement } from './create-element.js';
-
-describe('createElement', () => {
-  test('Dot', () => {
-    const ast = createElement('Dot', {}, []);
-    expect(ast).toMatchSnapshot();
-  });
-
-  test('Graph', () => {
-    const ast = createElement('Graph', {
-      strict: false,
-      directed: true,
-    });
-    expect(ast).toMatchSnapshot();
-  });
-
-  test('Node', () => {
-    const ast = createElement('Node', {
-      id: createElement('Literal', {
-        value: 'node_id',
-        quoted: false,
-      }),
-    });
-    expect(ast).toMatchSnapshot();
-  });
-
-  test('Edge', () => {
-    const ast = createElement('Edge', {
-      targets: [
-        createElement('NodeRef', {
-          id: createElement('Literal', {
-            value: 'a',
-            quoted: true,
-          }),
-        }),
-        createElement('NodeRef', {
-          id: createElement('Literal', {
-            value: 'b',
-            quoted: true,
-          }),
-        }),
-      ],
-    });
-    expect(ast).toMatchSnapshot();
-  });
-
-  test('NodeRef', () => {
-    const ast = createElement('NodeRef', {
-      id: createElement('Literal', {
-        value: 'b',
-        quoted: true,
-      }),
-    });
-    expect(ast).toMatchSnapshot();
-  });
-
-  test('NodeRefGroup', () => {
-    const ast = createElement('NodeRefGroup', {}, [
-      createElement('NodeRef', {
-        id: createElement('Literal', {
-          value: 'a',
-          quoted: true,
-        }),
-      }),
-      createElement('NodeRef', {
-        id: createElement('Literal', {
-          value: 'b',
-          quoted: true,
-        }),
-      }),
-    ]);
-    expect(ast).toMatchSnapshot();
-  });
-
-  test('Subgraph', () => {
-    const ast = createElement('Subgraph', {}, []);
-    expect(ast).toMatchSnapshot();
-  });
-
-  test('Literal', () => {
-    const ast = createElement('Literal', {
-      value: 'literal value',
-      quoted: true,
-    });
-    expect(ast).toMatchSnapshot();
-  });
-
-  test('Coment', () => {
-    const ast = createElement('Comment', {
-      kind: 'Macro',
-      value: 'This is comment',
-    });
-    expect(ast).toMatchSnapshot();
-  });
-
-  test('Attribute', () => {
-    const ast = createElement('Attribute', {
-      key: createElement('Literal', {
-        value: 'color',
-        quoted: false,
-      }),
-      value: createElement('Literal', {
-        value: 'red',
-        quoted: false,
-      }),
-    });
-    expect(ast).toMatchSnapshot();
-  });
-});

package/src/builder/create-element.ts

@@ -1,13 +0,0 @@
-import { Builder } from './builder.js';
-import { CreateElement } from './types.js';
-/**
- * Create an {@link ASTNode} of the specified type
- *
- * @param type - Type of the {@link ASTNode}
- * @param props - Properties of the {@link ASTNode}
- * @param children - Children of the {@link ASTNode}
- * @group Create AST
- * @returns An {@link ASTNode}
- */
-export const createElement: CreateElement =
-  Builder.prototype.createElement.bind(new Builder());

package/src/builder/index.ts

@@ -1,3 +0,0 @@
-export * from './builder.js';
-export * from './types.js';
-export * from './create-element.js';