Skip to content

Implement manual default for BuildTargets#92

Merged
leynos merged 3 commits intomainfrom
codex/remove-default-derive-for-buildtargets
Aug 12, 2025
Merged

Implement manual default for BuildTargets#92
leynos merged 3 commits intomainfrom
codex/remove-default-derive-for-buildtargets

Conversation

@leynos
Copy link
Owner

@leynos leynos commented Aug 8, 2025

Summary

  • replace Default derive on BuildTargets with manual implementation
  • ensure clippy passes by explaining intentional manual impl

closes #85

Testing

  • make fmt
  • make lint
  • make test

https://chatgpt.com/codex/tasks/task_e_6896817117bc83229dcf4b9e11b6aa31

Summary by Sourcery

Implement a manual Default implementation for BuildTargets to replace the derive and handle non-'static lifetimes while addressing Clippy warnings.

Enhancements:

  • Replace derived Default on BuildTargets with a custom implementation returning an empty slice.
  • Add clippy allow annotations to explain the intentional manual Default impl for lifetimes.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Aug 8, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR removes the auto-derived Default implementation for BuildTargets and provides a custom Default impl that returns an empty slice, along with clippy allowances and a justification comment to satisfy non-'static lifetime requirements.

Class diagram for manual Default implementation on BuildTargets

classDiagram
    class BuildTargets {
        +&[String] data
        +as_slice() &[String]
        +is_empty() bool
        +len() usize
        +Default::default() BuildTargets // now manually implemented
    }
Loading

File-Level Changes

Change Details Files
Manual Default implementation for BuildTargets replacing derive(Default)
  • Removed Default from the derive attributes on BuildTargets
  • Added #[allow(clippy::derivable_impls)] with a explanatory reason comment
  • Implemented Default for BuildTargets<'_> to return an empty slice
src/runner.rs

Assessment against linked issues

Issue Objective Addressed Explanation
#85 Remove the #[derive(Default)] from the BuildTargets struct.
#85 Implement a manual Default for BuildTargets that returns an empty slice reference.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 8, 2025

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Summary by CodeRabbit

  • New Features
    • None. No user-facing behaviour changes.
  • Refactor
    • Simplified default handling for build targets to use an explicit empty configuration, improving consistency without altering behaviour.
  • Documentation
    • Clarified that leaving build targets empty applies default behaviour.
  • Chores
    • Enhanced internal comparability of build target settings to support more robust checks.

Walkthrough

Remove the derived Default from BuildTargets<'a> and add a manual impl Default for BuildTargets<'_> that returns an empty slice (Self(&[])) with a clippy allowance for derivable_impls.

Changes

Cohort / File(s) Summary
Runner: BuildTargets default impl
src/runner.rs
Remove Default from derive list for BuildTargets<'a>; add impl Default for BuildTargets<'_> { fn default() -> Self { Self(&[]) } } with #[expect(clippy::derivable_impls, reason = "...")]. Also add PartialEq, Eq to derives.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Assessment against linked issues

Objective Addressed Explanation
Remove invalid Default derive from BuildTargets<'a> (#85)
Provide manual Default impl returning empty slice for BuildTargets (#85)

Possibly related PRs

Poem

Trim the derive, let lifetimes glide,
Empty slice stands firm, no panic inside.
Clippy nods, the impl is tight,
BuildTargets wakes, compilation light.
Ship the change — the code takes flight.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6b4f445 and 5915594.

📒 Files selected for processing (1)
  • src/runner.rs (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rs

📄 CodeRabbit Inference Engine (AGENTS.md)

**/*.rs: Comment why, not what. Explain assumptions, edge cases, trade-offs, or complexity. Don't echo the obvious.
Use functions and composition. Avoid repetition by extracting reusable logic. Prefer generators or comprehensions, and declarative code to imperative repetition when readable.
Small, meaningful functions. Functions must be small, clear in purpose, single responsibility, and obey command/query segregation.
Name things precisely. Use clear, descriptive variable and function names. For booleans, prefer names with is, has, or should.
Every module must begin with a module level (//! ) comment explaining the module's purpose and utility.
Document public APIs using Rustdoc comments (///) so documentation can be generated with cargo doc.
Place function attributes after doc comments.
Do not use return in single-line functions.
Prefer immutable data and avoid unnecessary mut bindings.
Handle errors with the Result type instead of panicking where feasible.
Prefer .expect() over .unwrap().
Use concat!() to combine long string literals rather than escaping newlines with a backslash.
Prefer single line versions of functions where appropriate.
Clippy warnings MUST be disallowed.
Lints must not be silenced except as a last resort.
Lint rule suppressions must be tightly scoped and include a clear reason.
Prefer expect over allow.
Keep file size manageable. No single code file may be longer than 400 lines. Long switch statements or dispatch tables should be broken up by feature and constituents colocated with targets. Large blocks of test data should be moved to external data files.
Illustrate with clear examples. Function documentation must include clear examples demonstrating the usage and outcome of the function. Test documentation should omit examples where the example serves only to reiterate the test logic.
Prefer semantic error enums. Derive std::error::Error (via the thiserror crate) for any condition the caller might inspect, retry, or map to an HTTP status.
...

Files:

  • src/runner.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 return in single-line functions.

  • Move conditionals with >2 branches into a predicate function.

  • Avoid unsafe unless 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.
  • Where code is only used by specific features, it must be conditionally compiled or a conditional expectation for unused_code applied.

  • Use rstest fixtures for shared setup and to avoid repetition between tests.

  • Replace duplicated tests with #[rstest(...)] parameterised cases.

  • Prefer mockall for 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/runner.rs
🔍 MCP Research (1 server)

Deepwiki:

  • src/ir.rs: BuildGraph definition shows a default_targets field: pub default_targets: Vec<PathBuf>, (BuildGraph struct with actions, targets, default_targets).
  • src/ast.rs: NetsukeManifest defines pub defaults: Vec<String> with serde default (names of targets built when no CLI targets supplied).
  • tests/steps/ir_steps.rs: Cucumber step code accesses/asserts BuildGraph.default_targets (tests check the number/content of default targets).
⏰ Context from checks skipped due to timeout of 120000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build-test
🔇 Additional comments (3)
src/runner.rs (3)

54-57: LGTM! Documentation clearly explains default behaviour.

The doc comment effectively explains that an empty slice means "use the defaults" emitted by IR generation, which aligns with the external context showing that default targets are handled in the BuildGraph and NetsukeManifest structures.


57-57: LGTM! Equality derives enable comparisons as suggested.

Adding PartialEq and Eq derives enables cheap comparisons in tests and internal checks, which is valuable for a target list type that may need comparison logic.


74-82: LGTM! Manual Default implementation correctly handles lifetime constraints.

The manual Default implementation properly addresses the core issue where &[String] doesn't implement Default by returning an empty slice reference. The #[expect] annotation follows coding guidelines by being narrowly scoped with a clear reason explaining why the derive cannot be used due to lifetime requirements.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/remove-default-derive-for-buildtargets

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @leynos - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • Use of #[allow] is forbidden; use narrowly scoped #[expect(lint, reason = "...")] instead. (link)
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/runner.rs:71` </location>
<code_context>
     }
 }

+#[allow(
+    clippy::derivable_impls,
+    reason = "Derive fails for non-'static lifetimes; manual impl returns empty slice."
</code_context>

<issue_to_address>
Use of `#[allow]` is forbidden; use narrowly scoped `#[expect(lint, reason = "...")]` instead.

The use of `#[allow(clippy::derivable_impls, ...)]` here violates the lint suppression policy. Please replace with a narrowly scoped `#[expect(lint, reason = "...")]` and provide a clear reason. Blanket or grouped allows are not permitted.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, no comments

Edit Code Review Bot Settings | Greptile

@leynos
Copy link
Owner Author

leynos commented Aug 12, 2025

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 12, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fb6c684 and 6b4f445.

📒 Files selected for processing (1)
  • src/runner.rs (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.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 return in single-line functions.

  • Move conditionals with >2 branches into a predicate function.

  • Avoid unsafe unless 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.
  • Where code is only used by specific features, it must be conditionally compiled or a conditional expectation for unused_code applied.

  • Use rstest fixtures for shared setup and to avoid repetition between tests.

  • Replace duplicated tests with #[rstest(...)] parameterised cases.

  • Prefer mockall for 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/runner.rs
🔍 MCP Research (1 server)

Deepwiki:

  • The repository already supports default build targets via the NetsukeManifest.defaults field (Vec), which is converted into BuildGraph.default_targets by BuildGraph::process_defaults in the IR generation pipeline (process_rules → process_targets → process_defaults). (src/ir.rs)
  • The term "manual default" in this codebase maps to listing target names in a Netsukefile's defaults section (example YAML provided in the tool response showing how to add a target to defaults). (tool response)
  • Relevant source files called out by the search are src/ast.rs (NetsukeManifest with defaults) and src/ir.rs (BuildGraph with default_targets and process_defaults). (src/ast.rs, src/ir.rs)
🔇 Additional comments (1)
src/runner.rs (1)

71-79: Tighten the lint expectation reason and verify it actually fires

Target src/runner.rs lines 71–79:

  • Replace the attribute with:

    #[expect(
        clippy::derivable_impls,
        reason = "Cannot derive Default because &'a [String] has no Default; manual impl uses a static empty slice."
    )]
  • Run Clippy locally and confirm that clippy::derivable_impls is emitted on this manual Default impl.

  • If the lint does not trigger, remove the #[expect] attribute and retain the manual impl unchanged.

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, no comments

Edit Code Review Bot Settings | Greptile

@leynos leynos merged commit 01c2ac6 into main Aug 12, 2025
4 checks passed
@leynos leynos deleted the codex/remove-default-derive-for-buildtargets branch August 12, 2025 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix invalid Default derive for BuildTargets struct with lifetime parameter

1 participant