@devsnicket/eunice-dependency-and-structure

Eunice Dependency and structure

This package takes YAML that contains dependencies and structure, represented as objects and does the following:

• Standardizes structure (to support varying YAML verbosity)
• Replaces the identifiers of whats depended upon with object references
• Adds dependent object references (so dependencies are available in both directions)

It is used by the renderer and some of the processors of Eunice.

More information can be found in the Eunice repository on GitHub.

Install using npm:

npm install @devsnicket/eunice-dependency-and-structure

Or with yarn:

yarn add @devsnicket/eunice-dependency-and-structure

YAML

• YAML is read using the function createStackFromYaml and written using createYamlFromStack.
• Parsing and formatting of YAML is not included in this package. Javascript objects are expected for the parameter of createStackFromYaml and will be returned by createYamlFromStack. These objects are expected to be in a form that matches the js-yaml package.
• The YAML content supported is specified in the main Eunice repository. Any additional content will be preserved when reading and writing.

Stacks

After a stack has been read/created from YAML using createStackFromYaml (see above), the following functions can be used on the stack or sub-stacks:

findDirectionBetweenItemsInFirstMutualStack

This function takes two stacks as parameters, works up the hierarchical structure from those stacks, finds the first ancestor stack that both stacks specified are descendants of, and returns that mutual ancestor stack and what the direction is between the "from" and "to" stacks specified.

findItemInStackWithIdentifierHierarchy

This function takes a stack and an array of item identifiers as parameters, it will then work its way down the hierarchical structure of the stack specified, looking for an item that matches the identifier specified at that index and returns the item that matches the last identifier specified. If at any point during this process there are no child items or an child item can't be found with a matching identifier, an error is thrown.

isInnerStack

This function takes two stacks as parameters, navigates up the hierarchical structure and returns true if "target" stack specified is an ancestor of the "source" stack specified.