From 8e5064c5478373b56dae2f08c044bc019da1254e Mon Sep 17 00:00:00 2001 From: YeonGyu-Kim Date: Fri, 5 Dec 2025 02:53:38 +0900 Subject: [PATCH] docs: add comment-checker hook documentation --- README.en.md | 50 ++++++++++++++++++++------------------------------ README.ko.md | 1 + 2 files changed, 21 insertions(+), 30 deletions(-) diff --git a/README.en.md b/README.en.md index 012bf9b..cc7e980 100644 --- a/README.en.md +++ b/README.en.md @@ -49,6 +49,25 @@ Add to `~/.config/opencode/opencode.json`: You can configure Oh My OpenCode by creating a `oh-my-opencode.json` (or `.oh-my-opencode.json`) file in your project root. +### JSON Schema Support + +For autocompletion and validation in VS Code (or other editors), add the `$schema` property to your configuration file. + +**Using Remote Schema (Recommended):** +```json +{ + "$schema": "https://raw.githubusercontent.com/code-yeongyu/oh-my-opencode/master/dist/oh-my-opencode.schema.json", + "disabled_mcps": ["context7"] +} +``` + +**Using Local Schema:** +```json +{ + "$schema": "./node_modules/oh-my-opencode/dist/oh-my-opencode.schema.json" +} +``` + ### Disable specific MCPs If you want to disable specific built-in MCPs, you can use the `disabled_mcps` option. @@ -59,36 +78,6 @@ If you want to disable specific built-in MCPs, you can use the `disabled_mcps` o } ``` -### Disable specific Agents - -If you want to disable specific built-in agents, you can use the `disabled_agents` option. -Available agents: `oracle`, `librarian`, `explore`, `frontend-ui-ux-engineer`, `document-writer` - -```json -{ - "disabled_agents": ["oracle", "librarian"] -} -``` - -### Override Agents - -You can override the configuration of built-in agents using the `agents` option. -Overridable properties: `model`, `temperature`, `tools`, `permission`, `color`, `disable`, `mode`. - -```json -{ - "agents": { - "oracle": { - "model": "anthropic/claude-3-7-sonnet-20250219", - "temperature": 0.5 - }, - "frontend-ui-ux-engineer": { - "tools": ["playwright_browser_take_screenshot"] - } - } -} -``` - ## TL;DR - **Model Setup Required** @@ -126,6 +115,7 @@ I believe in the right tool for the job. For your wallet's sake, use CLIProxyAPI - **Context Window Monitor**: Implements [Context Window Anxiety Management](https://agentic-patterns.com/patterns/context-window-anxiety-management/). When context usage exceeds 70%, it reminds the agent that resources are sufficient, preventing rushed or low-quality output. - **Session Notification**: Sends a native OS notification when the job is done (macOS, Linux, Windows). - **Session Recovery**: Automatically recovers from API errors by injecting missing tool results and correcting thinking block violations, ensuring session stability. +- **Comment Checker**: Detects and reports unnecessary comments after code modifications. Smartly ignores valid patterns (BDD, directives, docstrings, shebangs) to keep the codebase clean from AI-generated artifacts. ### Agents - **oracle** (`openai/gpt-5.1`): The architect. Expert in code reviews and strategy. Uses GPT-5.1 for its unmatched logic and reasoning capabilities. Inspired by AmpCode. diff --git a/README.ko.md b/README.ko.md index aa06ef7..d52faa5 100644 --- a/README.ko.md +++ b/README.ko.md @@ -83,6 +83,7 @@ OpenCode 는 아주 확장가능하고 아주 커스터마이저블합니다. - **Context Window Monitor**: [컨텍스트 윈도우 불안 관리](https://agentic-patterns.com/patterns/context-window-anxiety-management/) 패턴을 구현합니다. - 사용량이 70%를 넘으면 에이전트에게 아직 토큰이 충분하다고 상기시켜, 급하게 불완전한 작업을 하는 것을 완화합니다. - **Session Notification**: 에이전트가 작업을 마치면 OS 네이티브 알림을 보냅니다 (macOS, Linux, Windows). +- **Comment Checker**: 코드 수정 후 불필요한 주석을 감지하여 보고합니다. BDD 패턴, 지시어, 독스트링 등 유효한 주석은 똑똑하게 제외하고, AI가 남긴 흔적을 제거하여 코드를 깨끗하게 유지합니다. ### Agents