@concepto/dsl_parser v1.5.64

Description

ES6 Class for creating and parsing Concepto DSL files. Note you need to pass all arguments as an object with keys.

API Reference

dsl_parser: A class for parsing Concepto DSL files, and compile them with the OPEN Framework.

• dsl_parser
  • instance
    • .process()
    • .getParser() ⇒ Object
    • .getNodes([text], [attribute], [attribute_value], [icon], [level], [link], [recurse], [nodes_raw]) ⇒ Array.<NodeDSL>
    • .addNode(parent_id, node)
    • .editNode(node_id, data)
    • .nodeToXML(node)
    • .getNode(id, [recurse], [dates], [$], [nodes_raw]) ⇒ Array.<NodeDSL>
    • .getParentNode(id, [recurse]) ⇒ NodeDSL
    • .getParentNodesIDs(id, [array]) ⇒ String | Array
    • .getChildrenNodesIDs(id, [array]) ⇒ String | Array
    • .getBrotherNodesIDs(id, [before], [after], [array]) ⇒ String
    • .createGitVersion([remove], [extrastep]) ⇒ String
    • .findVariables(text, [symbol], [symbol_closing], [array]) ⇒ String
    • .replaceVarsSymbol(text, from, to) ⇒ String
    • .getDifferences(from, to)
  • inner
    • ~NodeDSL : Object
    • ~Arrow : Object

dsl_parser.process()

Executes initial processing for parser

Kind: instance method of dsl_parser

dsl_parser.getParser() ⇒ Object

Gets a reference to the internal parser

Kind: instance method of dsl_parser

dsl_parser.getNodes(text, attribute, attribute_value, icon, level, link, recurse, nodes_raw) ⇒ Array.<NodeDSL>

Get all nodes that contain the given arguments (all optional)

Kind: instance method of dsl_parser

dsl_parser.addNode(parent_id, node)

Adds a node as an xml child of the given parent node ID

Kind: instance method of dsl_parser

dsl_parser.editNode(node_id, data)

Edits the given node ID data keys

Kind: instance method of dsl_parser

dsl_parser.nodeToXML(node)

Converts a NodeDSL into an XML of ConceptoDSL node child

Kind: instance method of dsl_parser

dsl_parser.getNode(id, recurse, dates, $, nodes_raw) ⇒ Array.<NodeDSL>

Get node data for the given id

Kind: instance method of dsl_parser

dsl_parser.getParentNode(id, recurse) ⇒ NodeDSL

Returns the parent node of the given node id

Kind: instance method of dsl_parser

dsl_parser.getParentNodesIDs(id, array) ⇒ String | Array

Returns the parent nodes ids of the given node id

Kind: instance method of dsl_parser

dsl_parser.getChildrenNodesIDs(id, array) ⇒ String | Array

Returns the children nodes ids of the given node id

Kind: instance method of dsl_parser

dsl_parser.getBrotherNodesIDs(id, before, after, array) ⇒ String

Returns the brother nodes ids of the given node id

Kind: instance method of dsl_parser

dsl_parser.createGitVersion(remove, extrastep) ⇒ String

Returns a modified version of the current loaded DSL, ready to be push to a version control (like github)

Kind: instance method of dsl_parser
Returns: String - Modified DSL source ready to be saved and pushed to a version control

dsl_parser.findVariables(text, symbol, symbol_closing, array) ⇒ String

Finds variables within given text

Kind: instance method of dsl_parser

dsl_parser.replaceVarsSymbol(text, from, to) ⇒ String

Finds and transform variables wrapping/handlebars symbols given a 'from' symbol object and a 'to' symbol object within the given text

Kind: instance method of dsl_parser

dsl_parser.getDifferences(from, to)

Finds all differences 'from' given dsl 'to' given dsl (for CLI arg --diff-from file.dsl) and returns an object with 'deleted', 'added', and 'modified' IDs keys

Kind: instance method of dsl_parser

dsl_parser~NodeDSL : Object

A node object representation of a DSL node.

Kind: inner typedef of dsl_parser
Properties

dsl_parser~Arrow : Object

Arrow object definition, for connections to other nodes within a DSL.

Kind: inner typedef of dsl_parser
Properties

© 2020-2022 Pablo Schaffner <pablo@puntorigen.com>.