Skip to content

docs(core,shared): clarify task-id alphabet and utility contracts#7

Open
Atman36 wants to merge 1 commit intobasilisk-labs:mainfrom
Atman36:codex/docs-core-shared-clarity
Open

docs(core,shared): clarify task-id alphabet and utility contracts#7
Atman36 wants to merge 1 commit intobasilisk-labs:mainfrom
Atman36:codex/docs-core-shared-clarity

Conversation

@Atman36
Copy link

@Atman36 Atman36 commented Feb 14, 2026

Summary

Applies key documentation clarifications from the external analysis report in a minimal, low-risk PR.

Changes

  • add explanatory comment for TASK_ID_ALPHABET (Crockford base32 rationale)
  • add JSDoc for isRecord shared guard
  • add JSDoc for resolveCommitEmojiForAgent fallback contract

Validation

  • npx vitest run packages/agentplane/src/shared/agent-emoji.unit.test.ts packages/core/src/config/config.test.ts
  • repository hooks (pre-commit, pre-push) passed

Summary by CodeRabbit

  • New Features

    • Added per-agent emoji configuration support with automatic fallback handling
  • Improvements

    • Enhanced type validation utilities for improved object detection
    • Improved task ID alphabet implementation for consistent generation

@coderabbitai
Copy link

coderabbitai bot commented Feb 14, 2026

📝 Walkthrough

Walkthrough

Three new utility additions are introduced across shared packages: a function to resolve commit emoji for agents from configuration files with fallback logic, a type guard for identifying plain objects, and a Crockford's base32 alphabet constant for task ID generation.

Changes

Cohort / File(s) Summary
Emoji Resolution
packages/agentplane/src/shared/agent-emoji.ts
New resolveCommitEmojiForAgent function that reads per-agent commit emoji configuration from JSON files with fallback to existing emoji resolution.
Type Guards & Constants
packages/agentplane/src/shared/guards.ts, packages/core/src/tasks/task-id.ts
New isRecord type guard for identifying plain objects and new TASK_ID_ALPHABET constant using Crockford's base32 alphabet for task ID generation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hop, hop, hooray! With emoji bright,
Guards to check if types are right,
Alphabets for tasks to code,
Down the agentplane's happy road! 🎨

🚥 Pre-merge checks | ✅ 3 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: adding clarifying documentation (comments/JSDoc) to task-id alphabet and utility contracts (isRecord, resolveCommitEmojiForAgent).
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into main

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉


Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant