@devsnicket/eunice-dependency-and-structure - npm Package Compare versions

Comparing version 2.8.0 to 2.9.0

createYamlFromStack/createDependsUpon/groupByParent.js

@@ -92,6 +92,16 @@ require("array.prototype.flatmap")
 					id: key,
-					items,
+					items: getItemsOrItemWhenSingle(),
 				},
 			]
 		);
+
+		function getItemsOrItemWhenSingle() {
+			return (
+				items.length === 1
+				?
+				items[0]
+				:
+				items
+			);
+		}
 	}
@@ -98,0 +108,0 @@ }

dist/createYamlFromStack/createDependsUpon/groupByParent.js

@@ -45,4 +45,8 @@ var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
 			id: key,
-			items
+			items: getItemsOrItemWhenSingle()
 		}];
+
+		function getItemsOrItemWhenSingle() {
+			return items.length === 1 ? items[0] : items;
+		}
 	}
@@ -49,0 +53,0 @@ }

package.json

@@ -69,3 +69,3 @@ {
 	},
-	"version": "2.8.0"
+	"version": "2.9.0"
 }

README.md

@@ -1,18 +0,17 @@
-# Eunice [![](https://raw.githubusercontent.com/DevSnicket/eunice-renderer/master/getSvgElementForStack/createArrows/testCase.svg?sanitize=true)](Renderer/getSvgElementForYaml/createArrows/testcase.svg)
+# Eunice ![](https://raw.githubusercontent.com/DevSnicket/eunice-renderer/master/getSvgElementForStack/createArrows/test/withUse/testCases/default-height.svg?sanitize=true) Dependency and structure
 
 DevSnicket Eunice is a toolkit based on the premise that unidirectional dependencies can be beneficial to structure and modularity in software. Eunice's approach isn't limited to direct dependencies, but includes indirect dependencies as well.
 
-[try out Eunice on Eunice 🐶🥫](https://devsnicket.github.io/Eunice/renderer/harness.html) ([created with](dogfooding/generate.sh))
+[try out Eunice on Eunice 🐶🥫](https://devsnicket.github.io/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 main Eunice repository](https://github.com/DevSnicket/Eunice#readme).
+
 [![NPM](https://img.shields.io/npm/v/@devsnicket/eunice-dependency-and-structure.svg)](https://www.npmjs.com/package/@devsnicket/eunice-dependency-and-structure
 ) [![Build Status](https://travis-ci.org/DevSnicket/eunice-dependency-and-structure.svg?branch=master)](https://travis-ci.org/DevSnicket/eunice-dependency-and-structure) [![Coverage Status](https://coveralls.io/repos/github/DevSnicket/eunice-dependency-and-structure/badge.svg?branch=master&c=1)](https://coveralls.io/github/DevSnicket/eunice-dependency-and-structure?branch=master) [![Gitter chat](https://badges.gitter.im/devsnicket-eunice/gitter.png)](https://gitter.im/devsnicket-eunice)
 
-This package takes YAML objects, replaces the identifiers of whats depended upon with references, adds dependent references in other direction and normalizes the hierarchical structure.
-
-It is written to use YAML objects parsed and formatted by [js-yaml](https://github.com/nodeca/js-yaml).
-
-Used by the renderer and some of the processors in [Eunice](https://github.com/DevSnicket/Eunice).
-
 Install using [`npm`](https://www.npmjs.com/package/@devsnicket/eunice-dependency-and-structure):
@@ -28,1 +27,23 @@
 ```
+
+## 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](https://github.com/nodeca/js-yaml) package.
+* The YAML content supported is specified [in the main Eunice repository](https://github.com/DevSnicket/Eunice/blob/master/docs/yaml.md). 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.

tests/callTestForSymmetrical/testDependencies/testDependsUponMapping/index.js

@@ -6,2 +6,4 @@ const
 	testFirstDependsUponChildOfSecond = require("./testFirstDependsUponChildOfSecond"),
+	testFirstDependsUponSecondAndChildOfSecond = require("./testFirstDependsUponSecondAndChildOfSecond"),
+	testFirstDependsUponSecondAndTwoChildrenOfSecond = require("./testFirstDependsUponSecondAndTwoChildrenOfSecond"),
 	testFirstDependsUponTwoChildrenOfSecond = require("./testFirstDependsUponTwoChildrenOfSecond");
@@ -18,4 +20,6 @@
 				testFirstDependsUponChildOfSecond(test);
+				testFirstDependsUponSecondAndChildOfSecond(test);
+				testFirstDependsUponSecondAndTwoChildrenOfSecond(test);
 				testFirstDependsUponTwoChildrenOfSecond(test);
 			},
 		);

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

181067

increased by2.74%

Number of package files

126

increased by1.61%

Lines of code

3934

increased by3.25%

Number of lines in readme file

49

increased by75%

No dependency changes