chore: initial commit

.czrc

@@ -0,0 +1,3 @@
+{
+    "path": "./node_modules/cz-conventional-changelog"
+}

.editorconfig

@@ -0,0 +1,21 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+# Use 2 spaces since npm does not respect custom indentation settings
+[package.json]
+indent_style = space
+indent_size = 2
+
+# Use 2 spaces since npm does not respect custom indentation settings
+[**/package-definition.json]
+indent_style = space
+indent_size = 2

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+Before opening a new issue, please take a moment to review our [**guidelines**](https://gobstones.github.io/gobstones-guidelines/) to make the contribution process easy and effective for everyone involved.
+
+## Description
+
+A clear and concise description of what the bug is.
+
+## Steps to reproduce
+
+Steps to reproduce the behavior:
+
+(Add link to a demo on https://jsfiddle.net or similar if possible)
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+## Versions
+
+-   Library Version:
+-   Node/NPM Version (if any):
+-   Operating System Version:
+-   Browser Version:

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+
+Before opening a new feature request, please take a moment to review our [**guidelines**](https://gobstones.github.io/gobstones-guidelines/) to make the contribution process easy and effective for everyone involved.
+
+More specifically, see our **roadmap** to be aware if the feature you are considering is already planned. If you still consider the feature is worth requesting, please complete the following:
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+## Gobstones
+
+Thank you for contributing! Please take a moment to review our
+[**guidelines**](https://gobstones.github.io/gobstones-guidelines/) to make the
+process easy and effective for everyone involved.
+
+**Please open an issue** before embarking on any significant pull request,
+especially those that add a new library or change existing tests, otherwise you
+risk spending a lot of time working on something that might not end up being
+merged into the project.
+
+Before opening a pull request, please ensure:
+
+-   [ ] You have followed our [**guidelines**](https://gobstones.github.io/gobstones-guidelines/)
+-   [ ] Double-check your branch is based on `main` and targets `main`
+-   [ ] Pull request has tests (we are going for 100% coverage!)
+-   [ ] Code is well-commented, linted and follows project conventions
+-   [ ] Documentation is updated (if necessary)
+-   [ ] Internal code generators and templates are updated (if necessary)
+-   [ ] Description explains the issue/use-case resolved and auto-closes related
+        issues
+
+Be kind to code reviewers, please try to keep pull requests as small and focused
+as possible.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project
+owners to license your work under the terms of our
+[License](https://gobstones.github.io/gobstones-guidelines/LICENSE/).

.github/issue-close-app.yml

@@ -0,0 +1,13 @@
+comment: This issue was automatically closed because it does not follow either one of our templates. Please open a new issue and fill out the template that appears instead of deleting it. If you're reporting an issue, it's especially important that you provide detailed steps for how to reproduce it.
+
+issueConfigs:
+    - content:
+          - Description
+          - Steps to reproduce
+          - Versions
+
+    - content:
+          - Is your feature request related to a problem
+          - Describe the solution you'd like
+          - Describe alternatives you've considered
+          - Additional context

.github/lock.yml

@@ -0,0 +1,28 @@
+# Configuration for lock-threads - https://github.com/dessant/lock-threads
+
+# Number of days of inactivity before a closed issue or pull request is locked
+daysUntilLock: 30
+
+# Issues and pull requests with these labels will not be locked. Set to `[]` to disable
+exemptLabels: []
+
+# Label to add before locking, such as `outdated`. Set to `false` to disable
+lockLabel: 'Auto-Closed'
+
+# Comment to post before locking. Set to `false` to disable
+lockComment: >
+    This thread has been automatically locked since there has not been
+    any recent activity after it was closed. Please open a new issue for
+    related bugs.
+
+# Limit to only `issues` or `pulls`
+only: issues
+# Optionally, specify configuration settings just for `issues` or `pulls`
+# issues:
+#   exemptLabels:
+#     - help-wanted
+#   lockLabel: outdated
+
+# pulls:
+#   daysUntilLock: 30
+

.github/workflows/on-commit-build.yml

@@ -0,0 +1,23 @@
+name: on-commit-build
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+        branches:
+            - main
+jobs:
+    test:
+        name: Run tests
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+            - name: Setup node version
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20'
+              env:
+                  HUSKY: 0
+            - name: Installing project dependencies
+              run: npm install

.github/workflows/on-commit-test.yml

@@ -0,0 +1,25 @@
+name: on-commit-test
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+        branches:
+            - main
+jobs:
+    test:
+        name: Run tests
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+            - name: Setup node version
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20'
+              env:
+                  HUSKY: 0
+            - name: Installing project dependencies
+              run: npm install
+            - name: Linting the code
+              run: npm start lint

.github/workflows/on-tag-publish-docs.yml

@@ -0,0 +1,45 @@
+name: on-tag-publish-docs
+
+on:
+    push:
+        tags:
+            - 'v*'
+    workflow_dispatch:
+
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+concurrency:
+    group: 'pages'
+    cancel-in-progress: false
+
+jobs:
+    publish-docs:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+            - name: Setup node version
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20'
+              env:
+                  HUSKY: 0
+            - name: Installing project dependencies
+              run: npm install
+            - name: Building the docs
+              run: npm start doc
+            - name: Setup Pages
+              uses: actions/configure-pages@v4
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  path: './docs'
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4

.github/workflows/on-tag-release-github.yml

@@ -0,0 +1,32 @@
+name: on-tag-release-github
+
+on:
+    push:
+        tags:
+            - 'v*'
+
+jobs:
+    publish-into-github:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+            - name: Setup node version
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20'
+              env:
+                  HUSKY: 0
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+            - name: Installing project dependencies
+              run: npm install
+            - name: Building the project
+              run: npm start build
+            - name: Create Release on GitHub
+              uses: ncipollo/release-action@v1
+              with:
+                  token: ${{ secrets.GITHUB_TOKEN }}
+                  tag: ${{ github.ref_name }}
+                  name: Release ${{ github.ref_name }}
+                  allowUpdates: true
+                  body: ${{ github.event.head_commit.message }}

.github/workflows/on-tag-release-npm.yml

@@ -0,0 +1,29 @@
+name: on-tag-release-npm
+
+on:
+    push:
+        tags:
+            - 'v*'
+
+jobs:
+    publish-into-npm:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+            - name: Setup node version
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20'
+              env:
+                  HUSKY: 0
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+            - name: Installing project dependencies
+              run: npm install
+            - name: Building the project
+              run: npm start build
+            - name: Publishing to NPM
+              uses: JS-DevTools/npm-publish@v3
+              with:
+                  token: ${{ secrets.NPM_TOKEN }}
+                  access: 'public'

.gitignore

@@ -0,0 +1,34 @@
+# OS generated files #
+.DS_Store
+Thumbs.db
+.tmp/
+
+# IDE generated file #
+.idea/
+
+# PackageManager specific lock files
+pnpm-lock.yaml
+package-lock.json
+yarn.lock
+
+# Node generated files
+node_modules/
+npm-debug.log
+yarn-error.log
+
+# Build process generated files
+.rollup.cache
+tsconfig.build.json
+
+# Test coverage generated folder
+coverage/
+
+# Dist generated folder
+dist/
+
+# Docs generated folder
+docs/
+
+# Verdaccio storage
+test/verdaccio/storage
+

.husky/commit-msg

@@ -0,0 +1,32 @@
+# Read parameters
+COMMIT_MSG_FILE=$1;
+
+# Set failing on command fail, and undefined variable use
+set -eu;
+
+# This hook is invoked by git-commit and git-merge, and can be
+# bypassed with the --no-verify option. It takes a single
+# parameter, the name of the file that holds the proposed commit
+# log message.
+
+# Exiting with a non-zero status causes the command to abort.
+
+# The hook is allowed to edit the message file in place, and can
+# be used to normalize the message into some project standard format.
+# It can also be used to refuse the commit after inspecting the
+# message file.
+
+# The default commit-msg hook, when enabled, detects duplicate
+# Signed-off-by trailers, and aborts the commit if one is found.
+
+# We use this hook to run "commitlint", that verifies that the
+# message sent has the correct format for the project, aborting otherwise.
+
+# Show welcome message
+echo "**************************";
+echo "Linting the commit message";
+echo "**************************";
+echo "";
+
+# Run commitlint
+npx --no -- commitlint --edit ${1};