Merge pull request #1 from ubq-testing/development

`Start/Stop` plugin

.cspell.json

@@ -1,10 +1,10 @@
 {
   "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
   "version": "0.2",
-  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log"],
+  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "./src/adapters/supabase/**/**.ts"],
   "useGitignore": true,
   "language": "en",
-  "words": ["dataurl", "devpool", "outdir", "servedir"],
+  "words": ["dataurl", "devpool", "outdir", "servedir", "Supabase", "supabase", "SUPABASE", "typebox", "ubiquibot", "signoff", "sonarjs", "mswjs"],
   "dictionaries": ["typescript", "node", "software-terms"],
   "import": ["@cspell/dict-typescript/cspell-ext.json", "@cspell/dict-node/cspell-ext.json", "@cspell/dict-software-terms"],
   "ignoreRegExpList": ["[0-9a-fA-F]{6}"]

.dev.vars.example

@@ -0,0 +1,2 @@
+SUPABASE_URL=
+SUPABASE_KEY=

.github/cspell.ts

@@ -0,0 +1,10 @@
+const { exec } = require("child_process");
+
+exec('cspell "**/*"', (error, stdout, stderr) => {
+  if (error) {
+    console.error(`exec error: ${error}`);
+    return;
+  }
+  if (stdout) console.log(`stdout: ${stdout}`);
+  if (stderr) console.error(`stderr: ${stderr}`);
+});

.github/knip.ts

@@ -3,10 +3,10 @@ import type { KnipConfig } from "knip";
 const config: KnipConfig = {
   entry: ["build/index.ts"],
   project: ["src/**/*.ts"],
-  ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**"],
+  ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**", "src/worker.ts"],
   ignoreExportsUsedInFile: true,
   // eslint can also be safely ignored as per the docs: https://knip.dev/guides/handling-issues#eslint--jest
-  ignoreDependencies: ["eslint-config-prettier", "eslint-plugin-prettier", "@types/jest", "@mswjs/data"],
+  ignoreDependencies: ["eslint-config-prettier", "eslint-plugin-prettier", "@types/jest"],
   eslint: true,
 };
 

.github/workflows/cspell.yml

@@ -17,6 +17,9 @@ jobs:
         with:
           node-version: "20.10.0"
 
+      - name: Enable corepack
+        run: corepack enable
+
       - name: Install cspell
         run: yarn add cspell
 

.github/workflows/jest-testing.yml

@@ -1,8 +1,10 @@
 name: Run Jest testing suite
 on:
   workflow_dispatch:
-  pull_request:
-    types: [opened, synchronize]
+  workflow_run:
+    workflows: ["Knip"]
+    types:
+      - completed
 
 env:
   NODE_ENV: "test"
@@ -15,19 +17,18 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: "20.10.0"
+
       - uses: actions/checkout@master
         with:
           fetch-depth: 0
-      - name: Build & Run test suite
-        run: |
-          yarn
-          yarn test | tee ./coverage.txt && exit ${PIPESTATUS[0]}
-      - name: Jest Coverage Comment
+
+      - name: Enable corepack
+        run: corepack enable
+
+      - name: Jest With Coverage Comment
         # Ensures this step is run even on previous step failure (e.g. test failed)
         if: always()
-        uses: MishaKav/jest-coverage-comment@main
+        uses: ArtiomTr/jest-coverage-report-action@v2
         with:
-          coverage-summary-path: coverage/coverage-summary.json
-          junitxml-path: junit.xml
-          junitxml-title: JUnit
-          coverage-path: ./coverage.txt
+          package-manager: yarn
+          prnumber: ${{ github.event.pull_request.number || github.event.workflow_run.pull_requests[0].number }}

.github/workflows/knip.yml

@@ -17,6 +17,9 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20.10.0
+
+      - name: Enable corepack
+        run: corepack enable
 
       - name: Install toolchain
         run: yarn install

.github/workflows/worker-deploy.yml

@@ -0,0 +1,32 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+
+      - name: Enable corepack
+        run: corepack enable
+
+      - uses: actions/checkout@v4
+      - uses: cloudflare/wrangler-action@v3
+        with:
+          wranglerVersion: "3.57.0"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          secrets: |
+            SUPABASE_URL
+            SUPABASE_KEY
+        env:
+          SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
+          SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}

.gitignore

@@ -7,7 +7,11 @@ node_modules
 .pnp.cjs
 .pnp.loader.mjs
 .env
+.env.dev
+.dev.vars
 static/dist
 coverage
 junit.xml
 cypress/screenshots
+script.ts
+.wrangler

README.md

@@ -1,32 +1,56 @@
-# `@ubiquity/ts-template`
+# `@ubiquibot/command-start-stop`
 
-This template repository includes support for the following:
+This plugin allows a hunter to begin a task as well as gracefully stop a task without incurring a negative impact on the hunter's XP or karma.
 
-- TypeScript
-- Environment Variables
-- Conventional Commits
-- Automatic deployment to Cloudflare Pages
+## Usage
 
-## Testing
+### Start a task
 
-### Cypress
+To start a task, a hunter should use the `/start` command. This will assign them to the issue so long as the following is true:
 
-To test with Cypress Studio UI, run
+- Price labels are set on the issue
+- The issue is not already assigned
+- The hunter has not reached the maximum number of concurrent tasks
+- The command is not disabled at the repository or organization level
+- TODO: If the hunter meets the required XP requirements
 
-```shell
-yarn cy:open
-```
+### Stop a task
+
+To stop a task, a hunter should use the `/stop` command. This will unassign them from the issue so long as the following is true:
+
+- The hunter is assigned to the issue
+- The command is not disabled at the repository or organization level
+- The command is called on the issue, not the associated pull request
 
-Otherwise to simply run the tests through the console, run
+### [Configuration](./src/types/plugin-input.ts)
 
-```shell
-yarn cy:run
+#### Note: The command name is `"start"` when configuring your `.ubiquibot-config.yml` file.
+
+To configure your Ubiquibot to run this plugin, add the following to the `.ubiquibot-config.yml` file in your organization configuration repository.
+
+```yml
+- plugin: http://localhost:4000 # or the URL where the plugin is hosted
+  name: start-stop
+  id: start-stop-command
+  description: "Allows a user to start/stop a task without negative XP impact"
+  command: "\/start|\/stop"
+  example: "/start" # or "/stop"
+  with:
+    isEnabled: true
+    timers:
+      reviewDelayTolerance: 86000
+      taskStaleTimeoutDuration: 2580000
+    miscellaneous:
+      maxConcurrentTasks: 3
+      startRequiresWallet: true # default is true
 ```
 
+# Testing
+
 ### Jest
 
-To start Jest tests, run
+To run the Jest test suite, run the following command:
 
-```shell
+```bash
 yarn test
 ```