Migrate to broth and add zest suffix to mocha reports (#8)

* Adds baldrick-broth

* After normalisation

* package.json with new script and lint fix

* Adds unit command

* Uses .zest.mocha.json for test

* Generate maintenance.md

* Adds build to release ready

* Add release publish

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -32,6 +32,7 @@ body:
       label: On which platform(s) do you have the issue ?
       multiple: true
       options:
+        - Any
         - Node.js
         - Typescript node
         - Firefox
@@ -47,5 +48,5 @@ body:
     attributes:
       label: Relevant log output
       description: Please copy and paste any relevant log output. This will be
-        automatically formatted into code, so no need for backticks.
+        automatically formatted into code, so no need for back ticks.
       render: shell

.github/pull_request_template.md

@@ -1,33 +1,36 @@
-
-# Summary of the change 
+# Summary of the change
 
 Fixes: # (issue)
 
 ## Code check
 
-- [ ] `yarn ready` does not show any concerning issues
-- [ ] the project can be built
-- [ ] the documentation has been updated
-- [ ] the version has been updated in `package.json`
+-   [x] `npx baldrick-broth@latest release ready` does not show any
+    concerning issues
 
 ## Type of change
 
-- [ ] Bug fix (non-breaking change which fixes an issue)
+-   [ ] Bug fix (non-breaking change which fixes an issue)
+
+-   [ ] Safe refactoring (non-breaking change which improves the code or
+    documentation)
 
-- [ ] New feature (non-breaking change which adds functionality)
+-   [ ] New feature (non-breaking change which adds functionality)
 
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+-   [ ] Breaking change (fix or feature that would cause existing
+    functionality to not work as expected)
 
 ## Motivation and context
 
-- [ ] improve user experience
-- [ ] improve consistency
-- [ ] improve security
-- [ ] improve documentation
-- [ ] reduce risk for unfamiliar tasks
-- [ ] automate repetitive tasks
+-   [ ] improve user experience
+-   [ ] improve consistency
+-   [ ] improve security
+-   [ ] improve documentation
+-   [ ] improve code
+-   [ ] reduce risk for unfamiliar tasks
+-   [ ] automate repetitive tasks
 
 ## How Has This Been Tested
 
-- [ ] Unit tests
-- [ ] Manual tests
+-   [x] Unit tests
+-   [ ] Automated browser tests
+-   [ ] Manual tests

.github/workflows/main.yml

@@ -8,23 +8,29 @@ jobs:
     strategy:
       matrix:
         node:
-          - 14.x
-          - 16.x
+          - 18.x
         os:
           - ubuntu-latest
           - macOS-latest
     steps:
       - name: Checkout repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Use Node ${{ matrix.node }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
       - name: Installation
         run: yarn install
-      - name: Static code analysis
-        run: yarn lint:ci
-      - name: Test
-        run: yarn test:ci
+      - name: Run zest unit tests
+        run: npx baldrick-broth test spec
+      - name: Run pest integration tests
+        run: npx baldrick-broth test pest
       - name: Build
         run: yarn build
+      - name: Test Report
+        uses: dorny/test-reporter@v1
+        if: success() || failure()
+        with:
+          name: Pest
+          path: report/*.pest.mocha.json
+          reporter: mocha-json

.gitignore

@@ -3,4 +3,6 @@
 node_modules/
 dist/
 report/
-.message
+temp/
+.message
+.todo.yaml

.remarkrc.yml

@@ -0,0 +1,6 @@
+settings:
+  bullet: "*"
+plugins:
+  - remark-preset-lint-consistent
+  - remark-preset-lint-recommended
+  - remark-preset-lint-markdown-style-guide

.vscode/baldrick.code-snippets

@@ -48,5 +48,59 @@
       "  JSON.stringify(value, null, 2);"
     ],
     "description": "stringify an object"
+  },
+  "error-message-id": {
+    "scope": "javascript,typescript",
+    "prefix": "error-message-id",
+    "body": [
+      "($RANDOM)"
+    ],
+    "description": "Generate an error message id"
+  },
+  "add decision": {
+    "scope": "markdown,md",
+    "prefix": "add decision",
+    "body": [
+      "## Title Fixme",
+      "",
+      "* MUST-HAVE.",
+      "* Created: ${CURRENT_MONTH_NAME} ${CURRENT_YEAR}",
+      "",
+      "### Context and Problem Statement",
+      "",
+      "> Fixme",
+      "",
+      "### Decision Drivers",
+      "",
+      "* Fixme",
+      "",
+      "### Considered Options",
+      "",
+      "* Fixme",
+      "",
+      "### Decision Outcome",
+      "",
+      "Chosen option: Fixme",
+      "",
+      "#### Positive Consequences",
+      "",
+      "* Fixme",
+      "",
+      "#### Negative Consequences",
+      "",
+      "* Fixme",
+      "",
+      "### Pros and Cons of the Options",
+      "",
+      "#### Option title fixme",
+      "",
+      "Description fixme",
+      "",
+      "* Pros: ",
+      "    * Fixme",
+      "* Cons:",
+      "    * Fixme"
+    ],
+    "description": "Adds architecture decision record"
   }
 }

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "makefile.extensionOutputFolder": "./.vscode",
+  "yaml.schemas": {
+    "./script/schema/project.schema.json": "script/data/project.yaml"
+  }
+}

CODE_OF_CONDUCT.md

@@ -1,51 +1,82 @@
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project
+and our community a harassment-free experience for everyone, regardless of
+age, body size, disability, ethnicity, gender identity and expression, level
+of experience, nationality, personal appearance, race, religion, or sexual
+identity and orientation.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment include:
+Examples of behavior that contributes to creating a positive environment
+include:
 
-- Using welcoming and inclusive language
-- Being respectful of differing viewpoints and experiences
-- Gracefully accepting constructive criticism
-- Focusing on what is best for the community
-- Showing empathy towards other community members
+-   Using welcoming and inclusive language
+-   Being respectful of differing viewpoints and experiences
+-   Gracefully accepting constructive criticism
+-   Focusing on what is best for the community
+-   Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-- The use of sexualized language or imagery and unwelcome sexual attention or advances
+-   The use of sexualized language or imagery and unwelcome sexual
+    attention or advances
 
-- Trolling, insulting/derogatory comments, and personal or political attacks
+-   Trolling, insulting/derogatory comments, and personal or political
+    attacks
 
-- Public or private harassment
+-   Public or private harassment
 
-- Publishing others' private information, such as a physical or electronic address, without explicit permission
+-   Publishing others' private information, such as a physical or
+    electronic address, without explicit permission
 
-- Other conduct which could reasonably be considered inappropriate in a professional setting
+-   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
 
 ## Our Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+Project maintainers are responsible for clarifying the standards of
+acceptable behavior and are expected to take appropriate and fair corrective
+action in response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an
+appointed representative at an online or offline event. Representation of a
+project may be further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [Flarebyte.com](https://github.com/flarebyte). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [](https://github.com/). The
+project team will review and investigate all complaints, and will respond in
+a way that it deems appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at
+[http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
+
 [version]: http://contributor-covenant.org/version/1/4/