Skip to content

docs: add console logging rule — app().log only, console for startup only - #18

Merged
four-bytes-robby merged 1 commit into
mainfrom
docs/add-console-logging-rule
Jun 20, 2026
Merged

docs: add console logging rule — app().log only, console for startup only#18
four-bytes-robby merged 1 commit into
mainfrom
docs/add-console-logging-rule

Conversation

@four-bytes-robby

@four-bytes-robby four-bytes-robby commented Jun 19, 2026

Copy link
Copy Markdown
Member

Changes

Added console logging convention to AGENTS.md.

Rule

Plugins MUST use _client?.app?.log() for all logging in plugin mode — console.log / console.warn / console.error is ONLY permitted for the initial startup "init" message. Console output in plugin mode breaks the terminal UI.


Summary by cubic

Documented console logging rule: plugins must use _client?.app?.log() in plugin mode; console.log / console.warn / console.error are only allowed for the startup "init" message to avoid breaking the terminal UI.
Also updated references to the central standards path to ~/ai-shared-rules/AGENTS.md.

Written for commit 3968911. Summary will update on new commits.

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Updated AI agent guidelines with revised shared standards references and plugin development practices.

@four-bytes-robby four-bytes-robby self-assigned this Jun 19, 2026
@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

Recent review info
Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 0e7c554b-392f-45a7-bef3-9303f5403789

Commits

Reviewing files that changed from the base of the PR and between e4dfe9b and 3968911.

Files selected for processing (1)
  • AGENTS.md

Walkthrough

Walkthrough

AGENTS.md is updated in two ways: the shared standards file reference path is changed from ~/.personal-config/ai-shared/AGENTS.md to ~/ai-shared-rules/AGENTS.md in two locations, and a new mandatory rule is added requiring plugin-mode code to use _client?.app?.log() for all logging, with console.log/warn/error permitted only for the initial "init" startup message.

Changes

AGENTS.md updates

Layer / File(s) Summary
Shared standards path update and plugin logging constraint AGENTS.md Two occurrences of the old ~/.personal-config/ai-shared/AGENTS.md path are replaced with ~/ai-shared-rules/AGENTS.md, and a new mandatory rule is added specifying that plugin mode must use _client?.app?.log() for all logging, restricting console.log/warn/error to only the initial "init" message.

Estimated code review effort

3 (Moderate) | ~15 minutes

Possibly related issues

Pre-merge checks | ✅ 4
✅ Passed checks (4 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 change: adding a console logging rule that requires app().log() for plugin logging and restricts console methods to startup only.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

Finishing Touches
Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-console-logging-rule
Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/add-console-logging-rule

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

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@four-bytes-robby
four-bytes-robby merged commit 5df3510 into main Jun 20, 2026
6 checks passed
@four-bytes-robby
four-bytes-robby deleted the docs/add-console-logging-rule branch June 20, 2026 07:41
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