feat: 个人轻量看板工具 MVP

从零实现一个 local-first 的个人任务看板,数据只存在浏览器本地,不依赖后端。

功能
- 固定三列看板(待办 / 进行中 / 已完成),支持拖拽改状态与列内排序
- 快速新增、详情编辑、删除撤销、已完成归档
- 搜索与筛选(关键词 / 优先级 / 标签 / 今日到期 / 逾期)
- 今日视图:按紧急度分组(逾期 > 今天到期 > 进行中)+ 统计卡片
- 导出导入 JSON;启动时自动留快照,保留最近 3 份
- 键盘快捷键(N / 「/」/ ? / Esc)
- PWA:可安装、离线可用、更新提示

技术要点
- 持久化采用 TaskRepository 端口 + 整份快照读写,schemaVersion 迁移表
  显式登记升级规则(当前 v2,v1 -> v2 为归档功能补 archivedAt)
- 同列排序用相邻中点插入,间距不足时按列 normalize,避免浮点精度耗尽
- 拖拽只消费 Sortable 的事件,store 保持唯一数据源,不接管数据
- 数据损坏时先备份到 *.corrupt.<时间戳> 再报错,不覆盖用户数据
- 引入 vue-router 拆分看板与今日两个视图(见 docs/adr.md ADR-005)

验证
- 单元测试 437 个(33 个文件),行覆盖率 96.8%
- 端到端测试 23 个(Playwright),含真实拖拽与断网离线场景
- npm run build 通过,产物可静态托管

注:部署时需配置 SPA 回落,否则直接访问 /today 会 404(详见 README)。
This commit is contained in:
chenshoulin
2026-10-18 11:59:49 +08:00
commit 4e064e82ea
98 changed files with 20084 additions and 0 deletions
@@ -0,0 +1,85 @@
import { describe, expect, it, vi } from 'vitest'
import { isEditableTarget, matchShortcut, type ShortcutEventLike } from './useKeyboardShortcuts'
function makeEvent(overrides: Partial<ShortcutEventLike> = {}): ShortcutEventLike {
return {
key: 'n',
target: document.body,
defaultPrevented: false,
ctrlKey: false,
metaKey: false,
altKey: false,
...overrides,
}
}
function makeElement(tag: string, contentEditable = false): HTMLElement {
const element = document.createElement(tag)
// 用 setAttribute 而非 property:jsdom 不会把 contentEditable 属性反射到 attribute
if (contentEditable) element.setAttribute('contenteditable', 'true')
return element
}
describe('isEditableTarget', () => {
it('识别输入类元素', () => {
expect(isEditableTarget(makeElement('input'))).toBe(true)
expect(isEditableTarget(makeElement('textarea'))).toBe(true)
expect(isEditableTarget(makeElement('select'))).toBe(true)
})
it('识别 contenteditable', () => {
expect(isEditableTarget(makeElement('div', true))).toBe(true)
})
it('普通元素不算可编辑', () => {
expect(isEditableTarget(makeElement('div'))).toBe(false)
expect(isEditableTarget(document.body)).toBe(false)
})
it('null 不算可编辑', () => {
expect(isEditableTarget(null)).toBe(false)
})
})
describe('matchShortcut', () => {
it('命中时返回处理函数', () => {
const handler = vi.fn()
expect(matchShortcut(makeEvent({ key: 'n' }), { n: handler })).toBe(handler)
})
it('按键大小写不敏感', () => {
const handler = vi.fn()
expect(matchShortcut(makeEvent({ key: 'N' }), { n: handler })).toBe(handler)
})
it('支持 / 与 ? 这类符号键', () => {
const slash = vi.fn()
const question = vi.fn()
const shortcuts = { '/': slash, '?': question }
expect(matchShortcut(makeEvent({ key: '/' }), shortcuts)).toBe(slash)
expect(matchShortcut(makeEvent({ key: '?' }), shortcuts)).toBe(question)
})
it('输入框内不触发', () => {
const handler = vi.fn()
expect(matchShortcut(makeEvent({ target: makeElement('input') }), { n: handler })).toBeNull()
expect(matchShortcut(makeEvent({ target: makeElement('textarea') }), { n: handler })).toBeNull()
})
it('带 Ctrl / Cmd / Alt 修饰键时不触发', () => {
const handler = vi.fn()
expect(matchShortcut(makeEvent({ ctrlKey: true }), { n: handler })).toBeNull()
expect(matchShortcut(makeEvent({ metaKey: true }), { n: handler })).toBeNull()
expect(matchShortcut(makeEvent({ altKey: true }), { n: handler })).toBeNull()
})
it('已被处理的事件不重复触发', () => {
const handler = vi.fn()
expect(matchShortcut(makeEvent({ defaultPrevented: true }), { n: handler })).toBeNull()
})
it('未注册的按键返回 null', () => {
expect(matchShortcut(makeEvent({ key: 'z' }), { n: vi.fn() })).toBeNull()
})
})
+60
View File
@@ -0,0 +1,60 @@
/**
* 全局键盘快捷键(T16)
*
* 关键约束:**在输入框内打字时不劫持按键**。
* 否则用户在搜索框里输入 "n" 会触发「新增任务」。
*/
import { onBeforeUnmount, onMounted } from 'vue'
export type ShortcutMap = Record<string, () => void>
/** 事件是否发生在可编辑元素内 */
export function isEditableTarget(target: EventTarget | null): boolean {
if (typeof HTMLElement === 'undefined' || !(target instanceof HTMLElement)) return false
const tag = target.tagName
if (tag === 'INPUT' || tag === 'TEXTAREA' || tag === 'SELECT') return true
// jsdom 未实现 isContentEditable,因此同时检查属性,保证行为可测且与浏览器一致
if (target.isContentEditable === true) return true
const attribute = target.getAttribute('contenteditable')
return attribute === '' || attribute === 'true'
}
export interface ShortcutEventLike {
key: string
target: EventTarget | null
defaultPrevented: boolean
ctrlKey: boolean
metaKey: boolean
altKey: boolean
}
/**
* 解析出应执行的快捷键处理函数;不满足条件时返回 null。
* 独立成纯函数便于测试。
*/
export function matchShortcut(
event: ShortcutEventLike,
shortcuts: ShortcutMap,
): (() => void) | null {
if (event.defaultPrevented) return null
// 带修饰键的组合交给浏览器(如 Ctrl+F 查找、Cmd+R 刷新)
if (event.ctrlKey || event.metaKey || event.altKey) return null
if (isEditableTarget(event.target)) return null
return shortcuts[event.key.toLowerCase()] ?? null
}
export function useKeyboardShortcuts(shortcuts: ShortcutMap): void {
function onKeydown(event: KeyboardEvent): void {
const handler = matchShortcut(event, shortcuts)
if (!handler) return
event.preventDefault()
handler()
}
onMounted(() => document.addEventListener('keydown', onKeydown))
onBeforeUnmount(() => document.removeEventListener('keydown', onKeydown))
}