feat: initial migration from @guidepup/guidepup

Author: jlp-craigmorten

.eslintignore

@@ -0,0 +1,7 @@
+.github
+.vscode
+docs
+lib
+node_modules
+.eslintrc.js
+jest.config.js

.eslintrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+  ],
+  rules: { "sort-imports": ["error", { ignoreCase: true }] },
+};

.github/CODEOWNERS.md

@@ -0,0 +1 @@
+* @cmorten

.github/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing to this repository
+
+First of all, thanks for taking the time to read this document and contributing to our codebase!
+
+## Getting started
+
+If you're working on an existing issue then awesome! Let us know by dropping a comment in the issue.
+
+If it's a new bug fix or feature that you would like to contribute, then please raise an issue so it can be tracked (and to help out others who are experiencing the same issue / want the new thing know that it's being looked at!). Be sure to check for existing issues before raising your own!
+
+## Working on your feature
+
+### Branching
+
+On this project we follow mainline development (or trunk based development), and our default branch is `main`.
+
+Therefore you need to branch from `main` and merge into `main`.
+
+### Coding style
+
+Generally try to match the style and conventions of the code around your changes. Ultimately we want code that is clear, concise, consistent and easy to read.
+
+We use `eslint` and `prettier` for linting. You can check and correct the code style using the following commands:
+
+```console
+# Check linting
+yarn lint
+
+# Fix linting
+yarn lint:fix
+```
+
+### Tests
+
+Before opening a PR, please run the following command to make sure your branch will build and pass all the checks and tests:
+
+```console
+yarn test
+```
+
+## Opening a PR
+
+Once you're confident your branch is ready to review, open a PR against `main` on this repo.
+
+Please use the PR template as a guide, but if your change doesn't quite fit it, feel free to customize.
+
+## Merging and publishing
+
+When your feature branch / PR has been tested and has an approval, it is then ready to merge. Please contact a maintainer to action the merge.

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [cmorten]

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,12 @@
+# Issue
+
+Setup:
+
+- Node version: <replace_with_node_version (try `node --version`)>
+- Package version: <replace_with_package_version>
+- OS Platform: <replace_with_os_platform>
+- OS Release: <replace_with_os_release_version>
+
+## Details
+
+> Please replace this quote block with the details of the feature / bug you wish to be addressed. If it is a bug please do your best to add steps to reproduce.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+# Issue
+
+Fixes #<issue_number>.
+
+## Details
+
+> Please replace this quote block with a brief summary of PR purpose and code changes.
+
+## CheckList
+
+- [ ] Has been tested (where required).

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# 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:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '34 4 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      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.
+        # 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.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # 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@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      continue-on-error: true

.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+          always-auth: true
+      - run: yarn install --frozen-lockfile
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NODE_AUTH_TOKEN}}
+          CI: true

.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - run: yarn install --frozen-lockfile
+      - run: yarn ci