data-restructor 3.3.4 → 3.4.1

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,15 @@
 
 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 run changelog` Update CHANGELOG.md
 - `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 +18,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 +33,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)