All the breaking changes are very unlikely to actually break your code that was written against the v2 version of bon. 99% of users should be able to update without any migration.

Changed

🎉🎉 Stabilize the builder's typestate API allowing for custom builder extensions. This is the main theme of this release. This new API brings the flexibility to a whole new level 🚀 🚀 (#145)
Improve rustdoc output. See the rustoc examples and comparison in the Alternatives section (#145)
- Add info that the member is required or optional.
- For members with default values show the default value in the docs.
- For optional members provide links to {member}(T) and maybe_{member}(Option<T>) setters.
- Remove __ prefixes for generic types and lifetimes from internal symbols. Instead, the prefixes added only if the macro detects a name collision.
⚠️ Breaking. Reject unnecessary empty attributes e.g. #[builder()] or #[builder] with no parameters on a member (#145)
⚠️ Breaking. Reject square brackets and curly braces delimiters for builder_type, finish_fn, start_fn and on attributes syntax. Only parentheses are accepted e.g. #[builder(finish_fn(...))] or #[builder(on(...))]. This no longer works: #[builder(finish_fn[...])] or #[builder(on{...})] (#145)
⚠️ Breaking. Reject non-consecutive on(...) clauses. For example, the following now generates a compile error: #[builder(on(String, into), finish_fn = build, on(Vec<_>, into))], because there is a finish_fn = ... between on(...) clauses. (#155)
⚠️ Breaking. #[builder(derive(Clone, Debug))] now generates impl blocks that follow the behaviour of standard Clone and Debug derives in that it conservatively adds Clone/Debug trait bounds for all the generic types declared on the original item (struct or function). Previously no additional bounds were required on Clone and Debug impls. See the Added section for details on the way to override these bounds with #[builder(derive(Clone/Debug(bounds(...))))] (#145)
⚠️ Breaking. The name of the builder struct generated for methods named builder changed from TBuilderBuilder to just TBuilder making methods named builder work the same as methods named new. (#145)
⚠️ Breaking. The type of the builder is now dependent on the order of the setters' invocation. This may only break code like the following:
```
let builder = if condition {
    Foo::builder().a(1).b(2)
} else {
    Foo::builder().b(1).a(2)
};

builder.build();
```
This is because the types of the builders returned from the branches are the following:
- FooBuilder<SetB<SetA>> (if branch)
- FooBuilder<SetA<SetB>> (else branch)
We believe such code should generally be very rare and even if it breaks, it's easy to fix it by reordering the setter method calls. This compromise was accepted as a design tradeoff such that the builder's type signature becomes simpler, the generated documentation becomes much less noisy, it removes an annoying special case for the builder of just one member, and it improves the type-checking performance considerably compared to the previous approach that used tuples to represent the type state. (#145)

Removed

⚠️ Breaking. Remove support for #[bon::builder] proc-macro attribute on top of a struct. Use #[derive(bon::Builder)] for that instead. This syntax has been deprecated since 2.1 and it is now removed as part of a major version cleanup (#145)
⚠️ Breaking. Remove #[builder(expose_positional_fn = positional_fn_name)] attribute. Use #[builder(start_fn = builder_fn_name)] instead, since this attribute works additively keeping the function with positional arguments under the attribute unchanged. (#153)

Added

⚠️ Breaking. Builder macros now generate additional mod builder_name {} where builder_name is the snake_case version of the name of the builder struct. This new module contains the type state API of the builder. There is a low probability that this new module name may conflict with existing symbols in your scope, so this change is marked as breaking (#145)
Add #[builder(builder_type(vis = "...", doc { ... }))] that allows overriding the visibility and docs of the builder struct (#145)
Add #[builder(finish_fn(vis = "...", doc { ... } ))] that allows overriding the visibility and docs of the finishing function (#145)
Add #[builder(start_fn(doc { ... }))] that allows overriding the docs of the starting function (#145)
Add #[builder(with = closure)] syntax to customize setters with a closure. If the closure returns a Result<_, E> the setters become fallible (#145)
Add #[builder(with = Some)], #[builder(with = FromIterator::from_iter)], #[builder(with = <_>::from_iter)] syntax support for two well-known functions that will probably be used frequently (#157)
Add #[builder(required)] for Option fields to opt out from their special handling which makes bon treat them as regular required fields. It's also available at the top-level via #[builder(on(_, required))] (#145, #155)
Add #[builder(crate = path::to::bon)] and #[bon(crate = path::to::bon)] to allow overriding the path to bon crate used in the generated code, which is useful for the cases when bon macros are wrapped by other macros (#153)
Add #[builder(state_mod)] to configure the builder's type state API module name, visibility and docs (#145)
🔬 Experimental. Add #[builder(overwritable)] and #[builder(on(..., overwritable)] to make it possible to call setters multiple times for the same member. This attribute is available under the cargo feature "experimental-overwritable". The fate of this feature depends on your feedback in the tracking issue #149. Please, let us know if you have a use case for this attribute! (#145)
Add #[builder(setters)] to fine-tune the setters names, visibility and docs (#145)
Add #[builder(derive(Clone/Debug(bounds(...))] to allow overriding trait bounds on the Clone/Debug impl block of the builder (#145)
Add inheritance of #[allow()] and #[expect()] lint attributes to all generated items. This is useful to suppress any lints coming from the generated code. Although, lints coming from the generated code are generally considered defects in bon and should be reported via a Github issue, but this provides an easy temporary workaround for the problem (#145)

Fixed

Fix false-positive unused_mut lints coming from #[builder] on a method that takes mut self (#197)
Fix #[cfg/cfg_attr()] not being expanded when used on function arguments with doc comments or other attributes (#145)
Fix raw identifiers in optional/default members (#175)

Other

Add graceful internal panic handling. If some bon macro panics due to an internal bug, the macro will try to generate a fallback for IDEs to still provide intellisense (#145)
Switch from elastio.github.io/bon to a custom domain bon-rs.com (#158)
Add anonymous stats with umami for the docs website (#158)

Docs

Refactor the README.md and all pages in the Guide Book by simplifying them and removing redundancies (#170)
Add new pages to the Guide Book:
- Custom Conversions (#170)
- Typestate API (#170)
- Builder's Type Signature (#170)
- Custom Methods (#171)
- Optional Generic Members (#173)
- Compilation Benchmarks (#177)
- Split API reference into multiple pages. The root page now contains a convenient table with short descriptions of all available configuration attributes (#164)

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [bon](https://bon-rs.com) ([source](https://github.com/elastio/bon)) | workspace.dependencies | major | `2.0` -> `3.0` | --- > ⚠️ **Warning** > > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>elastio/bon (bon)</summary> ### [`v3.0.2`](https://github.com/elastio/bon/releases/tag/v3.0.2) [Compare Source](https://github.com/elastio/bon/compare/v3.0.1...v3.0.2) ##### Fixed - Fix `unexpected_cfgs` lint coming from `#[cfg(rust_analyzer)]` on the latest nightly ([#212](https://github.com/elastio/bon/pull/212)) ### [`v3.0.1`](https://github.com/elastio/bon/releases/tag/v3.0.1) [Compare Source](https://github.com/elastio/bon/compare/v3.0.0...v3.0.1) ##### Fixed - Fix handling of lifetimes not used in fn param types ([#208](https://github.com/elastio/bon/pull/208)) ### [`v3.0.0`](https://github.com/elastio/bon/releases/tag/v3.0.0) [Compare Source](https://github.com/elastio/bon/compare/v2.3.0...v3.0.0) See the most interesting changes described in [**Bon 3.0 Release blog post**](https://bon-rs.com/blog/bon-v3-release). All the breaking changes are very unlikely to actually break your code that was written against the `v2` version of `bon`. 99% of users should be able to update without any migration. ##### Changed - 🎉🎉 Stabilize the builder's [typestate API](https://bon-rs.com/guide/typestate-api) allowing for custom builder extensions. This is the **main theme** of this release. This new API brings the flexibility to a whole new level 🚀 🚀 ([#145](https://github.com/elastio/bon/pull/145)) - Improve rustdoc output. See the rustoc examples and comparison in the [Alternatives](https://bon-rs.com/guide/alternatives#generated-docs-comparison) section ([#145](https://github.com/elastio/bon/pull/145)) - Add info that the member is required or optional. - For members with default values show the default value in the docs. - For optional members provide links to `{member}(T)` and `maybe_{member}(Option<T>)` setters. - Remove `__` prefixes for generic types and lifetimes from internal symbols. Instead, the prefixes added only if the macro detects a name collision. - ⚠️ **Breaking.** Reject unnecessary empty attributes e.g. `#[builder()]` or `#[builder]` with no parameters on a member ([#145](https://github.com/elastio/bon/pull/145)) - ⚠️ **Breaking.** Reject square brackets and curly braces delimiters for `builder_type`, `finish_fn`, `start_fn` and `on` attributes syntax. Only parentheses are accepted e.g. `#[builder(finish_fn(...))]` or `#[builder(on(...))]`. This no longer works: `#[builder(finish_fn[...])]` or `#[builder(on{...})]` ([#145](https://github.com/elastio/bon/pull/145)) - ⚠️ **Breaking.** Reject non-consecutive `on(...)` clauses. For example, the following now generates a compile error: `#[builder(on(String, into), finish_fn = build, on(Vec<_>, into))]`, because there is a `finish_fn = ...` between `on(...)` clauses. ([#155](https://github.com/elastio/bon/pull/155)) - ⚠️ **Breaking.** `#[builder(derive(Clone, Debug))]` now generates impl blocks that follow the behaviour of standard `Clone` and `Debug` derives in that it conservatively adds `Clone/Debug` trait bounds for all the generic types declared on the original item (struct or function). Previously no additional bounds were required on `Clone` and `Debug` impls. See the *Added* section for details on the way to override these bounds with `#[builder(derive(Clone/Debug(bounds(...))))]` ([#145](https://github.com/elastio/bon/pull/145)) - ⚠️ **Breaking.** The name of the builder struct generated for methods named `builder` changed from `TBuilderBuilder` to just `TBuilder` making methods named `builder` work the same as methods named `new`. ([#145](https://github.com/elastio/bon/pull/145)) - ⚠️ **Breaking.** The type of the builder is now dependent on the order of the setters' invocation. This may only break code like the following: ```rust ignore let builder = if condition { Foo::builder().a(1).b(2) } else { Foo::builder().b(1).a(2) }; builder.build(); ``` This is because the types of the builders returned from the branches are the following: - `FooBuilder<SetB<SetA>>` (`if` branch) - `FooBuilder<SetA<SetB>>` (`else` branch) We believe such code should generally be very rare and even if it breaks, it's easy to fix it by reordering the setter method calls. This compromise was accepted as a design tradeoff such that the builder's type signature becomes simpler, the generated documentation becomes much less noisy, it removes an annoying special case for the builder of just one member, and it improves the type-checking performance considerably compared to the previous approach that used tuples to represent the type state. ([#145](https://github.com/elastio/bon/pull/145)) ##### Removed - ⚠️ **Breaking.** Remove support for `#[bon::builder]` proc-macro attribute on top of a `struct`. Use `#[derive(bon::Builder)]` for that instead. This syntax has been deprecated since `2.1` and it is now removed as part of a major version cleanup ([#145](https://github.com/elastio/bon/pull/145)) - ⚠️ **Breaking.** Remove `#[builder(expose_positional_fn = positional_fn_name)]` attribute. Use [`#[builder(start_fn = builder_fn_name)]`](https://bon-rs.com/reference/builder/top-level/start_fn) instead, since this attribute works additively keeping the function with positional arguments under the attribute unchanged. ([#153](https://github.com/elastio/bon/pull/153)) ##### Added - ⚠️ **Breaking.** Builder macros now generate additional `mod builder_name {}` where `builder_name` is the snake_case version of the name of the builder struct. This new module contains the type state API of the builder. There is a low probability that this new module name may conflict with existing symbols in your scope, so this change is marked as breaking ([#145](https://github.com/elastio/bon/pull/145)) - Add [`#[builder(builder_type(vis = "...", doc { ... }))]`](https://bon-rs.com/reference/builder/top-level/builder_type) that allows overriding the visibility and docs of the builder struct ([#145](https://github.com/elastio/bon/pull/145)) - Add [`#[builder(finish_fn(vis = "...", doc { ... } ))]`](https://bon-rs.com/reference/builder/top-level/finish_fn) that allows overriding the visibility and docs of the finishing function ([#145](https://github.com/elastio/bon/pull/145)) - Add [`#[builder(start_fn(doc { ... }))]`](https://bon-rs.com/reference/builder/top-level/start_fn) that allows overriding the docs of the starting function ([#145](https://github.com/elastio/bon/pull/145)) - Add [`#[builder(with = closure)]`](https://bon-rs.com/reference/builder/member/with) syntax to customize setters with a closure. If the closure returns a `Result<_, E>` the setters become fallible ([#145](https://github.com/elastio/bon/pull/145)) - Add `#[builder(with = Some)]`, `#[builder(with = FromIterator::from_iter)]`, `#[builder(with = <_>::from_iter)]` syntax support for two [well-known functions](https://bon-rs.com/reference/builder/member/with#well-known-functions) that will probably be used frequently ([#157](https://github.com/elastio/bon/pull/157)) - Add [`#[builder(required)]`](https://bon-rs.com/reference/builder/member/required) for `Option` fields to opt out from their special handling which makes `bon` treat them as regular required fields. It's also available at the top-level via `#[builder(on(_, required))]` ([#145](https://github.com/elastio/bon/pull/145), [#155](https://github.com/elastio/bon/pull/155)) - Add [`#[builder(crate = path::to::bon)]`](https://bon-rs.com/reference/builder/top-level/crate) and `#[bon(crate = path::to::bon)]` to allow overriding the path to `bon` crate used in the generated code, which is useful for the cases when `bon` macros are wrapped by other macros ([#153](https://github.com/elastio/bon/pull/153)) - Add [`#[builder(state_mod)]`](https://bon-rs.com/reference/builder/top-level/state_mod) to configure the builder's type state API module name, visibility and docs ([#145](https://github.com/elastio/bon/pull/145)) - 🔬 **Experimental.** Add [`#[builder(overwritable)]`](https://bon-rs.com/reference/builder/member/overwritable) and `#[builder(on(..., overwritable)]` to make it possible to call setters multiple times for the same member. This attribute is available under the cargo feature `"experimental-overwritable"`. The fate of this feature depends on your feedback in the tracking issue [#149](https://github.com/elastio/bon/issues/149). Please, let us know if you have a use case for this attribute! ([#145](https://github.com/elastio/bon/pull/145)) - Add [`#[builder(setters)]`](https://bon-rs.com/reference/builder/member/setters) to fine-tune the setters names, visibility and docs ([#145](https://github.com/elastio/bon/pull/145)) - Add [`#[builder(derive(Clone/Debug(bounds(...))]`](https://bon-rs.com/reference/builder/top-level/derive#generic-types-handling) to allow overriding trait bounds on the `Clone/Debug` impl block of the builder ([#145](https://github.com/elastio/bon/pull/145)) - Add inheritance of `#[allow()]` and `#[expect()]` lint attributes to all generated items. This is useful to suppress any lints coming from the generated code. Although, lints coming from the generated code are generally considered defects in `bon` and should be reported via a Github issue, but this provides an easy temporary workaround for the problem ([#145](https://github.com/elastio/bon/pull/145)) ##### Fixed - Fix false-positive `unused_mut` lints coming from `#[builder]` on a method that takes `mut self` ([#197](https://github.com/elastio/bon/pull/197)) - Fix `#[cfg/cfg_attr()]` not being expanded when used on function arguments with doc comments or other attributes ([#145](https://github.com/elastio/bon/pull/145)) - Fix raw identifiers in optional/default members ([#175](https://github.com/elastio/bon/pull/175)) ##### Other - Add graceful internal panic handling. If some `bon` macro panics due to an internal bug, the macro will try to generate a fallback for IDEs to still provide intellisense ([#145](https://github.com/elastio/bon/pull/145)) - Switch from `elastio.github.io/bon` to a custom domain `bon-rs.com` ([#158](https://github.com/elastio/bon/pull/158)) - Add anonymous stats with [`umami`](https://umami.is/) for the docs website ([#158](https://github.com/elastio/bon/pull/158)) ##### Docs - Refactor the README.md and all pages in the Guide Book by simplifying them and removing redundancies ([#170](https://github.com/elastio/bon/pull/170)) - Add new pages to the Guide Book: - [Custom Conversions](https://bon-rs.com/guide/basics/custom-conversions) ([#170](https://github.com/elastio/bon/pull/170)) - [Typestate API](https://bon-rs.com/guide/typestate-api) ([#170](https://github.com/elastio/bon/pull/170)) - [Builder's Type Signature](https://bon-rs.com/guide/typestate-api/builders-type-signature) ([#170](https://github.com/elastio/bon/pull/170)) - [Custom Methods](https://bon-rs.com/guide/typestate-api/custom-methods) ([#171](https://github.com/elastio/bon/pull/171)) - [Optional Generic Members](https://bon-rs.com/guide/patterns/optional-generic-members) ([#173](https://github.com/elastio/bon/pull/173)) - [Compilation Benchmarks](https://bon-rs.com/guide/benchmarks/compilation) ([#177](https://github.com/elastio/bon/pull/177)) - Split API reference into multiple pages. The [root page](https://bon-rs.com/reference/builder) now contains a convenient table with short descriptions of all available configuration attributes ([#164](https://github.com/elastio/bon/pull/164)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

renovate added 1 commit 2024-11-15 18:17:27 +00:00

chore(deps): update rust crate bon to v3

ci/woodpecker/push/cron-docker-builder Pipeline was successful

Details

ci/woodpecker/push/push-next Pipeline was successful

Details

ci/woodpecker/push/tag-created Pipeline was successful

Details

ci/woodpecker/pr/cron-docker-builder Pipeline was successful

Details

ci/woodpecker/pr/push-next Pipeline was successful

Details

ci/woodpecker/pr/tag-created Pipeline was successful

Details

5ffe37707a

renovate force-pushed renovate/bon-3.x from 5ffe37707a to c11a6137d9

2024-11-21 10:46:28 +00:00

Compare

renovate changed title from ~~chore(deps): update rust crate bon to v3~~ to chore(deps): update rust crate bon to v3 - autoclosed

2024-11-21 21:47:42 +00:00

renovate closed this pull request

2024-11-21 21:47:43 +00:00

ci/woodpecker/push/cron-docker-builder Pipeline was successful

Details

ci/woodpecker/push/push-next Pipeline was successful

Details

ci/woodpecker/push/tag-created Pipeline was successful

Details

ci/woodpecker/pr/cron-docker-builder Pipeline was successful

Details

ci/woodpecker/pr/push-next Pipeline was successful

Details

ci/woodpecker/pr/tag-created Pipeline was successful

Details

ci/woodpecker/pull_request_closed/cron-docker-builder Pipeline was successful

Details

ci/woodpecker/pull_request_closed/push-next Pipeline was successful

Details

ci/woodpecker/pull_request_closed/tag-created Pipeline was successful

Details

Pull request closed

This pull request cannot be reopened because the branch was deleted.

No reviewers

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: kemitix/git-next#183

No description provided.