Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Create @chatcops/store-sqlite, a store for single-server setups

已关闭
  • 哪里不对？
#247 3 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

维护者通常 1 天内回复

@srikar-naidu 已经在做这个了。

开始于 2026年10月21日。

  • #293 来自 @srikar-naidu —— 已合并

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
express, node.js, sqlite, typescript
领域
backend, database

调研方向

Read packages/core/src/storage/types.ts and packages/core/src/storage/memory.ts to understand the storage contract and reference behavior, then review packages/core/tests/storage/conformance.test.ts and the store package layout in CONTRIBUTING.md. Implement packages/store-sqlite with all four capabilities and run runStorageConformance on both in-memory and temporary file databases. Done means the listed acceptance checks pass, including persistence after reopening, README, changeset, build, coverage, lint, and publint.

由索引模型根据 Issue 内容生成。

描述

enhancement hacktoberfest help wanted server

ChatCops keeps conversations in memory unless you write your own store, so an Express server on a VPS forgets every chat on restart. SQLite is the easiest fix for that setup: one file, no service to run. Node 22 ships node:sqlite, so there's no native build step either.

This is a bigger one, for someone who has had a few PRs merged here. The interfaces and the tests it has to pass already exist: packages/core/src/storage/types.ts and runStorageConformance from @chatcops/core/testing. CONTRIBUTING.md has a "Writing a store package" section with the package layout.

What to do
Create packages/store-sqlite:

import { sqliteStorage } from '@chatcops/store-sqlite';

storage: sqliteStorage({ path: './chatcops.db' })     // or ':memory:'
storage: sqliteStorage({ database: db })              // an open node:sqlite DatabaseSync or a better-sqlite3 Database
  • All four capabilities: conversations (with append, updateMessage, removeMessage, list, purge), counters, kv (with setIfAbsent) and events (with query).
  • Tables: chatcops_conversations (id, metadata JSON, version, created_at, updated_at), chatcops_messages (conversation_id, seq, id, the message as JSON, primary key on conversation_id and seq, unique on conversation_id and id, ON DELETE CASCADE), chatcops_counters, chatcops_kv, chatcops_events. Times are integer milliseconds. Create them on first use (CREATE TABLE IF NOT EXISTS) and record a schema version in a small chatcops_meta table so later releases can migrate. Turn on PRAGMA foreign_keys = ON.
  • append runs in one transaction (BEGIN IMMEDIATE) that checks expectedVersion, inserts the messages with the next seq values and bumps the version. Throw ConflictError from @chatcops/core on a mismatch.
  • Counters: one INSERT ... ON CONFLICT DO UPDATE ... RETURNING that starts over when the stored row has expired.
  • Expired kv and counter rows count as missing when read. purge deletes old conversations, and their messages go with them through the cascade.
  • node:sqlite is the default. Accept a better-sqlite3 Database too, through a tiny shim over the few methods you use (prepare, run, get, all, exec). Don't add better-sqlite3 as a dependency; use it only in a test if you want to cover the shim.
  • "engines": { "node": ">=22.13" }. That's the first Node 22 with node:sqlite unflagged.
  • "private": true in package.json. A maintainer publishes it for the first time.

Where to look

  • packages/core/src/storage/types.ts and packages/core/src/storage/memory.ts (the reference implementation)
  • packages/core/tests/storage/conformance.test.ts (how the suite is called)
  • node:sqlite docs

Acceptance criteria

  • runStorageConformance('sqlite', ...) passes with nothing skipped, on a :memory: database and on a temp file
  • Data survives closing and reopening a file database
  • A short README with the setup for Express
  • Changeset for @chatcops/store-sqlite (minor)
  • pnpm -r build, pnpm test:coverage (90% lines, 80% branches for store packages), pnpm lint and pnpm publint pass

Want to work on this? Comment below and I'll assign it to you. Please take one issue at a time, branch off dev, and open your PR against dev with Closes #<this issue number>. Setup notes (pnpm, build before test) are in CONTRIBUTING.md.

主要语言
TypeScript
星标
13
派生
7
平均合并
3 小时 33 分钟
30 天内合并 PR
176

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

codercops/chatcops 的其他 Issue

查看 codercops/chatcops 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。