diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..6777c93
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1 @@
+/.yarn/** linguist-vendored
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 0000000..5e8758c
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1 @@
+* @prisis
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..a73de8b
--- /dev/null
+++ b/.github/CODE_OF_CONDUCT.md
@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+ advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+ address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [d.bannert@anolilab.de](mailto:d.bannert@anolilab.de). All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..e69de29
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000..bcb61cc
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1 @@
+github: "prisis"
diff --git a/.github/file-filters.yml b/.github/file-filters.yml
new file mode 100644
index 0000000..9e18afa
--- /dev/null
+++ b/.github/file-filters.yml
@@ -0,0 +1,9 @@
+ This is used by the action https://github.com/dorny/paths-filter (which we have forked to https://github.com/getsentry/paths-filter)
+
+markdown_lintable:
+ - "**/*.md"
+ - "**/*.mdx"
+
+yaml_lintable:
+ - "**/*.yml"
+ - "**/*.yaml"
diff --git a/.github/semantic.yml b/.github/semantic.yml
new file mode 100644
index 0000000..5aeb186
--- /dev/null
+++ b/.github/semantic.yml
@@ -0,0 +1,19 @@
+# In order to let this correctly work, install https://github.com/apps/semantic-pull-requests
+
+titleOnly: true
+types:
+ - "feat"
+ - "fix"
+ - "docs"
+ - "dx"
+ - "refactor"
+ - "perf"
+ - "test"
+ - "workflow"
+ - "build"
+ - "ci"
+ - "chore"
+ - "types"
+ - "wip"
+ - "release"
+ - "deps"
diff --git a/.github/settings.yml b/.github/settings.yml
new file mode 100644
index 0000000..a55e0fb
--- /dev/null
+++ b/.github/settings.yml
@@ -0,0 +1,182 @@
+# https://github.com/probot/settings
+
+branches:
+ - name: "main"
+
+ # https://docs.github.com/en/rest/reference/repos#delete-branch-protection
+ # https://docs.github.com/en/rest/reference/repos#update-branch-protection
+
+ protection:
+ enforce_admins: false
+
+ required_pull_request_reviews:
+ dismiss_stale_reviews: true
+ require_code_owner_reviews: true
+ required_approving_review_count: 1
+
+ required_status_checks:
+ contexts: []
+
+ strict: false
+
+ restrictions:
+ # https://developer.github.com/v3/repos/branches/#parameters-1
+
+ # Note: User, app, and team restrictions are only available for organization-owned repositories.
+ # Set to null to disable when using this configuration for a repository on a personal account.
+
+ apps:
+ - "semantic-release-bot"
+ - "renovate"
+ teams: []
+# users: []
+
+# https://docs.github.com/en/rest/reference/issues#create-a-label
+# https://docs.github.com/en/rest/reference/issues#update-a-label
+
+labels:
+ - name: "s: needs decision"
+ description: "Needs team/maintainer decision"
+ color: "C453C3"
+
+ - name: "s: needs proposal"
+ description: "Changelog Fixed"
+ color: "fbca04"
+
+ - name: "s: needs design"
+ description: "Changelog Fixed"
+ color: "fbca04"
+
+ - name: "s: accepted"
+ description: "Accepted feature / Confirmed bug"
+ color: "0E8A16"
+
+ - name: "s: awaiting more info"
+ description: "Additional information are requested"
+ color: "B76026"
+
+ - name: "s: invalid"
+ description: "This doesn't seem right"
+ color: "E4E669"
+
+ - name: "s: on hold"
+ description: "Blocked by something or frozen to avoid conflicts"
+ color: "A03F0B"
+
+ - name: "s: pending triage"
+ description: "Pending Triage"
+ color: "dddddd"
+
+ - name: "s: waiting for user interest"
+ description: "Waiting for more users interested in this feature"
+ color: "4B02CE"
+
+ - name: "wontfix"
+ description: "This will not be worked on"
+ color: "ffffff"
+
+ - name: "question"
+ description: "Further information is requested"
+ color: "956692"
+
+ - name: "p: 1-normal"
+ description: "Nothing urgent"
+ color: "BFDADC"
+
+ - name: "p: 2-high"
+ description: "Fix main branch"
+ color: "FF4d4d"
+
+ - name: "p: 3-urgent"
+ description: "Fix and release ASAP"
+ color: "FF0000"
+
+ - name: "needs test"
+ description: "More tests are needed"
+ color: "FAF1A2"
+
+ - name: "needs rebase"
+ description: "There is a merge conflict"
+ color: "32345B"
+
+ - name: "c: bug"
+ description: "Something isn't working"
+ color: "FFA500"
+
+ - name: "c: chore"
+ description: "PR that doesn't affect the runtime behavior"
+ color: "40E0D0"
+
+ - name: "c: docs"
+ description: "Improvements or additions to documentation"
+ color: "FFFF00"
+
+ - name: "c: dependencies"
+ description: "Pull requests that adds/updates a dependency"
+ color: "AFEEEE"
+
+ - name: "c: feature"
+ description: "Request for new feature"
+ color: "2878FF"
+
+ - name: "c: infra"
+ description: "Changes to our infrastructure or project setup"
+ color: "2c3e50"
+
+ - name: "c: refactor"
+ description: "PR that affects the runtime behavior, but doesn't add new features or fixes bugs"
+ color: "40E0D0"
+
+ - name: "c: security"
+ description: "Indicates a vulnarability"
+ color: "B60205"
+
+ - name: "deprecation"
+ description: "A deprecation was made in the PR"
+ color: "C5DEF5"
+
+ - name: "do NOT merge yet"
+ description: "Do not merge this PR into the target branch yet"
+ color: "FF0205"
+
+ - name: "duplicate"
+ description: "Duplicate of another issue/PR"
+ color: "fef2c0"
+
+ - name: "good first issue"
+ description: "Good for newcomers"
+ color: "7057ff"
+
+ - name: "has workaround"
+ description: "Workaround provided or linked"
+ color: "4049AD"
+
+ - name: "help wanted"
+ description: "Extra attention is needed"
+ color: "008672"
+
+ - name: "breaking change"
+ description: "Cannot be merged when next version is not a major release"
+ color: "B05D08"
+
+# https://docs.github.com/en/rest/reference/repos#update-a-repository
+
+repository:
+ allow_merge_commit: true
+ allow_rebase_merge: false
+ allow_squash_merge: false
+ archived: false
+ default_branch: "main"
+ delete_branch_on_merge: true
+ description: "Shareable config for Renovate (renovatebot.com)"
+ has_downloads: true
+ has_issues: true
+ has_pages: false
+ has_projects: false
+ has_wiki: false
+ name: "renovate-config"
+ private: false
+
+ # https://developer.github.com/v3/repos/branches/#remove-branch-protection
+
+ topics: "renovate renovate-config anolilab javascript github actions github-actions preset"
diff --git a/.github/workflows/cache-clear.yml b/.github/workflows/cache-clear.yml
new file mode 100644
index 0000000..d4222e1
--- /dev/null
+++ b/.github/workflows/cache-clear.yml
@@ -0,0 +1,39 @@
+name: "cleanup caches by a branch"
+
+on: # yamllint disable-line rule:truthy
+ pull_request:
+ types:
+ - "closed"
+
+jobs:
+ cleanup:
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - name: "Check out code"
+ uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+
+ - name: "Cleanup"
+ run: |
+ gh extension install actions/gh-actions-cache
+
+ REPO=${{ github.repository }}
+ BRANCH="refs/pull/${{ github.event.pull_request.number }}/merge"
+
+ echo "Fetching list of cache key"
+ cacheKeysForPR=$(gh actions-cache list -R $REPO -B $BRANCH | cut -f 1 )
+
+ ## Setting this to not fail the workflow while deleting cache keys.
+ set +e
+ echo "Deleting caches..."
+ for cacheKey in $cacheKeysForPR
+ do
+ gh actions-cache delete $cacheKey -R $REPO -B $BRANCH --confirm
+ done
+ echo "Done"
+ env:
+ GH_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
new file mode 100644
index 0000000..6252948
--- /dev/null
+++ b/.github/workflows/codeql.yml
@@ -0,0 +1,80 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on: # yamllint disable-line rule:truthy
+ push:
+ branches: ["main"]
+ pull_request:
+ # The branches below must be a subset of the branches above
+ branches: ["main"]
+ schedule:
+ - cron: "0 0 * * 1"
+
+permissions:
+ contents: "read"
+
+jobs:
+ analyze:
+ name: "Analyze"
+
+ runs-on: "ubuntu-latest"
+
+ permissions:
+ actions: "read"
+ contents: "read"
+ security-events: "write"
+
+ strategy:
+ fail-fast: false
+ matrix:
+ language: ["javascript", "typescript"]
+ # CodeQL supports [ $supported-codeql-languages ]
+ # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - name: "Checkout repository"
+ uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+
+ # Initializes the CodeQL tools for scanning.
+ - name: "Initialize CodeQL"
+ uses: "github/codeql-action/init@74483a38d39275f33fcff5f35b679b5ca4a26a99" # v2.22.5
+ with:
+ languages: "${{ matrix.language }}"
+ # If you wish to specify custom queries, you can do so here or in a config file.
+ # By default, queries listed here will override any specified in a config file.
+ # Prefix the list here with "+" to use these queries and those in the config file.
+
+ # 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@74483a38d39275f33fcff5f35b679b5ca4a26a99" # v2.22.5
+
+ # âšī¸ Command-line programs to run using the OS shell.
+ # đ See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+ # If the Autobuild fails above, remove it and uncomment the following three lines.
+ # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+ # - run: |
+ # echo "Run, Build Application using script"
+ # ./location_of_script_within_repo/buildscript.sh
+
+ - name: "Perform CodeQL Analysis"
+ uses: "github/codeql-action/analyze@74483a38d39275f33fcff5f35b679b5ca4a26a99" # v2.22.5
+ with:
+ category: "/language:${{matrix.language}}"
diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
new file mode 100644
index 0000000..e8aa1bf
--- /dev/null
+++ b/.github/workflows/dependency-review.yml
@@ -0,0 +1,35 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request,
+# surfacing known-vulnerable versions of the packages declared or updated in the PR.
+# Once installed, if the workflow run is marked as required,
+# PRs introducing known-vulnerable packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+name: "Dependency Review"
+
+on: # yamllint disable-line rule:truthy
+ # eslint-disable-next-line yml/no-empty-mapping-value
+ pull_request: # yamllint disable-line rule:empty-values
+
+permissions:
+ contents: "read"
+
+jobs:
+ dependency-review:
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - name: "Git checkout"
+ uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+ env:
+ GIT_COMMITTER_NAME: "GitHub Actions Shell"
+ GIT_AUTHOR_NAME: "GitHub Actions Shell"
+ EMAIL: "github-actions[bot]@users.noreply.github.com"
+
+ - name: "Dependency Review"
+ uses: "actions/dependency-review-action@6c5ccdad469c9f8a2996bfecaec55a631a347034" # v3.1.0
diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml
new file mode 100644
index 0000000..f1030af
--- /dev/null
+++ b/.github/workflows/greetings.yml
@@ -0,0 +1,27 @@
+# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
+
+name: "Greetings"
+
+on: ["pull_request", "issues"] # yamllint disable-line rule:truthy
+
+permissions:
+ contents: "read"
+
+jobs:
+ greeting:
+ permissions:
+ issues: "write" # for actions/first-interaction to comment on first issue
+ pull-requests: "write" # for actions/first-interaction to comment on first PR
+ runs-on: "ubuntu-latest"
+
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - uses: "actions/first-interaction@1dbfe1ba5525b8257e1f259b09745bee346d62d8" # v1.2.0
+ with:
+ repo-token: "${{ secrets.GITHUB_TOKEN }}"
+ issue-message: "Awesome! Thank you for taking the time to create your first issue! Please review the [guidelines](https://narrowspark.com/docs/current/contributing)"
+ pr-message: "Great! Thank you for taking the time to create your first pull request! Please review the [guidelines](https://narrowspark.com/docs/current/contributing)"
diff --git a/.github/workflows/introspect.yml b/.github/workflows/introspect.yml
new file mode 100644
index 0000000..1d98530
--- /dev/null
+++ b/.github/workflows/introspect.yml
@@ -0,0 +1,39 @@
+name: "CI"
+
+on: # yamllint disable-line rule:truthy
+ push:
+ paths:
+ - ".github/workflows/**"
+ branches:
+ - "main"
+ pull_request:
+ paths:
+ - ".github/workflows/**"
+ branches:
+ - "main"
+ - "!v[0-9]*"
+
+permissions:
+ contents: "read"
+
+jobs:
+ lint-workflows:
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - name: "Git checkout"
+ uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+ env:
+ GIT_COMMITTER_NAME: "GitHub Actions Shell"
+ GIT_AUTHOR_NAME: "GitHub Actions Shell"
+ EMAIL: "github-actions[bot]@users.noreply.github.com"
+
+ # From https://github.com/rhysd/actionlint/blob/main/docs/usage.md#use-actionlint-on-github-actions
+ - name: "Check workflow files"
+ run: |
+ bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)
+ ./actionlint -color -shellcheck=""
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
new file mode 100644
index 0000000..ce4a46b
--- /dev/null
+++ b/.github/workflows/lint.yml
@@ -0,0 +1,132 @@
+# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
+
+name: "Lint"
+
+on: # yamllint disable-line rule:truthy
+ push:
+ branches:
+ - "main"
+ # eslint-disable-next-line yml/no-empty-mapping-value
+ pull_request: # yamllint disable-line rule:empty-values
+
+concurrency:
+ group: "ci-lint-${{ github.ref }}-1"
+ cancel-in-progress: true
+
+permissions:
+ contents: "read" # to fetch code (actions/checkout)
+
+jobs:
+ files-changed:
+ name: "Detect what files changed"
+ runs-on: "ubuntu-22.04"
+ timeout-minutes: 3
+ # Map a step output to a job output
+ outputs:
+ markdown_lintable: "${{ steps.changes.outputs.markdown_lintable }}"
+ yaml_lintable: "${{ steps.changes.outputs.yaml_lintable }}"
+ steps:
+ - name: "Git checkout"
+ uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+ env:
+ GIT_COMMITTER_NAME: "GitHub Actions Shell"
+ GIT_AUTHOR_NAME: "GitHub Actions Shell"
+ EMAIL: "github-actions[bot]@users.noreply.github.com"
+
+ - name: "Check for file changes"
+ uses: "dorny/paths-filter@4512585405083f25c027a35db413c2b3b9006d50" # v2.11.1
+ id: "changes"
+ with:
+ token: "${{ github.token }}"
+ filters: ".github/file-filters.yml"
+
+ yaml-lint:
+ if: "needs.files-changed.outputs.yaml_lintable == 'true'"
+ needs: "files-changed"
+ name: "Lint (yaml)"
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - name: "Git checkout"
+ uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+ with:
+ fetch-depth: 2
+ env:
+ GIT_COMMITTER_NAME: "GitHub Actions Shell"
+ GIT_AUTHOR_NAME: "GitHub Actions Shell"
+ EMAIL: "github-actions[bot]@users.noreply.github.com"
+
+ - name: "Lint YAML files"
+ uses: "ibiqlik/action-yamllint@2576378a8e339169678f9939646ee3ee325e845c" # v3.1.1
+ with:
+ config_file: ".yamllint.yaml"
+ file_or_dir: "."
+ strict: true
+
+ markdown-lint:
+ if: "needs.files-changed.outputs.markdown_lintable == 'true'"
+ needs: "files-changed"
+ name: "Lint (markdown)"
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - name: "Git checkout"
+ uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+ with:
+ fetch-depth: 2
+ env:
+ GIT_COMMITTER_NAME: "GitHub Actions Shell"
+ GIT_AUTHOR_NAME: "GitHub Actions Shell"
+ EMAIL: "github-actions[bot]@users.noreply.github.com"
+
+ - uses: "pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598" # v2.4.0
+ with:
+ version: 8
+ run_install: false
+
+ - name: "Use Node.js 18.x"
+ uses: "actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65" # v4.0.0
+ with:
+ node-version: "18.x"
+ cache: "pnpm"
+
+ - name: "Install packages"
+ run: "pnpm install --frozen-lockfile"
+ env:
+ SKIP_BUILD: "true"
+ SKIP_CHECK: "true"
+
+ - name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
+ run: "npm audit signatures"
+
+ - name: "lint"
+ run: "pnpm run lint:text"
+ continue-on-error: true
+
+ - name: "skipping markdown lint for now"
+ run: "exit 0"
+
+ # This check runs once all dependant jobs have passed
+ # It symbolizes that all required Frontend checks have succesfully passed (Or skipped)
+ # This check is the only required Github check
+ test-required-check:
+ needs: ["files-changed", "yaml-lint"] # TODO add "markdown-lint"
+ name: "Check Lint Run"
+ # This is necessary since a failed/skipped dependent job would cause this job to be skipped
+ if: "always()"
+ runs-on: "ubuntu-22.04"
+ steps:
+ # If any jobs we depend on fail, we will fail since this is a required check
+ # NOTE: A timeout is considered a failure
+ - name: "Check for failures"
+ if: "contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')"
+ run: |
+ echo "One of the dependent jobs have failed. You may need to re-run it." && exit 1
diff --git a/.github/workflows/scorecards.yml b/.github/workflows/scorecards.yml
new file mode 100644
index 0000000..2d99001
--- /dev/null
+++ b/.github/workflows/scorecards.yml
@@ -0,0 +1,78 @@
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: "Scorecard supply-chain security"
+
+on: # yamllint disable-line rule:truthy
+ # For Branch-Protection check. Only the default branch is supported. See
+ # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+ # eslint-disable-next-line yml/no-empty-mapping-value
+ branch_protection_rule: # yamllint disable-line rule:empty-values
+ # To guarantee Maintained check is occasionally updated. See
+ # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+ schedule:
+ - cron: "20 7 * * 2"
+ push:
+ branches: ["main"]
+
+# Declare default permissions as read only.
+permissions: "read-all"
+
+jobs:
+ analysis:
+ name: "Scorecard analysis"
+ runs-on: "ubuntu-latest"
+ permissions:
+ # Needed to upload the results to code-scanning dashboard.
+ security-events: "write"
+ # Needed to publish results and get a badge (see publish_results below).
+ id-token: "write"
+ contents: "read"
+ actions: "read"
+
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - name: "Checkout code"
+ uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+ with:
+ persist-credentials: false
+
+ - name: "Run analysis"
+ uses: "ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736" # v2.3.1
+ with:
+ results_file: "results.sarif"
+ results_format: "sarif"
+ # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+ # - you want to enable the Branch-Protection check on a *public* repository, or
+ # - you are installing Scorecards on a *private* repository
+ # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
+ # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+ # Public repositories:
+ # - Publish results to OpenSSF REST API for easy access by consumers
+ # - Allows the repository to include the Scorecard badge.
+ # - See https://github.com/ossf/scorecard-action#publishing-results.
+ # For private repositories:
+ # - `publish_results` will always be set to `false`, regardless
+ # of the value entered here.
+ publish_results: true
+
+ # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+ # format to the repository Actions tab.
+ - name: "Upload artifact"
+ uses: "actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32" # v3.1.3
+ with:
+ name: "SARIF file"
+ path: "results.sarif"
+ retention-days: 5
+
+ # Upload the results to GitHub's code scanning dashboard.
+ - name: "Upload to code-scanning"
+ uses: "github/codeql-action/upload-sarif@74483a38d39275f33fcff5f35b679b5ca4a26a99" # v2.22.5
+ with:
+ sarif_file: "results.sarif"
diff --git a/.github/workflows/semantic-pull-request.yml b/.github/workflows/semantic-pull-request.yml
new file mode 100644
index 0000000..5b7aeba
--- /dev/null
+++ b/.github/workflows/semantic-pull-request.yml
@@ -0,0 +1,42 @@
+# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
+
+name: "Semantic Pull Request"
+
+on: # yamllint disable-line rule:truthy
+ pull_request_target:
+ types:
+ - "opened"
+ - "edited"
+ - "synchronize"
+
+permissions: {}
+
+jobs:
+ main:
+ permissions:
+ pull-requests: "read" # to analyze PRs (amannn/action-semantic-pull-request)
+ statuses: "write" # to mark status of analyzed PR (amannn/action-semantic-pull-request)
+ runs-on: "ubuntu-latest"
+ name: "Semantic Pull Request"
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - name: "Validate PR title"
+ uses: "amannn/action-semantic-pull-request@47b15d52c5c30e94a17ec87eb8dd51ff5221fed9" # v5.3.0
+ env:
+ GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+ with:
+ types: |
+ feat
+ fix
+ chore
+ refactor
+ docs
+ test
+ ci
+ build
+ infra
+ revert
diff --git a/.github/workflows/semantic-release.yml b/.github/workflows/semantic-release.yml
new file mode 100644
index 0000000..4d463a4
--- /dev/null
+++ b/.github/workflows/semantic-release.yml
@@ -0,0 +1,96 @@
+# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
+
+name: "Semantic Release"
+
+on: # yamllint disable-line rule:truthy
+ push:
+ branches:
+ - "([0-9])?(.{+([0-9]),x}).x"
+ - "main"
+ - "next"
+ - "next-major"
+ - "alpha"
+ - "beta"
+
+permissions:
+ contents: "read" # for checkout
+
+jobs:
+ semantic-release:
+ name: "Semantic Release"
+ runs-on: "ubuntu-latest"
+ permissions:
+ contents: "write" # to be able to publish a GitHub release
+ issues: "write" # to be able to comment on released issues
+ pull-requests: "write" # to be able to comment on released pull requests
+ id-token: "write" # to enable use of OIDC for npm provenance
+
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - name: "Wait for tests to succeed"
+ uses: "lewagon/wait-on-check-action@e106e5c43e8ca1edea6383a39a01c5ca495fd812" # v1.3.1
+ timeout-minutes: 20
+ with:
+ ref: "${{ github.event.pull_request.head.sha || github.sha }}"
+ repo-token: "${{ secrets.GITHUB_TOKEN }}"
+ wait-interval: 60 # seconds
+ running-workflow-name: "Semantic Release" # wait for all other checks to complete
+ allowed-conclusions: "success,skipped" # all other checks must pass, being skipped or cancelled is not sufficient
+
+ - name: "Git checkout"
+ uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+ with:
+ fetch-depth: 0
+ persist-credentials: false
+ env:
+ GIT_COMMITTER_NAME: "GitHub Actions Shell"
+ GIT_AUTHOR_NAME: "GitHub Actions Shell"
+ EMAIL: "github-actions[bot]@users.noreply.github.com"
+
+ - uses: "pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598" # v2.4.0
+ with:
+ version: 8
+ run_install: false
+
+ - name: "Use Node.js 20.x"
+ uses: "actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65" # v4.0.0
+ with:
+ node-version: "20.6.1"
+ cache: "pnpm"
+
+ # @see: npm install -g npm@latest is necessary to make provenance available. More info: https://docs.npmjs.com/generating-provenance-statements
+ - name: "Upgrade npm to latest version"
+ run: "npm install --global npm@9.6.x"
+ env:
+ SKIP_CHECK: "true"
+
+ - name: "Check npm version"
+ run: "npm -v"
+ env:
+ SKIP_CHECK: "true"
+
+ - name: "Install packages"
+ run: "pnpm install --frozen-lockfile"
+ env:
+ SKIP_BUILD: "true"
+
+ - name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
+ run: "npm audit signatures"
+
+ - name: "npm v8.5+ requires workspaces-update to be set to false"
+ run: "echo 'workspaces-update=false' >> .npmrc"
+
+ - name: "Semantic Release"
+ if: "success()"
+ env:
+ GITHUB_TOKEN: "${{ secrets.SEMANTIC_RELEASE_GITHUB_TOKEN }}"
+ NPM_TOKEN: "${{ secrets.NPM_AUTH_TOKEN }}"
+ GIT_AUTHOR_NAME: "github-actions-shell"
+ GIT_AUTHOR_EMAIL: "github-actions[bot]@users.noreply.github.com"
+ GIT_COMMITTER_NAME: "github-actions-shell"
+ GIT_COMMITTER_EMAIL: "github-actions[bot]@users.noreply.github.com"
+ run: "pnpm exec semantic-release"
diff --git a/.github/workflows/stale-issues.yml b/.github/workflows/stale-issues.yml
new file mode 100644
index 0000000..253e32e
--- /dev/null
+++ b/.github/workflows/stale-issues.yml
@@ -0,0 +1,108 @@
+# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
+
+name: "Close stale issues"
+
+on: # yamllint disable-line rule:truthy
+ schedule:
+ - cron: "0 0 * * *"
+
+permissions:
+ contents: "read"
+
+jobs:
+ default:
+ permissions:
+ issues: "write" # for actions/stale to close stale issues
+ pull-requests: "write" # for actions/stale to close stale PRs
+ timeout-minutes: 1
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - uses: "actions/stale@1160a2240286f5da8ec72b1c0816ce2481aabf84" # v8.0.0
+ with:
+ repo-token: "${{ secrets.GITHUB_TOKEN }}"
+ stale-issue-message: |
+ This issue has been automatically marked as stale because it has been open for 21 days with no activity.
+ It will be closed in 7 days if no further activity (Remove label or comment) occurs.
+ If we missed this issue please reply to keep it active.
+ Thanks for being a part of this project. đ
+ stale-issue-label: "Stale"
+ remove-stale-when-updated: true
+ exempt-issue-labels: "Added,Enhancement,Changed,Deprecated,Fixed,Removed,Security,Status: Help wanted,Status: Needs Work,Status: Waiting for feedback,Type: Unconfirmed,Type: Bug"
+ days-before-stale: 21
+ days-before-close: 7
+
+ invalid:
+ permissions:
+ issues: "write" # for actions/stale to close stale issues
+ pull-requests: "write" # for actions/stale to close stale PRs
+ timeout-minutes: 1
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - uses: "actions/stale@1160a2240286f5da8ec72b1c0816ce2481aabf84" # v8.0.0
+ with:
+ repo-token: "${{ secrets.GITHUB_TOKEN }}"
+ stale-issue-message: |
+ This issue has been automatically marked as stale because it has been labeled as invalid.
+ Thanks for being a part of this project. đ
+ stale-issue-label: "Stale"
+ only-labels: "Type: Unconfirmed"
+ days-before-stale: 1
+ days-before-close: 2
+
+ duplicate:
+ permissions:
+ issues: "write" # for actions/stale to close stale issues
+ pull-requests: "write" # for actions/stale to close stale PRs
+ timeout-minutes: 1
+ runs-on: "ubuntu-latest"
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - uses: "actions/stale@1160a2240286f5da8ec72b1c0816ce2481aabf84" # v8.0.0
+ with:
+ repo-token: "${{ secrets.GITHUB_TOKEN }}"
+ stale-issue-message: |
+ This issue has been automatically marked as stale because it has been labeled as duplicate.
+ Thanks for being a part of this project. đ
+ stale-issue-label: "Stale"
+ only-labels: "Duplicate"
+ days-before-stale: 1
+ days-before-close: 2
+
+ wontfix:
+ permissions:
+ issues: "write" # for actions/stale to close stale issues
+ pull-requests: "write" # for actions/stale to close stale PRs
+ timeout-minutes: 1
+
+ runs-on: "ubuntu-latest"
+
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - uses: "actions/stale@1160a2240286f5da8ec72b1c0816ce2481aabf84" # v8.0.0
+ with:
+ repo-token: "${{ secrets.GITHUB_TOKEN }}"
+ stale-issue-message: |
+ This issue has been automatically marked as stale because it has been labeled as wontfix.
+ Thanks for being a part of this project. đ
+ stale-issue-label: "Stale"
+ only-labels: "Type: Wontfix"
+ days-before-stale: 1
+ days-before-close: 2
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000..1d58cf1
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,56 @@
+# https://help.github.com/en/categories/automating-your-workflow-with-github-actions
+
+name: "Tests"
+
+on: # yamllint disable-line rule:truthy
+ push:
+ branches:
+ - "main"
+ # eslint-disable-next-line yml/no-empty-mapping-value
+ pull_request: # yamllint disable-line rule:empty-values
+
+concurrency:
+ group: "ci-tests-${{ github.ref }}-1"
+ cancel-in-progress: true
+
+permissions:
+ contents: "read"
+
+jobs:
+ test:
+ name: "Build & Unit Test: node-20"
+
+ runs-on: "ubuntu-latest"
+
+ steps:
+ - name: "Harden Runner"
+ uses: "step-security/harden-runner@1b05615854632b887b69ae1be8cbefe72d3ae423" # v2.6.0
+ with:
+ egress-policy: "audit"
+
+ - name: "Git checkout"
+ uses: "actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11" # v4.1.1
+ env:
+ GIT_COMMITTER_NAME: "GitHub Actions Shell"
+ GIT_AUTHOR_NAME: "GitHub Actions Shell"
+ EMAIL: "github-actions[bot]@users.noreply.github.com"
+
+ - uses: "pnpm/action-setup@d882d12c64e032187b2edb46d3a0d003b7a43598" # v2.4.0
+ with:
+ version: 8
+ run_install: false
+
+ - name: "Set node version to 20"
+ uses: "actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65" # v4.0.0
+ with:
+ node-version: "20"
+ cache: "pnpm"
+
+ - name: "Install packages"
+ run: "pnpm install --frozen-lockfile"
+ env:
+ SKIP_CHECK: "true"
+ SKIP_BUILD: "true"
+
+ - name: "Test"
+ run: "pnpm run test"
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..fc0d609
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,66 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env
+.env.test
+
+# misc
+.DS_Store
+*.pem
+.tmp
+
+# Storybook
+storybook-static/
+
+# JetBrains IDE
+/.idea
+
+# Optional textlint cache
+.textlintcache
+
+# Nx cache
+.nx/
+
+# Package build output
+dist
diff --git a/.husky/commit-msg b/.husky/commit-msg
new file mode 100755
index 0000000..34888c4
--- /dev/null
+++ b/.husky/commit-msg
@@ -0,0 +1,15 @@
+#!/bin/sh
+
+. "$(dirname "$0")/_/husky.sh"
+. "$(dirname "$0")/common.sh"
+
+# The hook should exit with non-zero status after issuing
+# an appropriate message if it wants to stop the commit.
+
+echo --------------------------------------------
+echo Starting Git hook: commit-msg
+
+pnpm exec commitlint --edit "${1}"
+
+echo Finished Git hook: commit-msg
+echo --------------------------------------------
diff --git a/.husky/common.sh b/.husky/common.sh
new file mode 100755
index 0000000..cb9671c
--- /dev/null
+++ b/.husky/common.sh
@@ -0,0 +1,22 @@
+#!/bin/sh
+
+command_exists () {
+ command -v "$1" >/dev/null 2>&1
+}
+
+IS_WINDOWS="false"
+
+if [ "$OSTYPE" = "cygwin" ]; then
+ IS_WINDOWS="true"
+elif [ "$OSTYPE" = "msys" ]; then
+ IS_WINDOWS="true"
+elif [ "$OSTYPE" = "win32" ]; then
+ IS_WINDOWS="true"
+fi
+
+# Workaround for Windows 10, Git Bash and Yarn
+if [ "$IS_WINDOWS" = "true" ]; then
+ if command_exists winpty && test -t 1; then
+ exec < /dev/tty
+ fi
+fi
diff --git a/.husky/post-commit b/.husky/post-commit
new file mode 100755
index 0000000..a2499f0
--- /dev/null
+++ b/.husky/post-commit
@@ -0,0 +1,15 @@
+#!/bin/sh
+
+. "$(dirname "$0")/_/husky.sh"
+. "$(dirname "$0")/common.sh"
+
+# The hook should exit with non-zero status after issuing
+# an appropriate message if it wants to stop the commit.
+
+echo --------------------------------------------
+echo Starting Git hook: post-commit
+
+git update-index --again
+
+echo Finished Git hook: post-commit
+echo --------------------------------------------
diff --git a/.husky/pre-commit b/.husky/pre-commit
new file mode 100755
index 0000000..7062c41
--- /dev/null
+++ b/.husky/pre-commit
@@ -0,0 +1,15 @@
+#!/bin/sh
+
+. "$(dirname "$0")/_/husky.sh"
+. "$(dirname "$0")/common.sh"
+
+# The hook should exit with non-zero status after issuing
+# an appropriate message if it wants to stop the commit.
+
+echo --------------------------------------------
+echo Starting Git hook: pre-commit
+
+pnpx lint-staged --verbose --concurrent false
+
+echo Finished Git hook: pre-commit
+echo --------------------------------------------
diff --git a/.husky/prepare-commit-msg b/.husky/prepare-commit-msg
new file mode 100755
index 0000000..a5db2fc
--- /dev/null
+++ b/.husky/prepare-commit-msg
@@ -0,0 +1,40 @@
+#!/bin/sh
+
+. "$(dirname "$0")/_/husky.sh"
+. "$(dirname "$0")/common.sh"
+
+echo --------------------------------------------
+echo Starting Git hook: prepare-commit-msg
+# if we hve a cmd that is running pnpx cz that means finalize and commit
+FILE=commit.cmd
+if test -f "$FILE"; then
+ echo "$FILE exists."
+ rm commit.cmd
+ exit 0;
+fi
+# if on Windows, spawn a cmd that will run pnpx cz
+case `uname` in
+ *CYGWIN*|*MINGW*|*MSYS* )
+ # Only run commitizen if no commit message was already provided.
+ if [ -z "${2-}" ]; then
+ export CZ_TYPE="${CZ_TYPE:-fix}"
+ export CZ_MAX_HEADER_WIDTH=$COMMITLINT_MAX_WIDTH
+ export CZ_MAX_LINE_WIDTH=$CZ_MAX_HEADER_WIDTH
+ echo "pnpx cz && exit" > commit.cmd
+ start commit.cmd
+ exit 1;
+ fi
+
+ exit 0;;
+esac
+# Only run commitizen if no commit message was already provided.
+if [ -z "${2-}" ]; then
+ export CZ_TYPE="${CZ_TYPE:-fix}"
+ export CZ_MAX_HEADER_WIDTH=$COMMITLINT_MAX_WIDTH
+ export CZ_MAX_LINE_WIDTH=$CZ_MAX_HEADER_WIDTH
+ # By default git hooks are not interactive. exec < /dev/tty allows a users terminal to interact with commitizen.
+ exec < /dev/tty && pnpx cz --hook || true
+fi
+
+echo Finished Git hook: prepare-commit-msg
+echo --------------------------------------------
diff --git a/.lintstagedrc.cjs b/.lintstagedrc.cjs
new file mode 100644
index 0000000..aa6d8e4
--- /dev/null
+++ b/.lintstagedrc.cjs
@@ -0,0 +1,5 @@
+const config = require("@anolilab/lint-staged-config");
+
+module.exports = {
+ ...config,
+};
diff --git a/.nvmrc b/.nvmrc
new file mode 100644
index 0000000..209e3ef
--- /dev/null
+++ b/.nvmrc
@@ -0,0 +1 @@
+20
diff --git a/.prettierignore b/.prettierignore
new file mode 100644
index 0000000..4e97a40
--- /dev/null
+++ b/.prettierignore
@@ -0,0 +1,11 @@
+**/.git
+**/.svn
+**/.hg
+
+**/node_modules
+
+**/CHANGELOG.md
+
+pnpm-lock.yaml
+pnpm-workspace.yaml
+
diff --git a/.prettierrc.cjs b/.prettierrc.cjs
new file mode 100644
index 0000000..adafa69
--- /dev/null
+++ b/.prettierrc.cjs
@@ -0,0 +1,5 @@
+var config = require("@anolilab/prettier-config");
+
+module.exports = {
+ ...config,
+};
diff --git a/.releaserc.json b/.releaserc.json
new file mode 100644
index 0000000..0302c28
--- /dev/null
+++ b/.releaserc.json
@@ -0,0 +1,3 @@
+{
+ "extends": "@anolilab/semantic-release-preset"
+}
diff --git a/.secretlintignore b/.secretlintignore
new file mode 100644
index 0000000..1bb88d7
--- /dev/null
+++ b/.secretlintignore
@@ -0,0 +1,2 @@
+.pnpm-store
+node_modules
diff --git a/.secretlintrc.cjs b/.secretlintrc.cjs
new file mode 100644
index 0000000..418ad9c
--- /dev/null
+++ b/.secretlintrc.cjs
@@ -0,0 +1,7 @@
+module.exports = {
+ rules: [
+ {
+ id: "@secretlint/secretlint-rule-preset-recommend",
+ },
+ ],
+};
diff --git a/.textlintignore b/.textlintignore
new file mode 100644
index 0000000..9bbb301
--- /dev/null
+++ b/.textlintignore
@@ -0,0 +1,2 @@
+**/CHANGELOG.md
+**/LICENSE.md
diff --git a/.textlintrc b/.textlintrc
new file mode 100644
index 0000000..4849c91
--- /dev/null
+++ b/.textlintrc
@@ -0,0 +1,136 @@
+{
+ "@textlint/markdown": {
+ "extensions": [".md", ".mdx"]
+ },
+ "filters": {
+ "comments": true
+ },
+ "rules": {
+ "en-capitalization": true,
+ "footnote-order": true,
+ "no-todo": true,
+ "no-dead-link": {
+ "ignore": ["bc_data_*"]
+ },
+ "no-empty-section": true,
+ "terminology": true,
+ "apostrophe": true,
+ "diacritics": true,
+ "@textlint-rule/no-invalid-control-character": true,
+ "@textlint-rule/no-unmatched-pair": true,
+ "abbr-within-parentheses": true,
+ "alex": {
+ "allow": ["period", "european", "failure", "fore", "attack", "execution", "executed", "remain", "execute"]
+ },
+ "@textlint-rule/preset-google": true,
+ "write-good": {
+ "passive": false,
+ "eprime": false
+ },
+ "common-misspellings": true,
+ "terminology": {
+ "defaultTerms": false,
+ "terms": [
+ // Abbreviations
+ "API",
+ ["API['â]?s", "APIs"],
+ "Ajax",
+ "CLI",
+ "CSS",
+ "CORS",
+ ["^E2E", "E2E"],
+ "gif",
+ ["^HTML", "HTML"],
+ ["^URL(s?)", "URL$1"],
+ ["^HTTP", "HTTP"],
+ ["^HTTPS", "HTTPS"],
+ "SSO",
+ ["^XHR(s?)", "XHR$1"],
+ ["^XHR['â]?s", "XHRs"],
+ "Xvfb",
+ "YAML",
+
+ // Words and phrases
+ ["\\(s\\)he", "they"],
+ ["he or she", "they"],
+ ["he/she", "they"],
+ ["crazy", "complex"],
+ ["crazier", "more complex"],
+ ["craziest", "most complex"],
+ ["dumb", "unintended"],
+ ["insane", "outrageous"],
+
+ // Prefer American spelling
+ ["behaviour", "behavior"],
+ ["cancelled", "canceled"],
+ ["cancelling", "canceling"],
+ ["centre", "center"],
+ ["colour", "color"],
+ ["customise", "customize"],
+ ["customisation", "customization"],
+ ["favourite", "favorite"],
+ ["labelled", "labeled"],
+ ["licence", "license"],
+ ["organise", "organize"],
+
+ // Common misspellings
+ ["gaurantee", "guarantee"],
+
+ // Words we would like to not use altogether
+ ["simply", ""],
+
+ // Single word
+ ["change[- ]log(s?)", "changelog$1"],
+ ["code[- ]base(es?)", "codebase$1"],
+ ["e[- ]mail(s?)", "email$1"],
+ ["end[- ]point(s?)", "endpoint$1"],
+ ["file[- ]name(s?)", "filename$1"],
+ ["can[- ]not", "cannot$1"],
+
+ // Multiple words
+ ["back-?end(s?)", "back end$1"],
+ ["front-?end(s?)", "front end$1"],
+ ["full-?stack(s?)", "full stack$1"],
+ ["open-?source(ed?)", "open source$1"],
+ ["web-?page(s?)", "web page$1"],
+
+ // Hyphenated
+ ["end ?to ?end", "end-to-end"],
+ ["retryability", "retry-ability"],
+ ["retriability", "retry-ability"],
+
+ ["some", ""],
+ ["filetype", "file type"],
+ ["stylesheet", "style sheet"],
+ ["like this", ""],
+ ["probably", ""],
+ ["known as", ""],
+ ["really", ""],
+ ["just", ""],
+ ["simple", ""],
+ ["obvious", ""],
+ ["straightforward", ""],
+ ["very", ""],
+ ["a little", ""],
+ ["note that", ""],
+ ["good to note", ""],
+ ["good to remember", ""],
+ ["basically", ""],
+ ["actually", ""],
+ ["pretty", ""],
+ ["easy", ""],
+ ["interesting", ""],
+ ["way to", ""],
+ ["In order to", "To"],
+ ["in order to", "to"],
+ ["might", ""],
+ ["us", ""],
+ ["I'll", ""],
+ ["I've", ""],
+ ["they'll", ""],
+ ["it is", "it's"],
+ ["It is", "It's"]
+ ]
+ }
+ }
+}
diff --git a/.yamllint.yaml b/.yamllint.yaml
new file mode 100644
index 0000000..338ae7d
--- /dev/null
+++ b/.yamllint.yaml
@@ -0,0 +1,75 @@
+extends: "default"
+
+ignore: |
+ .build/
+ .docker/
+ vendor/
+ node_modules/
+ .yarnrc.yml
+ .yarn/
+ .pnpm-lock.yaml
+ .pnpm-workspaces.yaml
+ *lock.yaml
+ *workspace.yaml
+ chromatic.yml
+ __fixtures__/
+
+rules:
+ braces:
+ max-spaces-inside-empty: 0
+ max-spaces-inside: 1
+ min-spaces-inside-empty: 0
+ min-spaces-inside: 1
+ brackets:
+ max-spaces-inside-empty: 0
+ max-spaces-inside: 0
+ min-spaces-inside-empty: 0
+ min-spaces-inside: 0
+ colons:
+ max-spaces-after: 1
+ max-spaces-before: 0
+ commas:
+ max-spaces-after: 1
+ max-spaces-before: 0
+ min-spaces-after: 1
+ comments:
+ ignore-shebangs: true
+ min-spaces-from-content: 1
+ require-starting-space: true
+ comments-indentation: "enable"
+ document-end:
+ present: false
+ document-start:
+ present: false
+ indentation:
+ check-multi-line-strings: false
+ indent-sequences: true
+ spaces: 4
+ empty-lines:
+ max-end: 0
+ max-start: 0
+ max: 1
+ empty-values:
+ forbid-in-block-mappings: true
+ forbid-in-flow-mappings: true
+ hyphens:
+ max-spaces-after: 4
+ key-duplicates: "enable"
+ key-ordering: "disable"
+ line-length: "disable"
+ new-line-at-end-of-file: "enable"
+ new-lines:
+ type: "unix"
+ octal-values:
+ forbid-implicit-octal: true
+ quoted-strings:
+ quote-type: "double"
+ trailing-spaces: "enable"
+ truthy:
+ allowed-values:
+ - "false"
+ - "true"
+
+yaml-files:
+ - "*.yaml"
+ - "*.yml"
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..e69de29
diff --git a/LICENSE b/LICENSE.md
similarity index 100%
rename from LICENSE
rename to LICENSE.md
diff --git a/README.md b/README.md
index 406bb7e..e82e958 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,75 @@
-# renovate-config
-Shareable config for Renovate (renovatebot.com)
+
+
+
Shared Renovate Config
+
+Shared config for the [renovate service](https://renovatebot.com).
+
+[![license-image]][license-url]
+
+
+
+---
+
+
+
+
+ Daniel Bannert's open source work is supported by the community on GitHub Sponsors
+
+
+