Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Monorepo on **Yarn 4 (Berry, via Corepack) + Turbo**. Workspaces declared in roo
| `packages/sidequest` | `sidequest` | Umbrella package end users install. Exposes `Sidequest`, re-exports the rest. Source is intentionally thin — mostly the `Sidequest` static class and operations facade. |
| `packages/engine` | `@sidequest/engine` | Orchestration. Owns the `Engine`, `Dispatcher`, `QueueManager`, `ExecutorManager`, `JobBuilder`, `JobTransitioner`, cron registry, routines (cleanup, stale recovery), shared runner pool. |
| `packages/core` | `@sidequest/core` | Shared primitives: `Job` base class, schema/types (`JobData`, `QueueConfig`, etc.), state transitions, logger (Winston), uniqueness, tools. |
| `packages/dashboard` | `@sidequest/dashboard` | Express + EJS + HTMX + Tailwind/DaisyUI web UI. Can run standalone via `SidequestDashboard`. |
| `packages/web` | `@sidequest/web` | Web layer (v2 rewrite, React + Vite). Currently ships the `/ui` design-system component library; the OSS dashboard app, the Hono management API, and a boot façade are being added. |
| `packages/cli` | `@sidequest/cli` | `sidequest` / `sq` CLI for `config`, `migrate`, `rollback`. |
| `packages/docs` | (private) | VitePress site → docs.sidequestjs.com. |
| `packages/backends/backend` | `@sidequest/backend` | Backend interface + `SQLBackend` base (Knex-based). |
Expand Down Expand Up @@ -96,7 +96,7 @@ Node ≥ 22.6.0 required. TypeScript jobs run natively on Node ≥ 23.6.0.
- `Sidequest.job` — `.get`, `.list`, `.count`, `.cancel`, `.run`, `.snooze`, `.findStale`, `.deleteFinished`.
- `Sidequest.queue` — `.get`, `.list`, `.create`, `.pause`, `.activate`, `.toggle`, `.setConcurrency`, `.setPriority`.
- `Job` class (`@sidequest/core`) with `async run(...args)`. Runtime metadata (`this.id`, `this.attempt`, etc.) is injected **after construction**, only available inside `run`. Convenience methods inside `run`: `return this.complete(result)` / `this.fail(reason)` / `this.retry(reason, delay?)` / `this.snooze(delay)`. **You must `return` them** — calling without returning is a no-op.
- `SidequestDashboard` (`@sidequest/dashboard`) — standalone dashboard against a shared backend.
- Dashboard: under v2 rewrite. The old Express/EJS `SidequestDashboard` and the `Sidequest.start({ dashboard })` option have been removed; `@sidequest/web` currently exposes only the `/ui` component library. Booting a dashboard will return via the `@sidequest/web` façade.

## Behavioral nuances that bite

Expand Down
10 changes: 5 additions & 5 deletions eslint.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ export default tseslint.config(
"**/migrations/**",
"**/storybook-static/**",
"packages/docs/.vitepress/cache/**",
"packages/dashboard/vite.lib.config.ts",
"packages/dashboard/vitest.setup.ts",
"packages/dashboard/.storybook/**",
"packages/web/vite.lib.config.ts",
"packages/web/vitest.setup.ts",
"packages/web/.storybook/**",
],
},
{
Expand Down Expand Up @@ -51,13 +51,13 @@ export default tseslint.config(
},
{
// React UI library lives in its own tsconfig (JSX, DOM libs, bundler resolution).
files: ["packages/dashboard/src/ui/**/*.{ts,tsx}"],
files: ["packages/web/src/ui/**/*.{ts,tsx}"],
plugins: { "react-hooks": reactHooks, "jsx-a11y": jsxA11y },
languageOptions: {
globals: { ...globals.browser },
parserOptions: {
projectService: false,
project: ["./packages/dashboard/tsconfig.ui.json"],
project: ["./packages/web/tsconfig.ui.json"],
tsconfigRootDir: import.meta.dirname,
sourceType: "module",
},
Expand Down
46 changes: 0 additions & 46 deletions examples/06-dashboard-base-path/index.ts

This file was deleted.

9 changes: 0 additions & 9 deletions examples/06-dashboard-base-path/test-job.ts

This file was deleted.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"test:all:ci": "turbo run test:ci",
"test:all:debug": "yarn vitest --test-timeout=0 run --exclude tests/integration",
"test:all:coverage": "vitest run --coverage --exclude tests/integration",
"test:ui:coverage": "yarn vitest run --config packages/dashboard/vitest.config.js --coverage",
"test:ui:coverage": "yarn vitest run --config packages/web/vitest.config.js --coverage",
"format": "prettier --write \"**/*.{ts,js,mts,tsx,jsx,json,md}\"",
"format:check": "prettier --check \"**/*.{ts,js,mts,tsx,jsx}\"",
"lint": "eslint . --ext .ts,.mts,.js,.tsx,.jsx",
Expand Down
113 changes: 0 additions & 113 deletions packages/dashboard/README.md

This file was deleted.

71 changes: 0 additions & 71 deletions packages/dashboard/rollup.config.js

This file was deleted.

69 changes: 0 additions & 69 deletions packages/dashboard/src/config.ts

This file was deleted.

Loading