@promptbook/templates 0.114.0-48 → 0.114.0-49

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 (46) hide show
  1. package/README.md +44 -25
  2. package/esm/index.es.js +1075 -1211
  3. package/esm/index.es.js.map +1 -1
  4. package/esm/src/cli/cli-commands/coder/agentCliOptions.d.ts +5 -0
  5. package/esm/src/cli/cli-commands/coder/coderAgentRole.d.ts +5 -0
  6. package/esm/src/cli/cli-commands/coder/coderReferencedArtifacts.d.ts +2 -2
  7. package/esm/src/cli/cli-commands/coder/ensureCoderPackageJsonFile.d.ts +3 -2
  8. package/esm/src/cli/cli-commands/coder/ensureCoderPackageJsonFile.test.d.ts +1 -0
  9. package/esm/src/cli/cli-commands/coder/findLegacyCoderCheckCallers.d.ts +5 -0
  10. package/esm/src/cli/cli-commands/coder/initializeCoderProjectConfiguration.d.ts +6 -0
  11. package/esm/src/cli/cli-commands/coder/mergeStringRecordJsonFile.d.ts +5 -3
  12. package/esm/src/cli/cli-commands/coder/planning/runPlanningSession.d.ts +3 -0
  13. package/esm/src/cli/cli-commands/coder/prepareCoderPackageJsonScripts.d.ts +12 -0
  14. package/esm/src/cli/cli-commands/coder.d.ts +1 -1
  15. package/esm/src/cli/cli-commands/common/coderCheckCliOptions.d.ts +21 -0
  16. package/esm/src/cli/cli-commands/common/coderCheckCliOptions.test.d.ts +1 -0
  17. package/esm/src/cli/cli-commands/common/projectCliOptions.d.ts +30 -0
  18. package/esm/src/cli/cli-commands/common/projectCliOptions.test.d.ts +1 -0
  19. package/esm/src/cli/cli-commands/common/promptbook-cli/$checkPromptbookCliInstallations.d.ts +1 -1
  20. package/esm/src/cli/cli-commands/common/promptbook-cli/$ensurePromptbookCliInstallations.d.ts +1 -1
  21. package/esm/src/cli/cli-commands/common/promptbook-cli/$resolvePromptbookCliInstallations.d.ts +1 -1
  22. package/esm/src/cli/cli-commands/common/promptbook-cli/$updatePromptbookCliInstallation.d.ts +1 -1
  23. package/esm/src/version.d.ts +1 -1
  24. package/package.json +2 -2
  25. package/umd/index.umd.js +1075 -1211
  26. package/umd/index.umd.js.map +1 -1
  27. package/umd/src/cli/cli-commands/coder/agentCliOptions.d.ts +5 -0
  28. package/umd/src/cli/cli-commands/coder/coderAgentRole.d.ts +5 -0
  29. package/umd/src/cli/cli-commands/coder/coderReferencedArtifacts.d.ts +2 -2
  30. package/umd/src/cli/cli-commands/coder/ensureCoderPackageJsonFile.d.ts +3 -2
  31. package/umd/src/cli/cli-commands/coder/ensureCoderPackageJsonFile.test.d.ts +1 -0
  32. package/umd/src/cli/cli-commands/coder/findLegacyCoderCheckCallers.d.ts +5 -0
  33. package/umd/src/cli/cli-commands/coder/initializeCoderProjectConfiguration.d.ts +6 -0
  34. package/umd/src/cli/cli-commands/coder/mergeStringRecordJsonFile.d.ts +5 -3
  35. package/umd/src/cli/cli-commands/coder/planning/runPlanningSession.d.ts +3 -0
  36. package/umd/src/cli/cli-commands/coder/prepareCoderPackageJsonScripts.d.ts +12 -0
  37. package/umd/src/cli/cli-commands/coder.d.ts +1 -1
  38. package/umd/src/cli/cli-commands/common/coderCheckCliOptions.d.ts +21 -0
  39. package/umd/src/cli/cli-commands/common/coderCheckCliOptions.test.d.ts +1 -0
  40. package/umd/src/cli/cli-commands/common/projectCliOptions.d.ts +30 -0
  41. package/umd/src/cli/cli-commands/common/projectCliOptions.test.d.ts +1 -0
  42. package/umd/src/cli/cli-commands/common/promptbook-cli/$checkPromptbookCliInstallations.d.ts +1 -1
  43. package/umd/src/cli/cli-commands/common/promptbook-cli/$ensurePromptbookCliInstallations.d.ts +1 -1
  44. package/umd/src/cli/cli-commands/common/promptbook-cli/$resolvePromptbookCliInstallations.d.ts +1 -1
  45. package/umd/src/cli/cli-commands/common/promptbook-cli/$updatePromptbookCliInstallation.d.ts +1 -1
  46. package/umd/src/version.d.ts +1 -1
package/README.md CHANGED
@@ -409,7 +409,7 @@ Promptbook Coder is **not another standalone coding model**. It is an orchestrat
409
409
 
410
410
  - prompt files with explicit statuses like `[ ]`, `[^]`, `[x]`, and `[-]`
411
411
  - automatic selection of the next runnable task, including priority support
412
- - optional shared repo context loaded from a file such as `AGENTS.md`
412
+ - shared project context loaded from `AGENTS.md` by default
413
413
  - automatic `git add`, commit, and push after each successful prompt
414
414
  - dedicated coding-agent Git identity and optional GPG signing
415
415
  - verification and repair flow for work that is done, partial, or broken
@@ -431,7 +431,7 @@ Prompts marked with `[-]` are not ready yet, prompts containing `@@@` are treate
431
431
  #### Features
432
432
 
433
433
  - **Multi-runner execution:** `openai-codex`, `github-copilot`, `cline`, `claude-code`, `opencode`, `gemini`, `qwen-code`
434
- - **Context injection:** `--agent agents/coding/developer.book --context AGENTS.md` or inline extra instructions
434
+ - **Project defaults:** Developer, invocation cwd, and project `AGENTS.md`; `--agent`, `--path`, and `--context` independently override them
435
435
  - **Reasoning control:** `--thinking-level low|medium|high|xhigh` for supported runners
436
436
  - **Unattended or interactive runs:** default auto mode, or `--no-auto` to wait for user confirmation before each prompt
437
437
  - **Git safety:** clean working tree check by default, or `--git-changes ignore` to keep the changes and `--git-changes continue` to resume an interrupted prompt
@@ -451,11 +451,11 @@ npx ts-node ./src/cli/test/ptbk.ts coder generate-boilerplates --template prompt
451
451
 
452
452
  npx ts-node ./src/cli/test/ptbk.ts coder generate-boilerplates --template prompts/templates/agents-server.md
453
453
 
454
- npx ts-node ./src/cli/test/ptbk.ts coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book --context AGENTS.md
454
+ npx ts-node ./src/cli/test/ptbk.ts coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book
455
455
 
456
- npx ts-node ./src/cli/test/ptbk.ts coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book --context AGENTS.md --auto-push
456
+ npx ts-node ./src/cli/test/ptbk.ts coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book --auto-push
457
457
 
458
- npx ts-node ./src/cli/test/ptbk.ts coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book --context AGENTS.md --git-changes ignore
458
+ npx ts-node ./src/cli/test/ptbk.ts coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book --git-changes ignore
459
459
 
460
460
  npx ts-node ./src/cli/test/ptbk.ts coder find-refactor-candidates
461
461
 
@@ -477,11 +477,11 @@ ptbk coder generate-boilerplates
477
477
 
478
478
  ptbk coder generate-boilerplates --template prompts/templates/common.md
479
479
 
480
- ptbk coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book --context AGENTS.md --test npm run test
480
+ ptbk coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book --check "npm run check"
481
481
 
482
- ptbk coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book --context AGENTS.md --auto-push
482
+ ptbk coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book --auto-push
483
483
 
484
- ptbk coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book --context AGENTS.md --test npm run test --git-changes ignore
484
+ ptbk coder run --harness github-copilot --model gpt-5.4 --thinking-level xhigh --agent agents/coding/developer.book --check "npm run check" --git-changes ignore
485
485
 
486
486
  ptbk coder find-refactor-candidates
487
487
 
@@ -498,33 +498,52 @@ ptbk coder verify
498
498
  | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | ------ | ---- | ----- | ------------------------------------------------------------------------ |
499
499
  | `ptbk coder init` | Creates `prompts/`, `prompts/done/`, the project-generic template files materialized in `prompts/templates/` (currently `common.md`), and a starter `AGENTS.md`; ensures `.env` contains `CODING_AGENT_GIT_NAME`, `CODING_AGENT_GIT_EMAIL`, and `CODING_AGENT_GIT_SIGNING_KEY`; adds helper coder scripts to `package.json`; ensures `.gitignore` contains `/.promptbook`; and configures `.vscode/settings.json` to save pasted prompt images into `prompts/screenshots/`. |
500
500
  | `ptbk coder generate-boilerplates` | Creates new prompt markdown files with fresh emoji tags so you can quickly fill in coding tasks; `--template` accepts either a built-in alias or a markdown file path relative to the project root. |
501
- | `ptbk coder run` | Picks the next ready prompt, can run tests before coding to stop or repair pre-existing failures, appends optional context, runs it through the selected coding agent, can optionally verify each attempt with a shell test command and feed failing output back for retries, then marks success or failure, commits the result, and pushes only when `--auto-push` is enabled. |
501
+ | `ptbk coder run` | Picks the next ready prompt, can run project checks before coding to stop or repair pre-existing failures, appends optional context, runs it through the selected coding agent, can optionally check each attempt with the project command and feed failing output back for retries, then marks success or failure, commits the result, and pushes only when `--auto-push` is enabled. |
502
502
  | `ptbk coder find-refactor-candidates` | Scans the repository for oversized or overpacked files and writes prompt files for likely refactors; `--level <xlow | low | medium | high | xhigh | extreme>` ranges from a very benevolent scan to a very aggressive sweep. |
503
503
  | `ptbk coder verify` | Walks through completed prompts, archives truly finished work, and adds follow-up repair prompts for unfinished results. |
504
504
 
505
505
  #### Most useful `ptbk coder run` flags
506
506
 
507
- | Flag | Purpose |
508
- | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
509
- | `--harness <name>` | Selects the coding harness. |
510
- | `--model <model>` | Chooses the runner model; required for `openai-codex`, `gemini` and `qwen-code`, optional for `github-copilot`. |
511
- | `--context <text-or-file>` | Appends extra instructions inline or from a file like `AGENTS.md`. |
512
- | `--test <command>` | Runs a verification command after each prompt attempt and feeds failing output back for retries. |
513
- | `--test-before <mode>` | Runs tests before coding: `no` (default), `yes-and-fail` (stop with results), or `yes-and-fix` (create one repair prompt first); defaults to `npm test` when enabled without `--test`. |
514
- | `--thinking-level <level>` | Sets reasoning effort for supported runners. |
515
- | `--no-auto` | Waits for user confirmation before each prompt instead of running automatically through the queue. |
516
- | `--git-changes <mode>` | Decides what happens with a dirty working tree: `fail` (default), `ignore` to keep the changes, or `continue` to resume the single interrupted `[^]` prompt with them. |
517
- | `--priority <n>` | Runs only prompts at or above the given priority. |
518
- | `--dry-run` | Prints which prompts are ready instead of executing them. |
519
- | `--allow-credits` | Lets OpenAI Codex spend credits when required. |
520
- | `--auto-push` | Pushes each successful coding-agent commit to the configured remote. |
521
- | `--auto-migrate` | Runs testing-server database migrations after each successful prompt. |
507
+ A **check** is the project's aggregate validation: tests, linting, typechecking, builds, generated-code consistency,
508
+ and other quality checks. `ptbk init` and `ptbk coder init` preserve an existing `scripts.check`, or compose available
509
+ validation scripts and report their scope. Configure the failing setup placeholder if the project has none.
510
+
511
+ ```bash
512
+ ptbk coder run --harness openai-codex --check "npm run check" --check-before yes-and-fix
513
+ ptbk coder run --harness openai-codex --check "npm run lint && npm run build && npm test"
514
+ ```
515
+
516
+ The default preflight mode remains `no`. Enabled preflight uses `npm run check` when no command is supplied;
517
+ post-prompt verification remains opt-in. Initial checks and repairs use the same command and actual process result.
518
+ Replace retired `--test` and `--test-before` with `--check` and `--check-before`. Init migrates recognized generated
519
+ scripts while preserving custom validation. For conflicts or custom callers, it reports the exact entries/files to
520
+ review: preserve the required validation in `check`, update references, then remove the unused legacy entry.
521
+ Automation that invokes `npm run test-for-ptbk-coder` must switch to `npm run check`. Restart an already-running
522
+ Coder invocation with the new flags to release its captured legacy command; initialization creates no compatibility alias.
523
+
524
+ | Flag | Purpose |
525
+ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
526
+ | `--harness <name>` | Selects the coding harness. |
527
+ | `--agent <book>` | Selects the primary Book; defaults to the selected project's `agents/developer.book`. |
528
+ | `--path <directory>` | Selects the project; defaults to invocation cwd. Relative paths start there, not at the CLI installation or enclosing Git root. |
529
+ | `--model <model>` | Chooses the runner model; required for `openai-codex`, `gemini` and `qwen-code`, optional for `github-copilot`. |
530
+ | `--context <text-or-file>` | Replaces the default project `AGENTS.md` with inline instructions or a project-relative file; an empty value disables context. |
531
+ | `--check <command>` | Runs a verification command after each prompt attempt and feeds failing output back for retries. |
532
+ | `--check-before <mode>` | Runs project checks before coding: `no` (default), `yes-and-fail` (stop with results), or `yes-and-fix` (create one repair prompt first); defaults to `npm run check` when enabled without `--check`. |
533
+ | `--thinking-level <level>` | Sets reasoning effort for supported runners. |
534
+ | `--no-auto` | Waits for user confirmation before each prompt instead of running automatically through the queue. |
535
+ | `--git-changes <mode>` | Decides what happens with a dirty working tree: `fail` (default), `ignore` to keep the changes, or `continue` to resume the single interrupted `[^]` prompt with them. |
536
+ | `--priority <n>` | Runs only prompts at or above the given priority. |
537
+ | `--dry-run` | Prints which prompts are ready instead of executing them. |
538
+ | `--allow-credits` | Lets OpenAI Codex spend credits when required. |
539
+ | `--auto-push` | Pushes each successful coding-agent commit to the configured remote. |
540
+ | `--auto-migrate` | Runs testing-server database migrations after each successful prompt. |
522
541
 
523
542
  #### Typical usage pattern
524
543
 
525
544
  1. Initialize once with `ptbk coder init`.
526
545
  2. Customize `prompts/templates/*.md` if needed, then create or write prompt files in `prompts/`.
527
- 3. Customize the starter `AGENTS.md` with repository-specific instructions, then pass `--agent agents/coding/developer.book --context AGENTS.md`.
546
+ 3. Customize `agents/developer.book` and `AGENTS.md`; the runner selects both automatically. Use `--path` for another project or `--agent` and `--context` for explicit overrides.
528
547
  4. Run unattended batches by default, or pass `--no-auto` to confirm each prompt interactively.
529
548
  5. Finish with `ptbk coder verify` so resolved prompts are archived and broken ones get explicit repair follow-ups.
530
549