data-restructor 3.3.3 → 3.4.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,8 +24,8 @@ If applicable, add screenshots to help explain your problem.
 
 **Scope:**
  - Version [e.g. v0.8]
- - Module (e.g. search-menu-ui)
- - Location/Feature within the Module (e.g. filter options view) 
+ - Module (e.g. datarestructor.js)
+ - Location/Feature within the Module (e.g. recursion duplication removal) 
 
 **Additional context**
 Add any other context about the problem here.

package/.github/workflows/codeql-analysis.yml

@@ -39,11 +39,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -54,7 +54,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -68,4 +68,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

package/.github/workflows/continuous-integration.yaml

@@ -0,0 +1,84 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - master
+    # Ignore changes in folders with generated contents or documentation.
+    # Need to match git add parameters below.
+    paths-ignore: 
+      - 'coverage/**'
+      - 'devdist/**'
+      - 'dist/**'
+      - 'docs/**'
+      - '**/*.md'
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env: 
+      CI_COMMIT_MESSAGE: Continuous Integration Build Artifacts
+      CI_COMMIT_AUTHOR: ${{ github.event.repository.name }} Continuous Integration
+    steps:
+    - uses: actions/checkout@v3
+      with: 
+        token: ${{ secrets.WORKFLOW_GIT_ACCESS_TOKEN }}
+
+    # Build
+    - uses: actions/setup-node@v3
+      with:
+        node-version: '18' 
+    - name: Install node packages
+      run: npm ci
+    - name: Build package (lint, test, build, package, merge)
+      run: npm run package
+
+    # Archive generated or updated files 
+    - name: Archive code coverage results
+      uses: actions/upload-artifact@v3
+      with:
+        name: test-code-coverage-report
+        path: coverage
+        retention-days: 14
+        if-no-files-found: error
+    - name: Archive documentation
+      uses: actions/upload-artifact@v3
+      with:
+        name: documentation
+        path: docs
+        retention-days: 14
+        if-no-files-found: error
+    - name: Archive build artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        name: distribution-production
+        path: dist
+        retention-days: 14
+        if-no-files-found: error
+    - name: Archive build artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        name: distribution-development
+        path: devdist
+        retention-days: 14
+        if-no-files-found: error
+    
+    # Commit and push all changed files
+    - name: Display event name 
+      if: env.is-auto-commit == false
+      run: echo "github.event_name=${{ github.event_name }}"
+    - name: Commit build artifacts (dist, devdist, docs, coverage)
+      # Only run when a pull request gets merged or a commit is pushed to the main branch
+      # git add parameters need to match paths-ignore parameters above
+      # Git pull before add/commit/push to reduce race conditions on parallel builds
+      if: github.event_name == 'push'
+      run: |
+        git config --global user.name '${{ env.CI_COMMIT_AUTHOR }}'
+        git config --global user.email 'joht@users.noreply.github.com'
+        git pull
+        git add coverage devdist dist docs *.md
+        git commit -m "${{ env.CI_COMMIT_MESSAGE }}"
+        git push

package/CHANGELOG.md

@@ -1,11 +1,32 @@
 # CHANGELOG.md
-## **v3.3.3** IE support fix (latest)
 
-### Fixes:
+## **v3.4.0** Update to Node.js v18 (latest)
+
+This version contains version updates including an update to Node.js v18.
+
+## **v3.3.5** Automate MergerJS
+
+### Automation
+
+- [#42](https://github.com/JohT/data-restructor-js/issues/42) The command `npm run merger` is now able to run automatically.
+- [#44](https://github.com/JohT/data-restructor-js/issues/44) Push Continuous Integration build artifacts into the repository.
+
+## **v3.3.4** Remove duplicate groups within recursion
+
+### Fixes
+
+- #12 Zero recursion duplication should be possible
+
+## **v3.3.3** IE support fix
+
+### Fixes
+
 - Use classic property definitions idiom instead of [ES6 PropertyShorthand](http://es6-features.org/#PropertyShorthand) for internet explorer (IE) support.
 
 ## **v3.3.2** Encourage Open Source Contributing
-### Features:
+
+### Features
+
 - [README.md](README.md#build-all) contains a description on how to build the module.
 - [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) sets the standard for an open, welcoming,
 diverse, inclusive, and healthy community.
@@ -16,77 +37,83 @@ diverse, inclusive, and healthy community.
 
 ## **v3.3.1** Output folder fixed
 
-### Fixes:
+### Fixes
+
 - Minified output destination fixed. Minified files are now correctly written into the "dist" folder  (instead of "dev").
 
 ## **v3.3.0** Merged source files for direct use without module system
 
-### Features:
+### Features
 
 - #7 Add merged global JavaScript files in "dist" and "devdist" to use them without module system
 - security vulnerability CVE-2021-23358 https://github.com/advisories/GHSA-cf4h-3jhx-xvhq addressed
 - [README.md](README.md#credits) now contains a lists of credits
 - [COMMANDS.MD](COMMANDS.MD#most-important-commands-for-development) now contains a separate list for commands, that are used on a regular basis
+
 ## **v3.2.0** Configurable recursion depth above which duplications will be removed
 
-### Features:
+### Features
 
 - #5 Configurable recursion depth above which duplications will be removed.
 
 ## **v3.1.0** Configurable recursion depth for sub groups
 
-### Features:
+### Features
 
 - Configurable maximum recursion depth for field groups inside groups inside groups...
 - Improved JSDoc structure and contents
-### Fixes:
+
+### Fixes
 
 - [#3](https://github.com/JohT/data-restructor-js/issues/3) Group hierarchy limited to 1 since v3.0.0
 
-### Deprecated:
+### Deprecated
 
 - `datarestructor.Restructor.processJsonUsingDescriptions(jsonData, descriptions)` is deprecated.
 Please use `new datarestructor.Transform(descriptions).processJson(jsonData)` instead.
 
 ## **v3.0.0** Introducing DescribedDataField
-### Features:
 
- - Pure, non cyclic data result that can be converted to json without using additional functions
+### Features
 
-### Breaking Changes:
+- Pure, non cyclic data result that can be converted to json without using additional functions
+
+### Breaking Changes
+
+- DescribedDataField replaces DescribedEntry as an element for the restructured output
+- DescribedEntry remains only for internal use
+- DescribedEntry function "resolveTemplate" is removed. "templateResolver.js" can be used instead.
+- DescribedEntry function "publicFieldsJson" is removed. `JSON.stringify(describedEntry.describedField)` can be used instead.
 
- - DescribedDataField replaces DescribedEntry as an element for the restructured output
- - DescribedEntry remains only for internal use
- - DescribedEntry function "resolveTemplate" is removed. "templateResolver.js" can be used instead.
- - DescribedEntry function "publicFieldsJson" is removed. `JSON.stringify(describedEntry.describedField)` can be used instead.
 ## **v2.3.0** Continuous Integration
 
-### Features:
+### Features
+
+- Continuous Integration using GitHub Actions
+- Build using nodes package manager (npm)
+- Bundle (minification,...) using Parcel Bundler
+- Automated already existing unit tests using Jasmine
+- Unit-Test coverage measurement using nyc
+- Documentation Generation using JSDoc
+- Static code analysis using ESLint
+- Updated documentation
 
-  - Continuous Integration using GitHub Actions
-  - Build using nodes package manager (npm)
-  - Bundle (minification,...) using Parcel Bundler
-  - Automated already existing unit tests using Jasmine
-  - Unit-Test coverage measurement using nyc
-  - Documentation Generation using JSDoc
-  - Static code analysis using ESLint
-  - Updated documentation
 ## **v2.2.0** Resolving template with described fields
 
-### Features:
+### Features
 
-  - Since v1.2.0 templates containing variables in double curly brackets can be resolved by the function `resolveTemplate(templateString)`. Now, it is not only possible to resolve the contained meta data,
-  but also the described fields directly. Based on the JSON below, the resolver would now provide these results:
+- Since v1.2.0 templates containing variables in double curly brackets can be resolved by the function `resolveTemplate(templateString)`. Now, it is not only possible to resolve the contained meta data,
+but also the described fields directly. Based on the JSON below, the resolver would now provide these results:
 
-    - `"{{customerNumber}}"`-> `"123"`
-    - `"{{details.name}}"`-> `"Smith"`
-    - `"{{details.age}}"`-> `"31"` 
+  - `"{{customerNumber}}"`-> `"123"`
+  - `"{{details.name}}"`-> `"Smith"`
+  - `"{{details.age}}"`-> `"31"`
 
-    Previously (since v1.2.0), these results could only be obtained with (remains unchanged):
+  Previously (since v1.2.0), these results could only be obtained with (remains unchanged):
 
-    - `"{{value}}"`-> `"123"`
-    - `"{{details[0].value}}"`-> `"Smith"`
-    - `"{{details[1].value}}"`-> `"31"`
+  - `"{{value}}"`-> `"123"`
+  - `"{{details[0].value}}"`-> `"Smith"`
+  - `"{{details[1].value}}"`-> `"31"`
 
   ```JSON
     {
@@ -116,29 +143,30 @@ Please use `new datarestructor.Transform(descriptions).processJson(jsonData)` in
 
 ## **v2.1.0** new optional fields "abbreviation" and "image" (2020-12-25)
 
-### Features:
+### Features
 
-  - With the two new optional fields **abbreviation** and **image**, that can be specified for each `PropertyStructureDescription`, it is easier to separate display related fields from e.g. the category. These fields are transferred directly into the resulting `DescribedEntry` and do not affect other behavior (grouping, filtering...) in any kind.
-  - If the variable `{{fieldName}}` is missing in the property pattern in "template mode", the right most part of the property name is used as field name. This corresponds to the behavior of the "equal mode". Previously this led to an error that forced the use of the "equal mode" in that case.
+- With the two new optional fields **abbreviation** and **image**, that can be specified for each `PropertyStructureDescription`, it is easier to separate display related fields from e.g. the category. These fields are transferred directly into the resulting `DescribedEntry` and do not affect other behavior (grouping, filtering...) in any kind.
 
-### Fix:
+- If the variable `{{fieldName}}` is missing in the property pattern in "template mode", the right most part of the property name is used as field name. This corresponds to the behavior of the "equal mode". Previously this led to an error that forced the use of the "equal mode" in that case.
 
-  - Some minor refactoring
+### Fix
 
+- Some minor refactoring
 
 ## **v2.0.0** Added "publicFieldsJson" to "DescribedEntry" (2014-12-12)
 
-### Features:
+### Features
 
-  - It is now possible to convert the public fields of an `DescribedEntry` to JSON using its function `publicFieldsJson`.
-  This includes all contained groups, that may contain `DescribedEntry`s themselves.   
-  Prior to this release, the following error occurred when calling `JSON.stringify(describedEntry)`:
-  `TypeError: Converting circular structure to JSON`
+- It is now possible to convert the public fields of an `DescribedEntry` to JSON using its function `publicFieldsJson`.
+This includes all contained groups, that may contain `DescribedEntry`s themselves.  
+Prior to this release, the following error occurred when calling `JSON.stringify(describedEntry)`:
+`TypeError: Converting circular structure to JSON`
 
     **Note:**  
     The property `isMatchingIndex` of the `DescribedEntry` had been renamed to `_isMatchingIndex` since it is an internal property and should not be used outside. Since this is a "breaking change" (in theory), it lead to a new major version.
 
     This example shows how the returned JSON looks like using parameter "space" = 2 (pretty print with 2 spaces indentation) when the `DescribedEntry` contains the group `options`:
+
     ```JSON
     {
       "category": "account",
@@ -165,48 +193,48 @@ Please use `new datarestructor.Transform(descriptions).processJson(jsonData)` in
     }
     ```
 
-
 ## **v1.2.0** Resolving template containing properties of the described entry as variables (2014-11-29)
 
-### Features:
-  - It is now possible to resolve a string containing variables in double curly brackets of an `DecribedEntry` using the function `resolveTemplate(templateString)`. 
+### Features
+
+- It is now possible to resolve a string containing variables in double curly brackets of an `DecribedEntry` using the function `resolveTemplate(templateString)`.
 
-    #### Variables that can be used:
-      - `"{{fieldName}}"`
-      -  `"{{displayName}}"`
-      -  `"{{value}}"`
-      -  `"{{index}}"`
-      -  `"{{index[1]}}"`
+#### Variables that can be used
 
-    #### Example:
-      ```javascript
-      var rawEntry = { name: "responses[0].hits.hits[3]._source.name", value: "Smith" };
-      var description = new datarestructor.PropertyStructureDescriptionBuilder().type("testtype").category("testcategory").build();
-      var describedEntry = new datarestructor.DescribedEntryCreator(rawEntry, description);
+- `"{{fieldName}}"`
+- `"{{displayName}}"`
+- `"{{value}}"`
+- `"{{index}}"`
+- `"{{index[1]}}"`
 
-      var resolved = describedEntry.resolveTemplate("{{displayName}}: {{value}}");
-      // resolved is: "Name: Smith"
-      ```
+#### Example
 
+```javascript
+var rawEntry = { name: "responses[0].hits.hits[3]._source.name", value: "Smith" };
+var description = new datarestructor.PropertyStructureDescriptionBuilder().type("testtype").category("testcategory").build();
+var describedEntry = new datarestructor.DescribedEntryCreator(rawEntry, description);
+
+var resolved = describedEntry.resolveTemplate("{{displayName}}: {{value}}");
+// resolved is: "Name: Smith"
+```
 
 ## **v1.1.0** Joining and renaming groups (2014-11-08)
 
-### Features:
+### Features
 
-  - Group destination name and joining (JohT@534c368bcb835c110e1255508ed44c790972955c)
-  - Groups can now be renamed, when they get moved to another destination.
-  - If more than one source group (array) is moved into a single destination, they get joined.   
+- Group destination name and joining (JohT@534c368bcb835c110e1255508ed44c790972955c)
+- Groups can now be renamed, when they get moved to another destination.
+- If more than one source group (array) is moved into a single destination, they get joined.  
     Previously, only the last one remained, which made it impossible to structure data within one single (e.g. main) entry.
-  - Debug mode introduced (JohT@72232e7f23ced9655c1d2693a3a5b3163c312221)
-  - Minor refactorings (JohT@14094fe247c1c1551ff518a1378a26b0cfc074c9)
-
+- Debug mode introduced (JohT@72232e7f23ced9655c1d2693a3a5b3163c312221)
+- Minor refactorings (JohT@14094fe247c1c1551ff518a1378a26b0cfc074c9)
 
 ## **v1.0.0** Initial Release (2014-10-25)
 
-### Features:
+### Features
 
-  - Adapter that takes e.g. parsed JSON and transforms it into a standardized structure
-  - Multiple transformation steps including flattening, removing duplicates, grouping, ...
-  - Takes descriptions that reflect the incoming structure and define the standardized output
-  - Reusable and flexible
-  - Supports most browser including ie5
+- Adapter that takes e.g. parsed JSON and transforms it into a standardized structure
+- Multiple transformation steps including flattening, removing duplicates, grouping, ...
+- Takes descriptions that reflect the incoming structure and define the standardized output
+- Reusable and flexible
+- Supports most browser including ie5

package/CONTRIBUTING.md

@@ -4,20 +4,22 @@
 
 The following is a set of guidelines for contributing to the search menu UI. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
 
-#### Table Of Contents
+## Table Of Contents
 
 [Code of Conduct](#code-of-conduct)
 
 [What should I know before I get started?](#what-should-i-know-before-i-get-started)
-  * [Prerequisites](#prerequisites)
-  * [First Steps](#first-steps)
-  * [Tests](#tests)
+
+- [Prerequisites](#prerequisites)
+- [First Steps](#first-steps)
+- [Tests](#tests)
 
 [How Can I Contribute?](#how-can-i-contribute)
-  * [Reporting Bugs](#reporting-bugs)
-  * [Suggesting Enhancements](#suggesting-enhancements)
-  * [Your First Code Contribution](#your-first-code-contribution)
-  * [Pull Requests](#pull-requests)
+
+- [Reporting Bugs](#reporting-bugs)
+- [Suggesting Enhancements](#suggesting-enhancements)
+- [Your First Code Contribution](#your-first-code-contribution)
+- [Pull Requests](#pull-requests)
 
 ## Code of Conduct
 
@@ -26,16 +28,22 @@ This project and everyone participating in it is governed by the [Code of Conduc
 ## What should I know before I get started?
 
 ### Prerequisites
+
 - Install [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
-- Install [merger.js](https://github.com/joao-neves95/merger-js/blob/master/README.md) using `npm install merger-js -g`
 
 ### First steps
 
-- [Fork](https://docs.github.com/en/github/getting-started-with-github/quickstart/fork-a-repo) this repository 
+- [Fork](https://docs.github.com/en/github/getting-started-with-github/quickstart/fork-a-repo) this repository
 - Setup and build the project locally as described in [README.md](README.md#build-all)
 - A list of all commands can be found in [COMMANDS.md](COMMANDS.md)
 
+### GIT commit
+
+- Create a feature branch before making a commit.
+- Automatically generated build artifacts (`dist`, - `devdist`, `docs`, `coverage` folder contents) shouldn't be included in a commit. The continuous integration pipeline will generate them and commit them separately. This also means that a feature branch needs to be pulled after the pipeline has finished before adding further commits. When the pull request is ready to merge a rebase may be considered to clean up the history and get the feature branch up to date if needed. The same applies here: Build artifacts should be left out since the pipeline will take care of them.
+
 ### Tests
+
 - All unit tests are integrated into the build
 - For immediate feedback open [test/js/SpecRunner.html](test/js/SpecRunner.html) to run JavaScript [Jasmine](https://jasmine.github.io) Unit-Tests in the browser.
 - To assure high automation this project enforces 90% branch coverage within the build, so please provide tests for every change.
@@ -52,7 +60,7 @@ Before creating bug reports, please check [this list](#before-submitting-a-bug-r
 
 #### Before Submitting A Bug Report
 
-* **Perform a [search](https://github.com/JohT/data-restructor-js/issues)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
+- **Perform a [search](https://github.com/JohT/data-restructor-js/issues)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
 
 #### How Do I Submit A (Good) Bug Report?
 
@@ -60,26 +68,26 @@ Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/).
 
 Explain the problem and include additional details to help maintainers reproduce the problem:
 
-* **Use a clear and descriptive title** for the issue to identify the problem.
-* **Describe the exact steps which reproduce the problem** in as many details as possible. 
-* **If possible, provide a "reproducer"** e.g. in an public example repository containing the easy debugable code to reproduce the problem. It can also be a simple HTML and JS attached as files.
-* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
-* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
-* **Explain which behavior you expected to see instead and why.**
+- **Use a clear and descriptive title** for the issue to identify the problem.
+- **Describe the exact steps which reproduce the problem** in as many details as possible.
+- **If possible, provide a "reproducer"** e.g. in an public example repository containing the easy debugable code to reproduce the problem. It can also be a simple HTML and JS attached as files.
+- **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
+- **Explain which behavior you expected to see instead and why.**
 
-* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
+- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
 
 Provide more context by answering these questions:
 
-* **Did the problem start happening recently** (e.g. after updating to a new version) or was this always a problem?
-* If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most recent version in which the problem doesn't happen?
-* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
-* If the problem is related to working with files (e.g. opening and editing files), **does the problem happen for all files and projects or only some?** Does the problem happen only when working with local or remote files (e.g. on network drives), with files of a specific type (e.g. only JavaScript or Python files), with large files or files with very long lines, or with files in a specific encoding? Is there anything else special about the files you are using?
+- **Did the problem start happening recently** (e.g. after updating to a new version) or was this always a problem?
+- If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most recent version in which the problem doesn't happen?
+- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
+- If the problem is related to working with files (e.g. opening and editing files), **does the problem happen for all files and projects or only some?** Does the problem happen only when working with local or remote files (e.g. on network drives), with files of a specific type (e.g. only JavaScript or Python files), with large files or files with very long lines, or with files in a specific encoding? Is there anything else special about the files you are using?
 
 Include details about your configuration and environment:
 
-* **Which version of the search menu UI are you using?** 
-* **What's the name and version of the OS and browser you're using**
+- **Which version of the search menu UI are you using?**
+- **What's the name and version of the OS and browser you're using**
 
 ### Suggesting Enhancements
 
@@ -89,20 +97,20 @@ Before creating enhancement suggestions, please check [this list](#before-submit
 
 #### Before Submitting An Enhancement Suggestion
 
-* **Perform a [search](https://github.com/JohT/data-restructor-js/issues)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- **Perform a [search](https://github.com/JohT/data-restructor-js/issues)** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
 
 #### How Do I Submit A (Good) Enhancement Suggestion?
 
 Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue on that repository and provide the following information:
 
-* **Use a clear and descriptive title** for the issue to identify the suggestion.
-* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
-* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
-* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
-* **Explain why this enhancement would be useful** to most search menu UI users.
-* **List some other text editors or applications where this enhancement exists.**
-* **Specify which version you're using.**
-* **Specify the name and version of the OS and browser you're using.**
+- **Use a clear and descriptive title** for the issue to identify the suggestion.
+- **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
+- **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
+- **Explain why this enhancement would be useful** to most search menu UI users.
+- **List some other libraries where this enhancement exists.**
+- **Specify which version you're using.**
+- **Specify the name and version of the OS and browser you're using.**
 
 ### Your First Code Contribution
 
@@ -132,16 +140,16 @@ The easiest approach is to write code that matches the style of existing one. If
 
 ### Git Commit Messages
 
-* Use the present tense ("Add feature" not "Added feature")
-* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
-* Limit the first line to 72 characters or less
-* Include a reference to the pull request
-* Reference related issues and pull requests as well as further details liberally after the first line
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Include a reference to the pull request
+- Reference related issues and pull requests as well as further details liberally after the first line
 
 ### JavaScript
 
-* Compatibility with old browser like IE5 is important for now. Please test your
-changes with internet explorer developer mode in IE5 mode. Include polyfills or ponyfills 
-if necessary. These are included in modules packages especially for ie. 
-Including as many browsers as possible is a key feature, that might change someday, 
-but only for a good reason.
+- Compatibility with old browser like IE5 is important for now. Please test your
+changes with internet explorer developer mode in IE5 mode. Include polyfills or ponyfills
+if necessary. These are included in modules packages especially for ie.
+Including as many browsers as possible is a key feature, that might change someday,
+but only for a good reason.

package/Commands.md

@@ -2,20 +2,14 @@
 
 Overview of the commands to test, run and build this project as well as those that were used to setup it.
 
-## Most important commands for development:
+## Most important commands for development
+
 - `npm install` Installs all dependencies and creates the folder `node_modules`, that is needed for all following commands.
 - `npm run package` Ready to publish build incl. test, coverage, doc generation, dev+prod build
 - `npm login` + `npm publish` To publish a new release. Be sure to run npm run package first.
 
+## Commands to test, run and build the project
 
-## Commands that needs to be installed globally to build the project
-- `npm install merger-js -g` Cross-platform CLI build tool to bundle JavaScript files without modules
-
-**Notice:** merger needs manual input in the console and prompts to select the source.
-Select "all" using the arrow down key followed by enter to continue the build. If there is a better solution for that, propose it by creating an issue. `merger.js` is helpful to create additional JavaScript bundles without module system.
-
-
-## Commands to test, run and build the project:
 - `npm run coverage` Run all unit tests (using jasmine) **with** reporting coverage (using nyc/istanbul)
 - `npm test` Only all unit tests (using jasmine) **without** coverage report
 - `npm run coverage-badge` Updates code coverage badge inside `README.md`
@@ -23,8 +17,12 @@ Select "all" using the arrow down key followed by enter to continue the build. I
 - `npm run build` Builds the application for production including minification,...
 - `npm run dev` Builds the application for development (without minification) and starts the live server
 - `npm run watch` Builds the application for development (without minification) without starting the server.
+- `npm run merger` Merges JavaScript source files javascript file bundles that can be used with/without module system and can therefore be used directly within the browser (without node.js e.g.). 
+ The command itself needs to send the letter "k" and the enter key to the merger command to automate
+ the key prompt that would otherwise block continuous integration.
+
+## Commands used to setup the project
 
-## Commands used to setup the project:
 - `npm init` Initialize node package manager, creates `package.json` file.
 - `npm install jasmine --save-dev` Adds jasmine unit test framework as development dependency.
 - `npx jasmine init` Initializes jasmine, creates `spec/support/jasmine.json` file.
@@ -34,14 +32,16 @@ Select "all" using the arrow down key followed by enter to continue the build. I
 - `npm install eslint --save-dev` Setup linter (static code quality analyzer)
 - `npx eslint --init` Initialize linter configuration file
 - `npm install istanbul-badges-readme --save-dev` Setup for code coverage badge for README.MD.
+- `npm install --save-exact --save-dev node-notifier inquirer merger-js` Setup file merger for vanilla JS distributions.
 - `npm audit fix` Fixes vulnerabilities
 
+## Further steps
 
-## Further steps:
 - It would be great to get SpecRunner.html up and running in dev mode like: "dev": "parcel ./test/js/SpecRunner.html". [parcel issue 3407](https://github.com/parcel-bundler/parcel/issues/3407) may be key for that.
 
 ## References
- * [Parcel - Getting Started](https://parceljs.org/getting_started.html)
- * [Jasmine - Using Jasmine with node](https://jasmine.github.io/setup/nodejs.html)
- * [Istanbul/nyc - Installation & Usage](https://github.com/istanbuljs/nyc#installation--usage)
- * [ESLint - Getting Started](https://eslint.org/docs/user-guide/getting-started)
+
+- [Parcel - Getting Started](https://parceljs.org/getting_started.html)
+- [Jasmine - Using Jasmine with node](https://jasmine.github.io/setup/nodejs.html)
+- [Istanbul/nyc - Installation & Usage](https://github.com/istanbuljs/nyc#installation--usage)
+- [ESLint - Getting Started](https://eslint.org/docs/user-guide/getting-started)