tuicr/Q/What configuration options does tuicr have for review comment types?
Properties
- logseq-entity
- Logseq/Entity/Question
What configuration options does tuicr have for review comment types?
AI Answer
- Answer/Official from docs/CONFIG.md — Comment types
- Short answer: a top-level
comment_typesarray inconfig.tomldefines named categories (e.g.praise,nit); each entry drives the TUI badge, the[TYPE]export/submit tag, and the Tab cycle order. - Where:
~/.config/tuicr/config.toml($XDG_CONFIG_HOME/tuicr/config.tomlon Linux/macOS,%APPDATA%\tuicr\config.tomlon Windows). - Fields per entry:
id— required, stable internal value saved in sessions and used for matching.label— optional, visible tag shown in the UI/export/submitted comment (e.g.[NITPICK]); defaults toiduppercased.definition— optional guidance text for LLMs, included in the exportedComment types:legend.color— optional badge/border color (terminal name likeyellowor hex#RRGGBB).
- Example from the docs:toml
comment_types = [ { id = "note", label = "question", definition = "ask for clarification", color = "yellow" }, { id = "suggestion", definition = "possible improvements" }, { id = "issue", definition = "problems to fix" }, { id = "praise", definition = "positive feedback" }, { id = "nit", label = "nitpick", definition = "small optional tweaks", color = "#d19a66" }, ] - Defaults and the
Nonetype: ifcomment_typesis omitted, comments are untyped (None) — no[TYPE]tag and no badge.Nonealways stays available at the end of the Tab cycle so an untyped comment is always possible. - Replacement, not merge:
comment_typesfully replaces the configured set; the first configured type becomes the default, and invalid entries are dropped with a startup warning (falling back toNoneonly if all entries are invalid). tuicr review add --type <id>warns on stderr (but still exits0) if<id>isn't a configured type, listing valid ids.- Related
[forge]setting:comment_type_prefix(defaulttrue) controls whether[TYPE]is prepended to the comment body on submit, e.g.[ISSUE] Magic number should be a constant; set tofalseto submit the raw text. - Related
[export]setting:legend(defaulttrue) controls whether theComment types:legend is included in exported Markdown.