This project has been merged into ts-graphviz.
Graphviz dot language parser for ts-graphviz.
- Parse function that converts the DOT language to a ts-graphviz model.
- Provides module that enables operations at AST level.
- TypeScript Support.
- Supports multiple runtime and module.
- Node.js, Browser and Deno.
- UMD, ESM, CommonJS
The module can then be installed using npm:
# yarn
$ yarn add @ts-graphviz/parser
# or npm
$ npm install -S @ts-graphviz/parserParse a string written in dot language and convert it to a model.
The returned values are ts-graphviz models
such as Digraph, Graph, Node, Edge, Subgraph.
- Parameters
dot-- string in the dot language to be parsed.options.rule-- Object type of dot string.- This can be
"graph","subgraph","node","edge".
- This can be
import { parse } from '@ts-graphviz/parser';
const G = parse(`
digraph hoge {
a -> b;
}`);This is equivalent to the code below when using ts-graphviz.
import { digraph } from 'ts-graphviz';
const G = digraph('hoge', (g) => {
g.edge(['a', 'b']);
});If the given string is invalid, a SyntaxError exception will be thrown.
import { parse, SyntaxError } from '@ts-graphviz/parser';
try {
parse(`invalid`);
} catch (e) {
if (e instanceof SyntaxError) {
console.log(e.message);
}
}import { Node } from 'ts-graphviz';
import { parse } from '@ts-graphviz/parser';
const node = parse(
`test [
style=filled;
color=lightgrey;
label = "example #1";
];`,
{ rule: 'node' },
);
console.log(node instanceof Node);
// trueThis is an experimental API. Behavior may change in the future.
A tag template version of the parse function.
Returns a Graph or Digraph object based on the parsed result.
If the given string is invalid, a SyntaxError exception will be thrown.
import { dot } from '@ts-graphviz/parser';
const G = dot`
graph {
a -- b
}
`;May change the publishing method.
Convert AST to ts-graphviz model.
export function convert(ast: AST.Dot): RootCluster;
export function convert(ast: AST.Graph): RootCluster;
export function convert(ast: AST.Subgraph): Subgraph;
export function convert(ast: AST.Node): Node;
export function convert(ast: AST.Edge): Edge;The AST module provides the ability to handle the AST as a result of parsing the dot language
for lower level operations.
The basic usage is the same as the parse function, except that it returns the dot language AST.
- Parameters
dot-- string in the dot language to be parsed.options.rule-- Object type of dot string.- This can be
"graph","subgraph","node","edge","attributes","attribute", "cluster_statements".
- This can be
import { AST } from '@ts-graphviz/parser';
const ast = AST.parse(`
digraph example {
node1 [
label = "My Node",
]
}
`);
console.log(ast);
// {
// type: 'dot',
// body: [
// {
// type: 'graph',
// id: {
// type: 'literal',
// value: 'example',
// quoted: false,
// location: {
// start: { offset: 11, line: 2, column: 11 },
// end: { offset: 18, line: 2, column: 18 }
// }
// },
// directed: true,
// strict: false,
// body: [
// {
// type: 'node',
// id: {
// type: 'literal',
// value: 'node1',
// quoted: false,
// location: {
// start: { offset: 25, line: 3, column: 5 },
// end: { offset: 30, line: 3, column: 10 }
// }
// },
// body: [
// {
// type: 'attribute',
// key: {
// type: 'literal',
// value: 'label',
// quoted: false,
// location: {
// start: { offset: 39, line: 4, column: 7 },
// end: { offset: 44, line: 4, column: 12 }
// }
// },
// value: {
// type: 'literal',
// value: 'My Node',
// quoted: true,
// location: {
// start: { offset: 47, line: 4, column: 15 },
// end: { offset: 56, line: 4, column: 24 }
// }
// },
// location: {
// start: { offset: 39, line: 4, column: 7 },
// end: { offset: 57, line: 4, column: 25 }
// }
// }
// ],
// location: {
// start: { offset: 25, line: 3, column: 5 },
// end: { offset: 63, line: 5, column: 6 }
// }
// }
// ],
// location: {
// start: { offset: 3, line: 2, column: 3 },
// end: { offset: 67, line: 6, column: 4 }
// }
// }
// ],
// location: {
// start: { offset: 3, line: 2, column: 3 },
// end: { offset: 68, line: 7, column: 1 }
// }
// }const ast = AST.parse('test [ style=filled; ];', { rule: 'node' });
console.log(ast);
// {
// type: 'node',
// id: {
// type: 'literal',
// value: 'test',
// quoted: false,
// location: {
// start: { offset: 0, line: 1, column: 1 },
// end: { offset: 4, line: 1, column: 5 }
// }
// },
// body: [
// {
// type: 'attribute',
// key: {
// type: 'literal',
// value: 'style',
// quoted: false,
// location: {
// start: { offset: 7, line: 1, column: 8 },
// end: { offset: 12, line: 1, column: 13 }
// }
// },
// value: {
// type: 'literal',
// value: 'filled',
// quoted: false,
// location: {
// start: { offset: 13, line: 1, column: 14 },
// end: { offset: 19, line: 1, column: 20 }
// }
// },
// location: {
// start: { offset: 7, line: 1, column: 8 },
// end: { offset: 20, line: 1, column: 21 }
// }
// }
// ],
// location: {
// start: { offset: 0, line: 1, column: 1 },
// end: { offset: 23, line: 1, column: 24 }
// }
// }Stringify Graphviz AST Node.
- Parameters
ast-- Graphviz AST node.
- Returns
- DOT language string.
Graphviz-dot Test and Integration
- ts-graphviz
- Graphviz library for TypeScript.
- @ts-graphviz/react
- Graphviz-dot Renderer using React.
- jest-graphviz
- Jest matchers that supports graphviz integration.
- setup-graphviz
- GitHub Action to set up Graphviz cross-platform(Linux, macOS, Windows).
Thanks goes to these wonderful people (emoji key):
Yuki Yamazaki 💻 📖 |
Christian Murphy 💻 🤔 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!
This software is released under the MIT License, see LICENSE.
