Feat/add basic docs#13
Conversation
📝 WalkthroughWalkthroughAdds two GitHub issue templates (bug report and feature request), rewrites ChangesJetQueue docs, issue templates, and core config
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 12
🧹 Nitpick comments (3)
.github/ISSUE_TEMPLATE/feature_request.md (1)
21-21: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueNormalize capitalization:
Cli Dashboard→CLI Dashboard."Cli Dashboard" is inconsistent with "Frontend Dashboard" (title case). Use "CLI Dashboard" for consistency.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/ISSUE_TEMPLATE/feature_request.md at line 21, The checklist item text uses inconsistent capitalization; update the “Cli Dashboard” entry in the issue template to “CLI Dashboard” so it matches the naming used elsewhere such as “Frontend Dashboard.”docs/overview.md (1)
27-27: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse descriptive link text.
"here" is non-descriptive. Replace with meaningful text like "check out our examples documentation" or "see the examples page".
📝 Proposed fix
-*For better understanding of what does actually JetQueue do check out our examples [here](./examples.md)* +*For a better understanding of what JetQueue actually does, check out our [examples documentation](./examples.md)*🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/overview.md` at line 27, The link text in the overview content is too generic and should be made descriptive. Update the markdown in the overview copy around the examples link so the anchor text clearly describes the destination, using meaningful wording in place of “here” while keeping the target to examples.md.docs/architecture.md (1)
52-52: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick winQualify environment compatibility claim.
"Works in any environment: Node.js, Bun, browsers, edge functions" overstates compatibility. Edge functions (e.g., Vercel Edge, Cloudflare Workers) often lack WebSocket support, which the client uses for real-time events. Clarify that HTTP operations work everywhere but WebSocket features require runtime support.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/architecture.md` at line 52, The compatibility statement in the architecture docs overstates support for all runtimes. Update the claim near the environment compatibility section to distinguish HTTP-based features from WebSocket-based real-time features, and explicitly note that while the client works in Node.js, Bun, and browsers for HTTP operations, WebSocket functionality depends on runtime support and may not be available in some edge functions.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/ISSUE_TEMPLATE/bug_report.md:
- Around line 9-26: Update the bug report template to include the missing
CONTRIBUTING.md sections in the existing issue template: add “Steps to
Reproduce,” “Actual Behavior,” and “Any relevant error logs” alongside the
current “Describe the Bug,” “Expected Behavior,” and “Environment” sections.
Keep the wording consistent with the template style so reporters are prompted to
provide the triage-critical details.
- Line 6: The YAML frontmatter in the issue template uses assignees as an empty
string instead of an empty list. Update the frontmatter field in the bug report
template so assignees is represented as an empty array, or remove the assignees
key entirely if the template should leave issues unassigned.
- Line 19: The bug report template lists the wrong package name in the Package
field; update the package option from server to serve so it matches the codebase
convention used elsewhere. Fix the Package entry in the bug_report template and
ensure any related package list text consistently uses serve, not server, to
avoid misleading reporters.
In @.github/ISSUE_TEMPLATE/feature_request.md:
- Line 6: The YAML frontmatter in the feature request template has assignees set
as an empty string instead of an empty list. Update the frontmatter in the
feature_request template to use a list-style empty value for assignees, matching
the bug_report template behavior, or remove the assignees key entirely if it is
not needed.
In `@docs/architecture.md`:
- Line 100: The job status description is inaccurate because failed jobs do not
wait for a manual retry; they remain failed only after automatic retries are
exhausted. Update the failed state documentation in the architecture doc to
match the behavior in handleJobFailure and the queue retry flow in
packages/core/src/queue.ts, removing “manual retry” or clearly stating retries
happen automatically via maxAttempts and retryOptions.
- Line 32: The architecture doc currently implies SQLite is built into both Bun
and Node.js, which is misleading. Update the persistence description in the
documentation so it clearly states the runtime requirement for Node.js (for
example, that a SQLite driver such as better-sqlite3 is needed) while keeping
the wording accurate for Bun; use the existing SQLite persistence bullet to
locate and revise the phrasing.
- Line 18: The architecture doc currently makes a misleading claim about SQLite
being “built into Bun/Node.js”; update the wording to clearly distinguish that
Bun provides native SQLite via bun:sqlite, while Node.js requires an external
package such as better-sqlite3. Adjust the relevant architecture section text to
name the runtime-specific support explicitly and avoid implying Node.js includes
a built-in SQLite module.
- Around line 129-132: The real-time updates diagram includes an incorrect
DB-to-Client event flow; update the Mermaid block in the Real-time Updates
section to remove the DB-->>Client: Events line and keep only the Core-->>Client
WebSocket broadcast path from this.events.emit, preserving the rest of the loop
structure.
In `@docs/getting-started.md`:
- Around line 41-42: Fix the wording in the TIP callout so it reads cleanly and
correctly: update the sentence in the getting-started tip from the current
phrasing to use “package manager” instead of “package manger,” capitalize the
opening word, and add proper punctuation. Keep the change limited to the tip
text itself.
In `@docs/overview.md`:
- Line 15: The use case intro sentence has grammatical and wording errors;
update the introductory text in the overview content to use a clear, correct
phrasing such as the one suggested in the review, preserving the meaning while
fixing capitalization, spacing, and sentence structure.
- Line 11: The docs currently imply cron/timezone scheduling support that the
queue does not implement. Update the overview wording to explicitly mention the
supported repeating API via addRepeating, or remove the unsupported cron and
timezone fields from ScheduleJobs so the documented scheduling surface matches
the actual implementation.
In `@packages/core/package.json`:
- Around line 21-25: The dependency and runtime declarations are out of sync in
the package manifest: `@types/node` is set to a newer major than the supported
Node target. Update `packages/core` so `@types/node` matches the Node 22 runtime
line, or, if the newer typings are intentional, adjust the `engines.node`
constraint to the corresponding runtime; use the `engines` field and the
`@types/node` entry in the package JSON to keep them aligned.
---
Nitpick comments:
In @.github/ISSUE_TEMPLATE/feature_request.md:
- Line 21: The checklist item text uses inconsistent capitalization; update the
“Cli Dashboard” entry in the issue template to “CLI Dashboard” so it matches the
naming used elsewhere such as “Frontend Dashboard.”
In `@docs/architecture.md`:
- Line 52: The compatibility statement in the architecture docs overstates
support for all runtimes. Update the claim near the environment compatibility
section to distinguish HTTP-based features from WebSocket-based real-time
features, and explicitly note that while the client works in Node.js, Bun, and
browsers for HTTP operations, WebSocket functionality depends on runtime support
and may not be available in some edge functions.
In `@docs/overview.md`:
- Line 27: The link text in the overview content is too generic and should be
made descriptive. Update the markdown in the overview copy around the examples
link so the anchor text clearly describes the destination, using meaningful
wording in place of “here” while keeping the target to examples.md.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: cee254b3-5c8d-4d4e-a196-3a645a30de8a
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (8)
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/feature_request.mddocs/architecture.mddocs/getting-started.mddocs/overview.mddocs/v1/todo.mdpackages/core/package.jsonpackages/core/tsconfig.json
| about: Create a report to help us improve | ||
| title: '[BUG] ' | ||
| labels: bug | ||
| assignees: '' |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Fix assignees format in YAML frontmatter.
assignees: '' sets an empty string rather than an empty list. Use assignees: [] or omit the key entirely for unassigned issues.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.github/ISSUE_TEMPLATE/bug_report.md at line 6, The YAML frontmatter in the
issue template uses assignees as an empty string instead of an empty list.
Update the frontmatter field in the bug report template so assignees is
represented as an empty array, or remove the assignees key entirely if the
template should leave issues unassigned.
| ## Describe the Bug | ||
| A clear and concise description of what the bug is. | ||
|
|
||
| ## Expected Behavior | ||
| A clear and concise description of what you expected to happen. | ||
|
|
||
| ## Screenshots | ||
| If applicable, add screenshots to help explain your problem. | ||
|
|
||
| ## Environment | ||
| - Package: [core/server/cli/dashboard/client] | ||
| - Version: [e.g., 1.0.0] | ||
| - OS: [e.g., Windows/Mac/Linux] | ||
| - Node Version: [e.g., 18.x] | ||
| - Browser: [e.g., Chrome, Safari] | ||
|
|
||
| ## Additional Context | ||
| Add any other context about the problem here. No newline at end of file |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Add missing fields expected by CONTRIBUTING.md.
The template omits sections that CONTRIBUTING.md explicitly requests: "Steps to Reproduce", "Actual Behavior", and "Any relevant error logs". Add these to ensure bug reports contain triage-critical details.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.github/ISSUE_TEMPLATE/bug_report.md around lines 9 - 26, Update the bug
report template to include the missing CONTRIBUTING.md sections in the existing
issue template: add “Steps to Reproduce,” “Actual Behavior,” and “Any relevant
error logs” alongside the current “Describe the Bug,” “Expected Behavior,” and
“Environment” sections. Keep the wording consistent with the template style so
reporters are prompted to provide the triage-critical details.
| If applicable, add screenshots to help explain your problem. | ||
|
|
||
| ## Environment | ||
| - Package: [core/server/cli/dashboard/client] |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Correct package name: server → serve.
The package list includes server, but the codebase uses serve (per feature_request.md and context). Align with the actual package name.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.github/ISSUE_TEMPLATE/bug_report.md at line 19, The bug report template
lists the wrong package name in the Package field; update the package option
from server to serve so it matches the codebase convention used elsewhere. Fix
the Package entry in the bug_report template and ensure any related package list
text consistently uses serve, not server, to avoid misleading reporters.
| about: Suggest an idea for this project | ||
| title: '[FEATURE] ' | ||
| labels: enhancement | ||
| assignees: '' |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Fix assignees format in YAML frontmatter.
Same issue as bug_report.md: assignees: '' is an empty string instead of an empty list. Use assignees: [] or omit the key.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.github/ISSUE_TEMPLATE/feature_request.md at line 6, The YAML frontmatter in
the feature request template has assignees set as an empty string instead of an
empty list. Update the frontmatter in the feature_request template to use a
list-style empty value for assignees, matching the bug_report template behavior,
or remove the assignees key entirely if it is not needed.
| - **Job lifecycle management**: Create, track, update, and remove jobs | ||
| - **Retry logic**: Fixed, linear, and exponential backoff strategies | ||
| - **Storage abstraction**: In-memory by default, with SQLite persistence (built into Bun/Node.js) | ||
| - **Event system**: Emits typed events for every job state change |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Correct misleading SQLite claim.
"built into Bun/Node.js" is incorrect — Node.js does not include a built-in SQLite module. Bun has bun:sqlite, but Node requires better-sqlite3 or similar. Clarify which runtime provides native SQLite and which needs a package.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/architecture.md` at line 18, The architecture doc currently makes a
misleading claim about SQLite being “built into Bun/Node.js”; update the wording
to clearly distinguish that Bun provides native SQLite via bun:sqlite, while
Node.js requires an external package such as better-sqlite3. Adjust the relevant
architecture section text to name the runtime-specific support explicitly and
avoid implying Node.js includes a built-in SQLite module.
| loop Real-time Updates | ||
| Core-->>Client: WebSocket Events<br/>job:completed, job:failed,<br/>job:progress, stats, etc. | ||
| DB-->>Client: Events | ||
| end |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Remove incorrect DB→Client event flow.
DB-->>Client: Events is architecturally wrong. SQLite does not push events; all events originate from the Core engine (this.events.emit). The loop should only show Core-->>Client via Server WebSocket broadcast. Remove the DB-->>Client line.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/architecture.md` around lines 129 - 132, The real-time updates diagram
includes an incorrect DB-to-Client event flow; update the Mermaid block in the
Real-time Updates section to remove the DB-->>Client: Events line and keep only
the Core-->>Client WebSocket broadcast path from this.events.emit, preserving
the rest of the loop structure.
| > [!TIP] | ||
| > you can use whatever package manger you want, here is the npm example |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix typo and grammar in tip.
"package manger" → "package manager". Also capitalize "You" and add punctuation: "You can use whatever package manager you want. Here is the npm example:"
📝 Proposed fix
> [!TIP]
-> you can use whatever package manger you want, here is the npm example
+> You can use whatever package manager you want. Here is the npm example:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > [!TIP] | |
| > you can use whatever package manger you want, here is the npm example | |
| > [!TIP] | |
| > You can use whatever package manager you want. Here is the npm example: |
🧰 Tools
🪛 LanguageTool
[grammar] ~42-~42: Ensure spelling is correct
Context: ...> [!TIP] > you can use whatever package manger you want, here is the npm example Then...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/getting-started.md` around lines 41 - 42, Fix the wording in the TIP
callout so it reads cleanly and correctly: update the sentence in the
getting-started tip from the current phrasing to use “package manager” instead
of “package manger,” capitalize the opening word, and add proper punctuation.
Keep the change limited to the tip text itself.
Source: Linters/SAST tools
| - **Concurrent Processing** - Run N jobs simultaneously | ||
| - **Auto-Retry** - Exponential, linear, or fixed backoff strategies | ||
| - **Priority Queues** - Critical jobs jump the line | ||
| - **Delayed & Recurring Jobs** - Schedule work for later |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify if recurring job support exists in the codebase
rg -nP --type=ts '\b(cron|recur|repeat|interval)\b' packages/core/src/Repository: arxja/jet-queue
Length of output: 259
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n== types.ts around recurrence ==\n'
sed -n '110,150p' packages/core/src/types.ts
printf '\n== search for repeat/cron usage in core ==\n'
rg -n --type ts '\b(repeat|cron|type:\s*[\'"]once[\'"]\s*\|\s*[\'"]repeat[\'"])\b' packages/core/src
printf '\n== queue/job implementation references ==\n'
rg -n --type ts '\b(delay|cron|repeat|once)\b' packages/core/src | sed -n '1,220p'Repository: arxja/jet-queue
Length of output: 1338
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n== recurrence-related type and implementation references ==\n'
rg -n --type ts --type md '\b(repeat|cron|timezone|ScheduleJobs|once)\b' packages core docs . 2>/dev/null | sed -n '1,260p'
printf '\n== locate ScheduleJobs usage ==\n'
rg -n --type ts 'ScheduleJobs' packages core . 2>/dev/null
printf '\n== inspect likely scheduling code paths ==\n'
fd -a --type f '.*(queue|job|schedule).*\.ts$' packages core . 2>/dev/null | sed -n '1,120p'Repository: arxja/jet-queue
Length of output: 1982
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n== queue.ts scheduling-related sections ==\n'
ast-grep outline packages/core/src/queue.ts --view expanded | sed -n '1,220p'
printf '\n== schedule-related symbols in queue.ts ==\n'
rg -n --type ts 'schedule|delay|cron|repeat|timezone|ScheduleJobs' packages/core/src/queue.ts packages/core/src/*.ts
printf '\n== job and queue type definitions ==\n'
sed -n '1,220p' packages/core/src/types.tsRepository: arxja/jet-queue
Length of output: 12910
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n== addRepeating implementation ==\n'
sed -n '180,240p' packages/core/src/queue.ts
printf '\n== any cron/timezone handling ==\n'
rg -n --type ts '\b(cron|timezone)\b' packages/core/src packages/core/testsRepository: arxja/jet-queue
Length of output: 1575
Clarify the recurring-jobs claim
The queue supports delayed jobs and interval-based addRepeating, but there’s no cron/timezone-driven scheduling path yet. Either document the supported repeating API explicitly or remove the unused cron/timezone fields from ScheduleJobs.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/overview.md` at line 11, The docs currently imply cron/timezone
scheduling support that the queue does not implement. Update the overview
wording to explicitly mention the supported repeating API via addRepeating, or
remove the unsupported cron and timezone fields from ScheduleJobs so the
documented scheduling surface matches the actual implementation.
|
|
||
| ## **Where** and **Why** you should use it | ||
|
|
||
| > Be decisive can use it every where that you are working with asynchronous tasks and queues |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix grammatical errors in use case intro.
"Be decisive can use it every where that you are working with asynchronous tasks and queues" contains multiple errors. Suggest: "You can use it everywhere you work with asynchronous tasks and queues."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/overview.md` at line 15, The use case intro sentence has grammatical and
wording errors; update the introductory text in the overview content to use a
clear, correct phrasing such as the one suggested in the review, preserving the
meaning while fixing capitalization, spacing, and sentence structure.
| "@types/node": "^26.0.1", | ||
| "tsup": "^8.0.0", | ||
| "typescript": "^5.3.0" | ||
| }, | ||
| "engines": { | ||
| "engines": { |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
python - <<'PY'
import json
from pathlib import Path
pkg = json.loads(Path("packages/core/package.json").read_text())
print("packages/core/package.json")
print(" engines.node =", pkg.get("engines", {}).get("node"))
print(" devDependencies.@types/node =", pkg.get("devDependencies", {}).get("`@types/node`"))
print(" devDependencies.typescript =", pkg.get("devDependencies", {}).get("typescript"))
PY
echo
echo "Node API call sites worth double-checking against the supported engine:"
rg -n --type=ts -C2 '\b(process|crypto\.randomUUID|node:)\b' packages/core/srcRepository: arxja/jet-queue
Length of output: 2703
Align @types/node with the supported runtime
packages/core targets Node >=22.5.0, but @types/node@^26.0.1 exposes newer APIs than that runtime family. Pin the typings to the Node 22 line, or bump engines.node to match the typings.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/core/package.json` around lines 21 - 25, The dependency and runtime
declarations are out of sync in the package manifest: `@types/node` is set to a
newer major than the supported Node target. Update `packages/core` so
`@types/node` matches the Node 22 runtime line, or, if the newer typings are
intentional, adjust the `engines.node` constraint to the corresponding runtime;
use the `engines` field and the `@types/node` entry in the package JSON to keep
them aligned.
1 participant
Summary by CodeRabbit
Documentation
New Features
Chores