p-backlog 0.2.2 → 0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +39 -7
  3. package/README.ru.md +38 -7
  4. package/package.json +4 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.2.4
4
+
5
+ - A clearer description on npm and GitHub, and a rewritten README introduction: out-of-scope fixes stay out of pull requests, audit findings don't get lost, tasks keep the context the agent needs. No code changes.
6
+
7
+ ## 0.2.3
8
+
9
+ - README: screenshots of the task list, a task card and statistics (English UI in README.md, Russian UI in README.ru.md), generated from fictional demo data with `npm run screenshots`. No code changes.
10
+
3
11
  ## 0.2.2
4
12
 
5
13
  - README: npm, CI, Node and license badges; a section on using p-backlog together with code-review-graph (re-check by symbol). No code changes.
package/README.md CHANGED
@@ -4,14 +4,45 @@
4
4
 
5
5
  **[Русская версия](README.ru.md)**
6
6
 
7
- A task backlog that lives as markdown files: an AI agent creates them while working on code, and a human
8
- triages them in a local web app.
7
+ **Keep pull requests clean. Never lose an audit finding.**
9
8
 
10
- - **`backlog` CLI** — creates tasks, takes them into progress, changes their status.
11
- - **`backlog` skill** for Claude Code — tells the agent when and how to call the CLI.
12
- - **Web app** — project list, search, filters, epics, links, progress; doesn't create tasks.
13
- - **Backlog hygiene** — the agent re-checks tasks whose code changed and closes the ones no longer needed;
14
- closed tasks are deleted after 7 days.
9
+ A personal backlog for Claude Code that lives next to your code as Markdown files. When the agent notices a problem
10
+ outside the task at hand, it doesn't slip a fix into your pull request — it files a task with the file, the line and
11
+ what will break. Findings from audits and code reviews become tasks too, instead of getting lost in chat history.
12
+
13
+ - **Clean pull requests.** Out-of-scope fixes go to the backlog, not into the diff you review. The Effect tab in
14
+ statistics shows how many lines stayed out of your pull requests.
15
+ - **Nothing gets lost.** Every finding from an audit or a review is a task with its source (`file:line`), what it
16
+ risks and a checklist.
17
+ - **Context kept, tokens saved.** A task stores the context the agent needs to pick it up later. On a re-check the
18
+ agent gets the task's summary, the current code around its line and the diff since the last check — usually
19
+ enough to decide without re-reading the codebase.
20
+ - **Stays current by itself.** A Stop hook asks the agent to re-check tasks whose code changed. The agent closes
21
+ fixed ones with the commit as evidence; line numbers follow the code as it moves. Closed tasks are cleaned up
22
+ after 7 days.
23
+ - **Local and autonomous.** Plain files in `~/backlog`, no account, no cloud. The agent drives it through the skill,
24
+ so you don't have to touch the CLI — though you can.
25
+ - **Charts when you want them.** Start the local web app to browse and triage tasks and follow the metrics: debt by
26
+ week, where it hurts in the code, how accurate the checks are, what the hook costs in tokens.
27
+
28
+ It consists of the `backlog` CLI, the `backlog` skill and a Stop hook for Claude Code, and an optional web app.
29
+
30
+ ## Screenshots
31
+
32
+ ![Task list across three projects: the sidebar with project checkboxes and task counts, status, priority and type filters, and open tasks with tags, status, priority and creation date](https://raw.githubusercontent.com/expatriate/p-backlog/main/docs/screenshots/en/tasks.png)
33
+
34
+ ![Task card of a bug in progress: status, priority, category and epic fields, the source file:line, a description with a half-done checklist, the task that blocked it and a related task](https://raw.githubusercontent.com/expatriate/p-backlog/main/docs/screenshots/en/task.png)
35
+
36
+ <details>
37
+ <summary>Statistics: overview, effect, code</summary>
38
+
39
+ ![Statistics overview: alerts about stale urgent and low-priority tasks, tasks created and closed today and this week, debt by week and tasks created by day](https://raw.githubusercontent.com/expatriate/p-backlog/main/docs/screenshots/en/stats.png)
40
+
41
+ ![Effect tab: lines deferred to the backlog next to lines in pull requests, week by week, with the share of unrelated edits kept out of pull requests](https://raw.githubusercontent.com/expatriate/p-backlog/main/docs/screenshots/en/effect.png)
42
+
43
+ ![Code tab of one project: open debt in frequently changed folders ranked by commits times task weight, and debt density per 1000 lines](https://raw.githubusercontent.com/expatriate/p-backlog/main/docs/screenshots/en/code.png)
44
+
45
+ </details>
15
46
 
16
47
  ## Getting started
17
48
 
@@ -238,6 +269,7 @@ npx playwright install chromium # once, before the first e2e run
238
269
  npm run test:e2e # Playwright: live list update
239
270
 
240
271
  npm run test:package # the tarball install path end to end on this OS (slow)
272
+ npm run screenshots # README screenshots on demo data, into docs/screenshots
241
273
  ```
242
274
 
243
275
  To try a build the way a published package would install, without publishing it:
package/README.ru.md CHANGED
@@ -4,14 +4,44 @@
4
4
 
5
5
  **[English version](README.md)**
6
6
 
7
- Беклог задач, который живёт markdown-файлами: их создаёт ИИ-агент во время работы над кодом, а человек
8
- разбирает в локальном веб-приложении.
7
+ **Чистые пулреквесты. Находки аудитов не теряются.**
9
8
 
10
- - **CLI `backlog`** — создаёт задачи, берёт их в работу, меняет статусы.
11
- - **Скилл `backlog`** для Claude Code — объясняет агенту, когда и как звать CLI.
12
- - **Веб-приложение** — список проектов, поиск, фильтры, эпики, связи, прогресс; задачи не создаёт.
13
- - **Порядок в беклоге** — агент перепроверяет задачи, чей код изменился, и закрывает ненужные; закрытые
14
- задачи удаляются через 7 дней.
9
+ Личный беклог для Claude Code, который живёт рядом с кодом markdown-файлами. Когда агент замечает проблему вне
10
+ текущей задачи, он не протаскивает правку в ваш пулреквест, а заводит задачу: файл, строка и чем это грозит.
11
+ Находки аудитов и ревью тоже становятся задачами, а не теряются в истории чата.
12
+
13
+ - **Чистые пулреквесты.** Посторонние правки уходят в беклог, а не в дифф, который вы ревьюите. Вкладка «Эффект»
14
+ в статистике показывает, сколько строк не попало в пулреквесты.
15
+ - **Ничего не теряется.** Каждая находка аудита или ревью — задача с источником (`файл:строка`), описанием риска
16
+ и чеклистом.
17
+ - **Контекст сохранён, токены сэкономлены.** Задача хранит контекст, который нужен агенту, чтобы потом взять её
18
+ в работу. При перепроверке агент получает суть задачи, текущий код вокруг её строки и изменения с прошлой
19
+ проверки — обычно этого хватает, чтобы решить, не перечитывая кодовую базу.
20
+ - **Сам следит за актуальностью.** Stop-хук просит агента перепроверить задачи, чей код изменился. Агент закрывает
21
+ исправленные со ссылкой на коммит, номера строк следуют за кодом. Закрытые задачи удаляются через 7 дней.
22
+ - **Локальный и автономный.** Обычные файлы в `~/backlog`, без аккаунта и облака. Агент работает с ним через
23
+ скилл, так что трогать CLI не обязательно — но можно.
24
+ - **Графики — когда нужны.** Поднимите локальное веб-приложение, чтобы просматривать и разбирать задачи и следить
25
+ за метриками: долг по неделям, где болит в коде, насколько точны проверки, во что обходится хук в токенах.
26
+
27
+ Состоит из CLI `backlog`, скилла `backlog` и Stop-хука для Claude Code и веб-приложения по желанию.
28
+
29
+ ## Скриншоты
30
+
31
+ ![Список задач трёх проектов: боковая панель с галочками проектов и числом задач, фильтры по статусу, приоритету и типу, открытые задачи с тегами, статусом, приоритетом и датой создания](https://raw.githubusercontent.com/expatriate/p-backlog/main/docs/screenshots/ru/tasks.png)
32
+
33
+ ![Карточка бага в работе: поля статуса, приоритета, категории и эпика, источник файл:строка, описание с наполовину выполненным чеклистом, задача-блокер и связанная задача](https://raw.githubusercontent.com/expatriate/p-backlog/main/docs/screenshots/ru/task.png)
34
+
35
+ <details>
36
+ <summary>Статистика: обзор, эффект, код</summary>
37
+
38
+ ![Обзор статистики: тревоги о застоявшихся срочных и низкоприоритетных задачах, задачи за сегодня и за неделю, долг по неделям и созданные задачи по дням](https://raw.githubusercontent.com/expatriate/p-backlog/main/docs/screenshots/ru/stats.png)
39
+
40
+ ![Вкладка «Эффект»: строки, вынесенные в беклог, рядом со строками в пулреквестах по неделям и доля посторонних правок, не попавших в пулреквесты](https://raw.githubusercontent.com/expatriate/p-backlog/main/docs/screenshots/ru/effect.png)
41
+
42
+ ![Вкладка «Код» одного проекта: открытый долг в часто меняемых папках, ранжированный по коммитам и весу задач, и плотность долга на 1000 строк](https://raw.githubusercontent.com/expatriate/p-backlog/main/docs/screenshots/ru/code.png)
43
+
44
+ </details>
15
45
 
16
46
  ## Как начать
17
47
 
@@ -233,6 +263,7 @@ npx playwright install chromium # один раз, перед первым з
233
263
  npm run test:e2e # Playwright: живое обновление списка
234
264
 
235
265
  npm run test:package # весь путь установки из tarball на этой ОС (медленный)
266
+ npm run screenshots # скриншоты для README на демо-данных, в docs/screenshots
236
267
  ```
237
268
 
238
269
  Чтобы попробовать сборку так, будто это опубликованный пакет, без публикации:
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "p-backlog",
3
- "version": "0.2.2",
4
- "description": "Personal developer backlog for Claude Code: tasks as Markdown files, CLI, Stop hook and a local web UI",
3
+ "version": "0.2.4",
4
+ "description": "Keep pull requests clean and audit findings safe: a local, autonomous backlog for Claude Code. The agent files out-of-scope issues as Markdown tasks with context and re-checks them as code changes. Optional web UI with metrics.",
5
5
  "keywords": [
6
6
  "claude-code",
7
7
  "claude",
@@ -50,6 +50,7 @@
50
50
  "start": "npm run build && node dist/server.js",
51
51
  "dev": "concurrently -k -n server,web \"tsx watch src/server/main.ts\" \"vite\"",
52
52
  "test:e2e": "playwright test",
53
+ "screenshots": "npm run build && tsx scripts/screenshots/make.ts",
53
54
  "test:package": "vitest run --config vitest.package.config.ts",
54
55
  "prepare": "npm run build",
55
56
  "test:coverage": "vitest run --coverage",
@@ -88,6 +89,7 @@
88
89
  "react-router": "^8.4.0",
89
90
  "recharts": "^3.10.1",
90
91
  "remark-gfm": "^4.0.1",
92
+ "sharp": "^0.35.4",
91
93
  "tsx": "^4.23.15",
92
94
  "typescript": "~6.0.3",
93
95
  "typescript-eslint": "^8.70.0",