Repository navigation
feat: add missing CLI flags + fix all documentation - #43
Merged
Merged
Conversation
Flags added: - review --commit <ref>: review git commit/range - review --diff-file <path>: review from diff file - review --quiet: suppress non-essential output - review --severity <level>: filter by min severity - scan --focus <areas>: override focus areas - config show: display resolved config - config set <key> <value>: update config values Documentation fixes: - README: cargo install cora-cli, fix config path, remove non-existent flags (--branch, --full, --commit HEAD), remove Homebrew (tap doesn't exist), fix env vars table - Website docs: fix all 10 inconsistencies across 7 pages - Fix test version assertion (use env var, not hardcoded) Fixes version test to use CARGO_PKG_VERSION env var
|
Warning Review limit reached
More reviews will be available in 49 minutes and 14 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR expands the cora CLI with configuration management, extended review workflows, and scan filtering. It adds a new ChangesConfiguration Management System
Review & Scan Workflow Enhancements
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 11
🧹 Nitpick comments (2)
src/commands/config_cmd.rs (1)
183-187: 💤 Low valueDuplicates
loader::cora_dir().
cora_config_diris identical tocora_dirinsrc/config/loader.rs. Consider promoting the loader's helper topub(crate)and reusing it to avoid drift in the~/.corapath.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/commands/config_cmd.rs` around lines 183 - 187, The function cora_config_dir duplicates loader::cora_dir; change the helper in loader (cora_dir) to pub(crate) and replace cora_config_dir to call loader::cora_dir() instead of reimplementing the home path logic, removing the duplicated function and importing loader::cora_dir where config_cmd uses it so the single source of truth (loader::cora_dir) defines the ~/.cora path.src/git/diff.rs (1)
53-59: 💤 Low valueConsider guarding against ref strings parsed as git options.
ref_strflows straight intogit diff/git showas an argument. A value beginning with-(e.g.--output=<file>) would be interpreted as a git option rather than a revision, which can have surprising side effects. Since this is a local dev tool the blast radius is small, but rejecting refs that start with-(or validating the ref) is cheap hardening.Also note
git show <merge-commit> --format=produces no diff by default for merge commits — acceptable, just be aware.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/git/diff.rs` around lines 53 - 59, The get_commit_diff function currently passes ref_str directly into git_cmd (used with "diff" or "show"), which allows values starting with '-' to be interpreted as git options; update get_commit_diff to validate/sanitize ref_str before calling git_cmd (e.g., reject or error for refs that start with '-' or otherwise fail validation), returning an Err when the ref is invalid, or prefixing the ref with "--" only when appropriate; reference the get_commit_diff function and the git_cmd call to implement the guard and ensure all callers handle the resulting error.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 151-153: The README examples use a positional path (e.g., "cora
scan . --focus security,performance") which doesn't match the CLI contract;
update those examples to either omit the path (rely on default current
directory) or use the long flag ("--path .") so they match the CLI; search for
occurrences of "cora scan . --focus" (and the other example similar at lines
nearby) and replace with either "cora scan --path . --focus
security,performance" or "cora scan --focus security,performance".
- Around line 239-241: The README example uses an invalid severity value
("severity: warning"); update the example to use one of the valid CLI severity
enums (info | minor | major | critical) by replacing the severity line (the
"severity" key in the config snippet) with a permitted value such as "severity:
minor" (or "info"/"major"/"critical") so the sample config is accurate and won't
mislead users.
In `@src/commands/config_cmd.rs`:
- Around line 100-109: The execute_config_set function currently only validates
the key; update it to also validate the provided value for keys "format" and
"severity": when key == "format" ensure value is one of
"pretty","json","compact","sarif" and when key == "severity" ensure value is one
of "info","minor","major","critical"; if the value is out of range, return an
anyhow::bail! with a clear message listing the allowed values (follow the
existing error style used for unsupported keys) so invalid values like "banana"
or "xml" are rejected before persisting.
- Around line 118-126: The current code silently swallows TOML parse errors by
using parse::<toml::Table>().unwrap_or_default(), which can wipe existing config
when you later write; replace the unwrap_or_default() with propagation of the
parse error (e.g. use .parse::<toml::Table>().with_context(|| format!("failed to
parse {} as TOML", path.display()))? or equivalent) so the error bubbles up
instead of returning an empty toml::Table; update the initialization of the
variable table (the let mut table = ... block) to return a contextualized error
on parse failure rather than defaulting.
- Around line 100-181: execute_config_set currently writes settings into
~/.cora/config.toml (using TOML tables) but loader::load_config only reads
CONFIG_FILENAME (.cora.yaml) and load_api_key_from_auth_file only reads
AUTH_FILENAME, so values set by execute_config_set never appear in runtime
Config; update execute_config_set to persist changes into the same YAML-backed
config used by loader::load_config (serialize into the CoraFile/serde_yaml
schema and write to CONFIG_FILENAME) or alternatively extend loader::load_config
to also read and merge the TOML file format written by execute_config_set;
locate execute_config_set, loader::load_config, CoraFile,
load_api_key_from_auth_file, CONFIG_FILENAME and AUTH_FILENAME to implement
consistent read/write behavior so config set updates are reflected at runtime.
In `@src/commands/review.rs`:
- Around line 95-103: The blocking logic is inverted: change the severity
comparison so block decisions match the output filter semantics. In the
should_block function in src/engine/review.rs and the blocking check in
src/commands/scan.rs replace comparisons using issue.severity >= min_severity
with issue.severity <= min_severity so that issues at or above the requested
minimum severity (e.g., critical/major when min_severity is major) will trigger
blocking consistently with the retain/filter logic in review.rs.
In `@website/src/routes/docs/cli-reference/`+page.svelte:
- Around line 134-139: Update the CLI examples that show positional path usage
to use the explicit flag form; replace instances of "cora scan <path>" and "cora
scan ." with "cora scan --path <dir>" and "cora scan --path ." (or leave as
"cora scan" for current directory) so the displayed command syntax matches the
CLI's defined option --path; adjust the two table rows that render <code
class="syntax-highlight">cora scan</code> and <code
class="syntax-highlight">cora scan .</code> accordingly.
In `@website/src/routes/docs/configuration/`+page.svelte:
- Line 73: The example YAML sets "severity: warning" which contradicts the
allowed values in the comment; update the "severity" key in the example to one
of the permitted values (e.g., "severity: minor" or "severity: major") so it
matches the comment's list (info, minor, major, critical) and ensure the
"severity" token in the snippet is changed accordingly.
In `@website/src/routes/docs/getting-started/`+page.svelte:
- Around line 124-125: Update the sample value for the severity field so it
matches the documented enum (info | minor | major | critical): replace the
current "warning" value used in the <div> showing <span
class="syntax-flag">severity:</span> with a valid enum value (e.g., "minor") and
make the same change for the other occurrence noted in the file (the second
severity example around the later block), ensuring both examples use a supported
enum value.
In `@website/src/routes/docs/usage/`+page.svelte:
- Around line 97-99: The displayed default-mode caption ("# Review staged
changes (default)") is inconsistent with the table (which says the default tries
staged first, then unpushed); update the text inside the span with class
"syntax-comment" (the element that currently contains "# Review staged changes
(default)") to reflect the actual behavior, e.g. "Review staged changes
(default: staged, then unpushed)" or similar wording so the page consistently
states "staged first, then unpushed" as the default.
- Line 177: The config example uses an invalid severity value ("warning");
update the example's severity field (the "severity:" entry) to one of the
allowed CLI enum values (info, minor, major, or critical) — e.g., replace
"warning" with "minor" so the snippet is copy-pasteable and valid.
---
Nitpick comments:
In `@src/commands/config_cmd.rs`:
- Around line 183-187: The function cora_config_dir duplicates loader::cora_dir;
change the helper in loader (cora_dir) to pub(crate) and replace cora_config_dir
to call loader::cora_dir() instead of reimplementing the home path logic,
removing the duplicated function and importing loader::cora_dir where config_cmd
uses it so the single source of truth (loader::cora_dir) defines the ~/.cora
path.
In `@src/git/diff.rs`:
- Around line 53-59: The get_commit_diff function currently passes ref_str
directly into git_cmd (used with "diff" or "show"), which allows values starting
with '-' to be interpreted as git options; update get_commit_diff to
validate/sanitize ref_str before calling git_cmd (e.g., reject or error for refs
that start with '-' or otherwise fail validation), returning an Err when the ref
is invalid, or prefixing the ref with "--" only when appropriate; reference the
get_commit_diff function and the git_cmd call to implement the guard and ensure
all callers handle the resulting error.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 48e75ad1-f17c-46b8-a78e-3e822caf1f3d
⛔ Files ignored due to path filters (1)
Cargo.lockis excluded by!**/*.lock
📒 Files selected for processing (15)
README.mdsrc/commands/config_cmd.rssrc/commands/mod.rssrc/commands/review.rssrc/commands/scan.rssrc/git/diff.rssrc/main.rstests/cli_basic.rswebsite/src/routes/docs/cli-reference/+page.sveltewebsite/src/routes/docs/configuration/+page.sveltewebsite/src/routes/docs/examples/+page.sveltewebsite/src/routes/docs/getting-started/+page.sveltewebsite/src/routes/docs/installation/+page.sveltewebsite/src/routes/docs/providers/+page.sveltewebsite/src/routes/docs/usage/+page.svelte
Comment on lines
+151
to
153
| # Scan with focus areas | ||
| cora scan . --focus security,performance | ||
|
|
There was a problem hiding this comment.
Scan examples use a positional path that doesn’t match the CLI contract.
These examples use cora scan . ..., but path is exposed as a long flag (--path). Docs should use cora scan --path . ... (or omit path and rely on default current directory).
Also applies to: 157-158
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 151 - 153, The README examples use a positional path
(e.g., "cora scan . --focus security,performance") which doesn't match the CLI
contract; update those examples to either omit the path (rely on default current
directory) or use the long flag ("--path .") so they match the CLI; search for
occurrences of "cora scan . --focus" (and the other example similar at lines
nearby) and replace with either "cora scan --path . --focus
security,performance" or "cora scan --focus security,performance".
Comment on lines
+239
to
+241
| severity: warning # minimum severity level | ||
| max_issues: 20 # max issues to report | ||
| focus: security,performance # focus areas |
There was a problem hiding this comment.
Use a valid severity enum in the config example.
Line 239 shows severity: warning, but CLI severity values are info | minor | major | critical. This example can mislead users into invalid config values.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 239 - 241, The README example uses an invalid
severity value ("severity: warning"); update the example to use one of the valid
CLI severity enums (info | minor | major | critical) by replacing the severity
line (the "severity" key in the config snippet) with a permitted value such as
"severity: minor" (or "info"/"major"/"critical") so the sample config is
accurate and won't mislead users.
Comment on lines
+100
to
+109
| pub fn execute_config_set(key: &str, value: &str) -> Result<()> { | ||
| // Validate the key | ||
| match key { | ||
| "model" | "provider" | "format" | "severity" => {} | ||
| _ => { | ||
| anyhow::bail!( | ||
| "unsupported key: {key}\nSupported keys: model, provider, format, severity" | ||
| ); | ||
| } | ||
| } |
There was a problem hiding this comment.
Validate the value, not just the key.
The key is validated but the value is accepted unconditionally, so cora config set severity banana or set format xml persists invalid data, diverging from the CLI flags which constrain severity to info|minor|major|critical and format to pretty|json|compact|sarif (see src/main.rs Lines 50, 115). Consider rejecting out-of-range values for format and severity here.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/commands/config_cmd.rs` around lines 100 - 109, The execute_config_set
function currently only validates the key; update it to also validate the
provided value for keys "format" and "severity": when key == "format" ensure
value is one of "pretty","json","compact","sarif" and when key == "severity"
ensure value is one of "info","minor","major","critical"; if the value is out of
range, return an anyhow::bail! with a clear message listing the allowed values
(follow the existing error style used for unsupported keys) so invalid values
like "banana" or "xml" are rejected before persisting.
Comment on lines
+100
to
+181
| pub fn execute_config_set(key: &str, value: &str) -> Result<()> { | ||
| // Validate the key | ||
| match key { | ||
| "model" | "provider" | "format" | "severity" => {} | ||
| _ => { | ||
| anyhow::bail!( | ||
| "unsupported key: {key}\nSupported keys: model, provider, format, severity" | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| let dir = cora_config_dir()?; | ||
| std::fs::create_dir_all(&dir) | ||
| .with_context(|| format!("failed to create {}", dir.display()))?; | ||
|
|
||
| let path = dir.join("config.toml"); | ||
|
|
||
| // Load existing config.toml content if it exists | ||
| let mut table = if path.is_file() { | ||
| let content = std::fs::read_to_string(&path) | ||
| .with_context(|| format!("failed to read {}", path.display()))?; | ||
| content | ||
| .parse::<toml::Table>() | ||
| .unwrap_or_default() | ||
| } else { | ||
| toml::Table::new() | ||
| }; | ||
|
|
||
| // Map the key to the appropriate TOML structure | ||
| match key { | ||
| "model" => { | ||
| let provider = table | ||
| .entry("provider") | ||
| .or_insert_with(|| toml::Value::Table(toml::Table::new())); | ||
| if let toml::Value::Table(p) = provider { | ||
| p.insert("model".to_string(), toml::Value::String(value.to_string())); | ||
| } | ||
| } | ||
| "provider" => { | ||
| let provider = table | ||
| .entry("provider") | ||
| .or_insert_with(|| toml::Value::Table(toml::Table::new())); | ||
| if let toml::Value::Table(p) = provider { | ||
| p.insert("provider".to_string(), toml::Value::String(value.to_string())); | ||
| } | ||
| } | ||
| "format" => { | ||
| let output = table | ||
| .entry("output") | ||
| .or_insert_with(|| toml::Value::Table(toml::Table::new())); | ||
| if let toml::Value::Table(o) = output { | ||
| o.insert("format".to_string(), toml::Value::String(value.to_string())); | ||
| } | ||
| } | ||
| "severity" => { | ||
| let hook = table | ||
| .entry("hook") | ||
| .or_insert_with(|| toml::Value::Table(toml::Table::new())); | ||
| if let toml::Value::Table(h) = hook { | ||
| h.insert( | ||
| "min_severity".to_string(), | ||
| toml::Value::String(value.to_string()), | ||
| ); | ||
| } | ||
| } | ||
| _ => unreachable!(), | ||
| } | ||
|
|
||
| let content = table.to_string(); | ||
| std::fs::write(&path, content) | ||
| .with_context(|| format!("failed to write {}", path.display()))?; | ||
|
|
||
| println!( | ||
| "{} Set {} = {} in {}", | ||
| "✓".green().bold(), | ||
| key.bold(), | ||
| value.green(), | ||
| path.display() | ||
| ); | ||
|
|
||
| Ok(()) | ||
| } |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Confirm no general-config reader consumes ~/.cora/config.toml (only api_key should).
echo "=== references to config.toml / AUTH_FILENAME ==="
rg -nP --type=rust "config\.toml|AUTH_FILENAME" -C3
echo "=== what load_config actually reads ==="
ast-grep --pattern 'pub fn load_config($$$) -> $_ { $$$ }'
echo "=== CONFIG_FILENAME usage ==="
rg -nP --type=rust "CONFIG_FILENAME|\.cora\.yaml" -C2Repository: ajianaz/cora-cli
Length of output: 14562
Fix cora config set to persist into the same config source loader::load_config reads
execute_config_setwritesmodel/provider/format/severityinto~/.cora/config.toml(as TOML tables like[provider],[output],[hook]).loader::load_configbuilds runtimeConfigexclusively from.cora.yaml(CONFIG_FILENAME) plus CLI overrides;~/.cora/config.toml(AUTH_FILENAME) is only read for the API key (load_api_key_from_auth_file).- Therefore, values written by
cora config setwon’t be reflected in the runtime configuration returned byload_config. - Persist these settings into
.cora.yamlusing the existingCoraFile/serde_yaml schema (or update the loader to read a non-auth config file that matches whatconfig setwrites).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/commands/config_cmd.rs` around lines 100 - 181, execute_config_set
currently writes settings into ~/.cora/config.toml (using TOML tables) but
loader::load_config only reads CONFIG_FILENAME (.cora.yaml) and
load_api_key_from_auth_file only reads AUTH_FILENAME, so values set by
execute_config_set never appear in runtime Config; update execute_config_set to
persist changes into the same YAML-backed config used by loader::load_config
(serialize into the CoraFile/serde_yaml schema and write to CONFIG_FILENAME) or
alternatively extend loader::load_config to also read and merge the TOML file
format written by execute_config_set; locate execute_config_set,
loader::load_config, CoraFile, load_api_key_from_auth_file, CONFIG_FILENAME and
AUTH_FILENAME to implement consistent read/write behavior so config set updates
are reflected at runtime.
Comment on lines
+118
to
+126
| let mut table = if path.is_file() { | ||
| let content = std::fs::read_to_string(&path) | ||
| .with_context(|| format!("failed to read {}", path.display()))?; | ||
| content | ||
| .parse::<toml::Table>() | ||
| .unwrap_or_default() | ||
| } else { | ||
| toml::Table::new() | ||
| }; |
There was a problem hiding this comment.
Silent unwrap_or_default() can wipe the existing file (including the stored API key).
If ~/.cora/config.toml fails to parse as TOML, unwrap_or_default() discards its contents and starts from an empty table; the subsequent write then overwrites the file, destroying any prior data such as a saved api_key. Propagate the parse error with context instead of swallowing it.
🛡️ Proposed fix
- content
- .parse::<toml::Table>()
- .unwrap_or_default()
+ content
+ .parse::<toml::Table>()
+ .with_context(|| format!("failed to parse existing {}", path.display()))?📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| let mut table = if path.is_file() { | |
| let content = std::fs::read_to_string(&path) | |
| .with_context(|| format!("failed to read {}", path.display()))?; | |
| content | |
| .parse::<toml::Table>() | |
| .unwrap_or_default() | |
| } else { | |
| toml::Table::new() | |
| }; | |
| let mut table = if path.is_file() { | |
| let content = std::fs::read_to_string(&path) | |
| .with_context(|| format!("failed to read {}", path.display()))?; | |
| content | |
| .parse::<toml::Table>() | |
| .with_context(|| format!("failed to parse existing {}", path.display()))? | |
| } else { | |
| toml::Table::new() | |
| }; |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@src/commands/config_cmd.rs` around lines 118 - 126, The current code silently
swallows TOML parse errors by using parse::<toml::Table>().unwrap_or_default(),
which can wipe existing config when you later write; replace the
unwrap_or_default() with propagation of the parse error (e.g. use
.parse::<toml::Table>().with_context(|| format!("failed to parse {} as TOML",
path.display()))? or equivalent) so the error bubbles up instead of returning an
empty toml::Table; update the initialization of the variable table (the let mut
table = ... block) to return a contextualized error on parse failure rather than
defaulting.
Comment on lines
+134
to
+139
| <td><code class="syntax-highlight">cora scan</code> <code class="text-[var(--muted-foreground)]"><path></code></td> | ||
| <td>Scan files for issues</td> | ||
| </tr> | ||
| <tr> | ||
| <td><code class="syntax-highlight">cora review --file</code> <code class="text-[var(--muted-foreground)]"><path></code></td> | ||
| <td>Review single file</td> | ||
| <td><code class="syntax-highlight">cora scan .</code> <code class="syntax-flag">[--incremental]</code></td> | ||
| <td>Scan only changed files</td> |
There was a problem hiding this comment.
cora scan command syntax is documented incorrectly.
These rows show positional path usage, but the CLI defines path as --path <dir>. Please update examples to cora scan --path . (or just cora scan for current directory).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@website/src/routes/docs/cli-reference/`+page.svelte around lines 134 - 139,
Update the CLI examples that show positional path usage to use the explicit flag
form; replace instances of "cora scan <path>" and "cora scan ." with "cora scan
--path <dir>" and "cora scan --path ." (or leave as "cora scan" for current
directory) so the displayed command syntax matches the CLI's defined option
--path; adjust the two table rows that render <code
class="syntax-highlight">cora scan</code> and <code
class="syntax-highlight">cora scan .</code> accordingly.
| <pre class="whitespace-pre"><span class="syntax-comment"># cora project config</span> | ||
| <span class="syntax-highlight">review:</span> | ||
| <span class="syntax-flag">severity:</span> <span class="syntax-string">warning</span> <span class="syntax-comment"># minimum severity: info, warning, error</span> | ||
| <span class="syntax-flag">severity:</span> <span class="syntax-string">warning</span> <span class="syntax-comment"># minimum severity: info, minor, major, critical</span> |
There was a problem hiding this comment.
Example severity value contradicts allowed values.
Line 73 sets severity: warning but the same comment says valid levels are info, minor, major, critical. Use one of those values in the example.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@website/src/routes/docs/configuration/`+page.svelte at line 73, The example
YAML sets "severity: warning" which contradicts the allowed values in the
comment; update the "severity" key in the example to one of the permitted values
(e.g., "severity: minor" or "severity: major") so it matches the comment's list
(info, minor, major, critical) and ensure the "severity" token in the snippet is
changed accordingly.
Comment on lines
+124
to
+125
| <div> <span class="syntax-flag">severity:</span> <span class="syntax-string">warning</span></div> | ||
| <div> <span class="syntax-flag">focus:</span> <span class="syntax-string">security,performance</span></div> |
There was a problem hiding this comment.
Severity example value is inconsistent with the documented enum.
The sample uses warning, but the documented valid values are info | minor | major | critical. Please align the example with the supported set.
Also applies to: 135-135
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@website/src/routes/docs/getting-started/`+page.svelte around lines 124 - 125,
Update the sample value for the severity field so it matches the documented enum
(info | minor | major | critical): replace the current "warning" value used in
the <div> showing <span class="syntax-flag">severity:</span> with a valid enum
value (e.g., "minor") and make the same change for the other occurrence noted in
the file (the second severity example around the later block), ensuring both
examples use a supported enum value.
Comment on lines
+97
to
+99
| <div><span class="syntax-comment"># Review staged changes (default)</span></div> | ||
| <div><span class="syntax-cmd">$</span> <span class="syntax-highlight">cora review</span></div> | ||
| <div></div> |
There was a problem hiding this comment.
Align default-mode wording with the behavior described above.
Line 97 says default is “staged changes”, but the table states default tries staged first, then unpushed. Use one consistent description.
Suggested fix
- <div><span class="syntax-comment"># Review staged changes (default)</span></div>
+ <div><span class="syntax-comment"># Review default mode (staged first, then unpushed)</span></div>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| <div><span class="syntax-comment"># Review staged changes (default)</span></div> | |
| <div><span class="syntax-cmd">$</span> <span class="syntax-highlight">cora review</span></div> | |
| <div></div> | |
| <div><span class="syntax-comment"># Review default mode (staged first, then unpushed)</span></div> | |
| <div><span class="syntax-cmd">$</span> <span class="syntax-highlight">cora review</span></div> | |
| <div></div> |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@website/src/routes/docs/usage/`+page.svelte around lines 97 - 99, The
displayed default-mode caption ("# Review staged changes (default)") is
inconsistent with the table (which says the default tries staged first, then
unpushed); update the text inside the span with class "syntax-comment" (the
element that currently contains "# Review staged changes (default)") to reflect
the actual behavior, e.g. "Review staged changes (default: staged, then
unpushed)" or similar wording so the page consistently states "staged first,
then unpushed" as the default.
| <div><span class="syntax-comment"># .cora.yaml — example</span></div> | ||
| <div></div> | ||
| <div><span class="syntax-highlight">review:</span></div> | ||
| <div> <span class="syntax-flag">severity:</span> <span class="syntax-string">warning</span></div> |
There was a problem hiding this comment.
Use a valid severity enum value in the config example.
Line 177 uses warning, but the CLI severity levels are info | minor | major | critical. This example is copy-pasteable and currently invalid.
Suggested fix
- <div> <span class="syntax-flag">severity:</span> <span class="syntax-string">warning</span></div>
+ <div> <span class="syntax-flag">severity:</span> <span class="syntax-string">minor</span></div>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| <div> <span class="syntax-flag">severity:</span> <span class="syntax-string">warning</span></div> | |
| <div> <span class="syntax-flag">severity:</span> <span class="syntax-string">minor</span></div> |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@website/src/routes/docs/usage/`+page.svelte at line 177, The config example
uses an invalid severity value ("warning"); update the example's severity field
(the "severity:" entry) to one of the allowed CLI enum values (info, minor,
major, or critical) — e.g., replace "warning" with "minor" so the snippet is
copy-pasteable and valid.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
New CLI Flags (8 additions)
Review command:
--commit <ref>— review git commit/range (e.g. HEAD, HEAD~3..HEAD, abc123)--diff-file <path>— review from a diff file instead of git--quiet/-q— suppress non-essential output--severity <level>— filter results by minimum severity (info|minor|major|critical)Scan command:
--focus <areas>— override focus areas (e.g. security,performance)Config command (new):
cora config show— display resolved configurationcora config set <key> <value>— set config values (model, provider, format, severity)Documentation Fixes (25 inconsistencies)
README: cargo install cora-cli, config path ~/.cora/config.toml, removed non-existent flags, removed Homebrew, rewrote commands section, fixed env vars table
Website docs (7 pages): Installation, Usage, CLI Reference, Providers, Examples, Configuration, Getting Started — all fixed to match actual code
Test Fix
Test Results
Summary by CodeRabbit
New Features
cora configsubcommand to display and configure settings.cora reviewwith--commit,--diff-file,--quiet, and--severityfiltering options.--focusparameter tocora scanfor overriding focus areas.Documentation