Conversation
Reviewer's GuideThis PR drops the crate-level non_snake_case allowance by extracting the GlobalArgs, PrArgs, and IssueArgs definitions (and their impls) into a new cli_args module with module-level lint expectations, and updates all references to these types throughout main.rs to use the new cli_args namespace. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Warning Rate limit exceeded@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 34 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, 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 have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
Summary by CodeRabbit
WalkthroughRefactor the CLI argument structs by relocating Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @leynos - I've reviewed your changes and found some issues that need to be addressed.
- Derive Default on PrArgs and IssueArgs instead of providing manual impl Default so you can remove the #[allow(clippy::derivable_impls)] and reduce boilerplate.
- Consider re-exporting or aliasing the cli_args types at the crate root (or adding use statements in main.rs) to reduce the verbosity of repeated cli_args:: prefixes.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Derive Default on PrArgs and IssueArgs instead of providing manual impl Default so you can remove the #[allow(clippy::derivable_impls)] and reduce boilerplate.
- Consider re-exporting or aliasing the cli_args types at the crate root (or adding use statements in main.rs) to reduce the verbosity of repeated cli_args:: prefixes.
## Individual Comments
### Comment 1
<location> `src/main.rs:41` </location>
<code_context>
- #[arg(long)]
- repo: Option<String>,
-}
+mod cli_args {
+ #![expect(non_snake_case, reason = "clap generates non-snake-case modules")]
+ #![expect(unused_imports, reason = "clap derives import the struct internally")]
</code_context>
<issue_to_address>
Consider moving the CLI argument structs into a separate file to simplify imports and reduce inline module clutter in main.rs.
Consider pulling the CLI‐arg types out into their own file so that you
• lose the inline `mod cli_args { … }` noise
• can `use cli_args::{GlobalArgs,PrArgs,IssueArgs}` once at the top
• remove all those repetitive `cli_args::` prefixes
• drop the `#![expect(...)]` attr blocks
For example:
```rust
// src/cli_args.rs
use clap::Parser;
use serde::{Deserialize,Serialize};
use ortho_config::OrthoConfig;
#[derive(Parser, Deserialize, Serialize, Default, Debug, OrthoConfig, Clone)]
#[ortho_config(prefix = "VK")]
pub struct GlobalArgs {
/// Repository used when passing only a pull request number
#[arg(long)]
pub repo: Option<String>,
}
impl GlobalArgs {
pub fn merge(&mut self, other: Self) {
if let Some(repo) = other.repo {
self.repo = Some(repo);
}
}
}
#[derive(Parser, Deserialize, Serialize, Default, Debug, OrthoConfig, Clone)]
#[ortho_config(prefix = "VK")]
pub struct PrArgs {
/// Pull request URL or number
#[arg(required = true)]
pub reference: Option<String>,
}
#[derive(Parser, Deserialize, Serialize, Default, Debug, OrthoConfig, Clone)]
#[ortho_config(prefix = "VK")]
pub struct IssueArgs {
/// Issue URL or number
#[arg(required = true)]
pub reference: Option<String>,
}
```
And in `main.rs`:
```rust
mod cli_args;
use cli_args::{GlobalArgs, PrArgs, IssueArgs};
#[derive(Subcommand, Deserialize, Serialize, Clone, Debug)]
enum Commands {
Pr(PrArgs),
Issue(IssueArgs),
}
#[derive(Parser)]
#[command(
name = "vk",
about = "View Komments - show unresolved PR comments",
subcommand_required = true,
arg_required_else_help = true
)]
struct Cli {
#[command(subcommand)]
command: Commands,
#[command(flatten)]
global: GlobalArgs,
}
```
This keeps all functionality, removes inline nesting, and drastically trims down your `main.rs`.
</issue_to_address>
### Comment 2
<location> `src/main.rs:41` </location>
<code_context>
- #[arg(long)]
- repo: Option<String>,
-}
+mod cli_args {
+ #![expect(non_snake_case, reason = "clap generates non-snake-case modules")]
+ #![expect(unused_imports, reason = "clap derives import the struct internally")]
</code_context>
<issue_to_address>
The new `cli_args` module does not begin with a `//!` module-level comment as required.
Please add a `//!` doc comment at the very top of the `cli_args` module to describe its purpose, as per the project guidelines.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
src/main.rs(5 hunks)
📓 Path-based instructions (1)
**/*.rs
📄 CodeRabbit Inference Engine (AGENTS.md)
**/*.rs: Run cargo fmt, cargo clippy -- -D warnings, and RUSTFLAGS="-D warnings" cargo test before committing.
Clippy warnings MUST be disallowed.
Fix any warnings emitted during tests in the code itself rather than silencing them.
Where a function is too long, extract meaningfully named helper functions adhering to separation of concerns and CQRS.
Where a function has too many parameters, group related parameters in meaningfully named structs.
Where a function is returning a large error consider using Arc to reduce the amount of data returned.
Write unit and behavioural tests for new functionality. Run both before and after making any change.
Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Avoid unsafe code unless absolutely necessary and document any usage clearly.
Files:
src/main.rs
⚙️ CodeRabbit Configuration File
**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.
Adhere to single responsibility and CQRS
Place function attributes after doc comments.
Do not use
returnin single-line functions.Move conditionals with >2 branches into a predicate function.
Avoid
unsafeunless absolutely necessary.Every module must begin with a
//!doc comment that explains the module's purpose and utility.Comments and docs must follow en-GB-oxendict (-ize / -our) spelling and grammar
Lints must not be silenced except as a last resort.
#[allow]is forbidden.- Only narrowly scoped
#[expect(lint, reason = "...")]is allowed.- No lint groups, no blanket or file-wide suppression.
- Include
FIXME:with link if a fix is expected.Use
rstestfixtures for shared setup and to avoid repetition between tests.Replace duplicated tests with
#[rstest(...)]parameterised cases.Prefer
mockallfor mocks/stubs.Prefer
.expect()over.unwrap()Ensure that any API or behavioural changes are reflected in the documentation in
docs/Ensure that any completed roadmap steps are recorded in the appropriate roadmap in
docs/Files must not exceed 400 lines in length
- Large modules must be decomposed
- Long match statements or dispatch tables should be decomposed by domain and collocated with targets
- Large blocks of inline data (e.g., test fixtures, constants or templates) must be moved to external files and inlined at compile-time or loaded at run-time.
Files:
src/main.rs
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rs
📄 CodeRabbit Inference Engine (AGENTS.md)
**/*.rs: Run cargo fmt, cargo clippy -- -D warnings, and RUSTFLAGS="-D warnings" cargo test before committing.
Clippy warnings MUST be disallowed.
Fix any warnings emitted during tests in the code itself rather than silencing them.
Where a function is too long, extract meaningfully named helper functions adhering to separation of concerns and CQRS.
Where a function has too many parameters, group related parameters in meaningfully named structs.
Where a function is returning a large error consider using Arc to reduce the amount of data returned.
Write unit and behavioural tests for new functionality. Run both before and after making any change.
Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Avoid unsafe code unless absolutely necessary and document any usage clearly.
Files:
src/main.rs
⚙️ CodeRabbit Configuration File
**/*.rs: * Seek to keep the cyclomatic complexity of functions no more than 12.
Adhere to single responsibility and CQRS
Place function attributes after doc comments.
Do not use
returnin single-line functions.Move conditionals with >2 branches into a predicate function.
Avoid
unsafeunless absolutely necessary.Every module must begin with a
//!doc comment that explains the module's purpose and utility.Comments and docs must follow en-GB-oxendict (-ize / -our) spelling and grammar
Lints must not be silenced except as a last resort.
#[allow]is forbidden.- Only narrowly scoped
#[expect(lint, reason = "...")]is allowed.- No lint groups, no blanket or file-wide suppression.
- Include
FIXME:with link if a fix is expected.Use
rstestfixtures for shared setup and to avoid repetition between tests.Replace duplicated tests with
#[rstest(...)]parameterised cases.Prefer
mockallfor mocks/stubs.Prefer
.expect()over.unwrap()Ensure that any API or behavioural changes are reflected in the documentation in
docs/Ensure that any completed roadmap steps are recorded in the appropriate roadmap in
docs/Files must not exceed 400 lines in length
- Large modules must be decomposed
- Long match statements or dispatch tables should be decomposed by domain and collocated with targets
- Large blocks of inline data (e.g., test fixtures, constants or templates) must be moved to external files and inlined at compile-time or loaded at run-time.
Files:
src/main.rs
| mod cli_args { | ||
| #![expect(non_snake_case, reason = "clap generates non-snake-case modules")] | ||
| #![expect(unused_imports, reason = "clap derives import the struct internally")] | ||
| use super::{OrthoConfig, Parser}; |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add a module-level //! doc comment and avoid relying on super::Parser.
The coding guidelines mandate that every module starts with a //! explaining its purpose.
Additionally, importing Parser from super couples this module to the parent’s use list; import it directly from clap to keep the module self-contained.
- mod cli_args {
+//! Argument structs and helpers kept separate so lints can be scoped tightly.
+mod cli_args {
@@
- use super::{OrthoConfig, Parser};
- use serde::{Deserialize, Serialize};
+ use clap::Parser;
+ use super::OrthoConfig;
+ use serde::{Deserialize, Serialize};🤖 Prompt for AI Agents
In src/main.rs around lines 41 to 44, add a module-level doc comment using //!
to describe the purpose of the cli_args module at the top of the module. Replace
the import of Parser from super with a direct import from the clap crate to make
the module self-contained and avoid coupling to the parent module's imports.
| #[derive(Parser, Deserialize, Serialize, Default, Debug, OrthoConfig, Clone)] | ||
| #[ortho_config(prefix = "VK")] | ||
| pub struct GlobalArgs { | ||
| /// Repository used when passing only a pull request number | ||
| #[arg(long)] | ||
| pub repo: Option<String>, | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Document the public GlobalArgs struct.
GlobalArgs is now pub, but it lacks a Rustdoc comment, violating the public-API documentation requirement.
-#[derive(Parser, Deserialize, Serialize, Default, Debug, OrthoConfig, Clone)]
+/// Global options that apply to every sub-command (e.g. `--repo`).
+#[derive(Parser, Deserialize, Serialize, Default, Debug, OrthoConfig, Clone)]📝 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.
| #[derive(Parser, Deserialize, Serialize, Default, Debug, OrthoConfig, Clone)] | |
| #[ortho_config(prefix = "VK")] | |
| pub struct GlobalArgs { | |
| /// Repository used when passing only a pull request number | |
| #[arg(long)] | |
| pub repo: Option<String>, | |
| } | |
| /// Global options that apply to every sub-command (e.g. `--repo`). | |
| #[derive(Parser, Deserialize, Serialize, Default, Debug, OrthoConfig, Clone)] | |
| #[ortho_config(prefix = "VK")] | |
| pub struct GlobalArgs { | |
| /// Repository used when passing only a pull request number | |
| #[arg(long)] | |
| pub repo: Option<String>, | |
| } |
🤖 Prompt for AI Agents
In src/main.rs around lines 47 to 53, the public struct GlobalArgs lacks a
Rustdoc comment. Add a clear and concise Rustdoc comment above the GlobalArgs
struct definition explaining its purpose and usage to satisfy public API
documentation requirements.
| impl GlobalArgs { | ||
| pub fn merge(&mut self, other: GlobalArgs) { | ||
| if let Some(repo) = other.repo { | ||
| self.repo = Some(repo); | ||
| } | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Document the public merge method.
Expose intent and precedence rules so downstream users understand how configuration layering works.
- pub fn merge(&mut self, other: GlobalArgs) {
+ /// Merge another instance into `self`, overwriting only fields that are
+ /// currently `None`.
+ ///
+ /// CLI flags have higher priority than configuration sources.
+ pub fn merge(&mut self, other: GlobalArgs) {📝 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.
| impl GlobalArgs { | |
| pub fn merge(&mut self, other: GlobalArgs) { | |
| if let Some(repo) = other.repo { | |
| self.repo = Some(repo); | |
| } | |
| } | |
| impl GlobalArgs { | |
| /// Merge another instance into `self`, overwriting only fields that are | |
| /// currently `None`. | |
| /// | |
| /// CLI flags have higher priority than configuration sources. | |
| pub fn merge(&mut self, other: GlobalArgs) { | |
| if let Some(repo) = other.repo { | |
| self.repo = Some(repo); | |
| } | |
| } |
🤖 Prompt for AI Agents
In src/main.rs around lines 55 to 60, the public method `merge` lacks
documentation explaining its purpose and behavior. Add a doc comment above the
`merge` method describing that it merges another GlobalArgs into self,
specifying that non-None values in the other argument take precedence and
overwrite existing values. Clarify the intent that this method is used for
configuration layering to help downstream users understand how merging affects
the final configuration.
| #[derive(Parser, Deserialize, Serialize, Debug, OrthoConfig, Clone)] | ||
| #[ortho_config(prefix = "VK")] | ||
| pub struct PrArgs { | ||
| /// Pull request URL or number | ||
| #[arg(required = true)] | ||
| // Clap marks the argument as required so parsing yields `Some(value)`. The | ||
| // `Option` allows `PrArgs::default()` and config merging to leave it unset. | ||
| pub reference: Option<String>, | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add Rustdoc for the public PrArgs struct.
-#[derive(Parser, Deserialize, Serialize, Debug, OrthoConfig, Clone)]
+/// Parameters accepted by the `pr` sub-command.
+#[derive(Parser, Deserialize, Serialize, Debug, OrthoConfig, Clone)]🤖 Prompt for AI Agents
In src/main.rs around lines 63 to 71, the public struct PrArgs lacks Rustdoc
comments. Add a Rustdoc comment above the PrArgs struct definition that clearly
describes its purpose and usage, explaining that it holds command-line arguments
related to pull requests, including the reference field for the PR URL or
number.
| #[derive(Parser, Deserialize, Serialize, Debug, OrthoConfig, Clone)] | ||
| #[ortho_config(prefix = "VK")] | ||
| pub struct IssueArgs { | ||
| /// Issue URL or number | ||
| #[arg(required = true)] | ||
| // The argument is required and will parse to `Some`, but `Option` permits | ||
| // defaults or config merging to leave it unset. | ||
| pub reference: Option<String>, | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add Rustdoc for the public IssueArgs struct.
-#[derive(Parser, Deserialize, Serialize, Debug, OrthoConfig, Clone)]
+/// Parameters accepted by the `issue` sub-command.
+#[derive(Parser, Deserialize, Serialize, Debug, OrthoConfig, Clone)]📝 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.
| #[derive(Parser, Deserialize, Serialize, Debug, OrthoConfig, Clone)] | |
| #[ortho_config(prefix = "VK")] | |
| pub struct IssueArgs { | |
| /// Issue URL or number | |
| #[arg(required = true)] | |
| // The argument is required and will parse to `Some`, but `Option` permits | |
| // defaults or config merging to leave it unset. | |
| pub reference: Option<String>, | |
| } | |
| /// Parameters accepted by the `issue` sub-command. | |
| #[derive(Parser, Deserialize, Serialize, Debug, OrthoConfig, Clone)] | |
| #[ortho_config(prefix = "VK")] | |
| pub struct IssueArgs { | |
| /// Issue URL or number | |
| #[arg(required = true)] | |
| // The argument is required and will parse to `Some`, but `Option` permits | |
| // defaults or config merging to leave it unset. | |
| pub reference: Option<String>, | |
| } |
🤖 Prompt for AI Agents
In src/main.rs around lines 80 to 88, the public struct IssueArgs lacks Rustdoc
comments. Add a Rustdoc comment above the IssueArgs struct definition that
clearly describes its purpose and usage to improve code documentation and
clarity for users of this struct.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/vk-design.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.md
📄 CodeRabbit Inference Engine (AGENTS.md)
docs/**/*.md: Reference: Use the markdown files within the docs/ directory as a knowledge base and source of truth for project requirements, dependency choices, and architectural decisions.
Update: When new decisions are made, requirements change, libraries are added/removed, or architectural patterns evolve, proactively update the relevant file(s) in the docs/ directory to reflect the latest state.
Files:
docs/vk-design.md
**/*.md
📄 CodeRabbit Inference Engine (AGENTS.md)
**/*.md: Validate Markdown files using markdownlint.
Validate Markdown Mermaid diagrams using the nixie CLI.
Files:
docs/vk-design.md
⚙️ CodeRabbit Configuration File
**/*.md: * Avoid 2nd person or 1st person pronouns ("I", "you", "we")
- Use en-GB-oxendict (-ize / -our) spelling and grammar
- Paragraphs and bullets must be wrapped to 80 columns, except where a long URL would prevent this (in which case, silence MD013 for that line)
- Code blocks should be wrapped to 120 columns.
- Headings must not be wrapped.
- Documents must start with a level 1 heading
- Headings must correctly increase or decrease by no more than one level at a time
- Use GitHub-flavoured Markdown style for footnotes and endnotes.
- Numbered footnotes must be numbered by order of appearance in the document.
Files:
docs/vk-design.md
1 participant
Summary
non_snake_caseTesting
cargo clippy -- -D warningsRUSTFLAGS="-D warnings" cargo testhttps://chatgpt.com/codex/tasks/task_e_687ecd1e51a483229409a1cccd464d01
Summary by Sourcery
Isolate CLI argument structs into a dedicated module with localized lint expectations and remove the crate-level non_snake_case allowance, updating all references accordingly.
Enhancements: