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/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/worker-deploy.yml

@@ -0,0 +1,29 @@
+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"
+      - uses: actions/checkout@v4
+      - uses: cloudflare/wrangler-action@v3
+        with:
+          wranglerVersion: "3.57.0"
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          secrets: |
+            SUPABASE_URL
+            SUPABASE_KEY
+            UBIQUIBOT_TOKEN
+        env:
+          SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
+          SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
+          UBIQUIBOT_TOKEN: ${{ secrets.UBIQUIBOT_TOKEN }}

.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,54 @@
-# `@ubiquity/ts-template`
+# `@ubiquibot-plugins/start-stop-plugin`
 
-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 karma and XP requirements
 
-```shell
-yarn cy:open
-```
+### Stop a task
 
-Otherwise to simply run the tests through the console, run
+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:
 
-```shell
-yarn cy:run
-```
+- 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
+
+### [Configuration](./src/plugin-config.yml)
+
+#### Note: The command name is `"start"` when configuring your `.ubiquibot-config.yml` file.
 
-### Jest
+To configure your Ubiquibot to run this plugin, add the following to your [`.ubiquibot-config.yml`](./.github/.ubiquibot-config.yml) file at either the organization or repository level:
 
-To start Jest tests, run
+```yml
+plugins:
+  issue_comment.created:
+    - uses:
+        - plugin: ubiquibot-plugins/start-stop-plugin:compute.yml@development
+          name: start-stop
+          id: start-stop-command
+          type: github
+          description: "Allows a user to start/stop a bounty without negative XP impact"
+          command: "/(start|stop)"
+          example: "/start | /stop"
+          with:
+            disabledCommands: [] # Empty array means no commands are disabled
+                - start # Disables the start command
+            timers:
+              reviewDelayTolerance: 86000
+              taskStaleTimeoutDuration: 2580000
+            miscellaneous:
+              maxConcurrentTasks: 3
+            labels:
+              time: []
+              priority: []
 
-```shell
-yarn test
 ```