Skip to content

fix: infer deprecation allowances from error attributes - #70

Merged
rklaehn merged 1 commit into
rklaehn/always-allow-deprecatedfrom
rklaehn/auto-allow-deprecated
Nov 9, 2026
Merged

rklaehn merged 1 commit into
rklaehn/always-allow-deprecatedfrom
rklaehn/auto-allow-deprecated

Conversation

@rklaehn

@rklaehn rklaehn commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Description

Alternative to the unconditional allowance in #69, stacked on that branch for a focused comparison. No explicit allow_deprecated macro option.

Follow Serde's detection: if the type or one of its enum variants has #[deprecated] or #[allow(deprecated)], allow deprecation in the generated impls. Otherwise leave the lint unchanged.

This keeps ordinary enums working under forbid(deprecated) and preserves warnings for deprecated functions used in their #[error("...", expression)] formatting arguments. Deprecated types and variants still derive without internal warnings; direct uses in user code still warn.

The implementation adds 34 lines around derive expansion and removes the unconditional allowances. A scoped anonymous const holds the generated impls, avoiding an extra flag passed through each generator. This also handles deprecated structs and whole enums. No new dependencies.

Breaking Changes

Compared with #69, deprecated formatting helpers on otherwise ordinary enums warn again. This preserves the behavior before the proposed unconditional allowance.

Notes & open questions

As with Serde, once detection triggers, the allowance covers all generated impls, including user-provided formatting expressions inside them. It is conditional, not scoped to individual expressions.

Validation: 26 unit tests and 4 doctests pass, including two compile-fail regressions. cargo fmt --check passes. Clippy passes with the existing clippy::useless_format warning at src/tests.rs:110 allowed; strict Clippy fails on that unchanged line.

Change checklist

  • Self-review.
  • Documentation updates.
  • Tests, including deprecated types/variants, explicit allowances, forbid(deprecated), and retained user-code diagnostics.
  • All breaking changes documented.

@Frando Frando left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Cool, this is cleaner than the other approach for sure.

@rklaehn
rklaehn merged commit 5eacc99 into rklaehn/always-allow-deprecated Nov 9, 2026
rklaehn added a commit that referenced this pull request Nov 9, 2026
…es (#52)

## Description

The `stack_error` macro expands to impls that match on and construct
every enum variant, including deprecated ones. With
`#[deny(deprecated)]`, an enum with a `#[deprecated]` variant therefore
fails to compile at the `#[stack_error(..)]` call site.

`StackError` now allows the `deprecated` lint in its generated impls
when the type or one of its variants has `#[deprecated]` or
`#[allow(deprecated)]`. This needs no option. Serde handles deprecation
the same way.

- The allowance covers only the generated impls: they are wrapped in
`#[allow(deprecated)] const _: () = { ... };`. User code that constructs
a deprecated variant still warns.
- An enum without deprecation keeps the lint as it is, also in
user-provided formatting expressions such as `#[error("{}",
old_formatter())]`. Two `compile_fail` doctests in `tests/deprecated.md`
check this, together with the case above.
- Unit tests cover deprecated variants, deprecated enums and structs, an
`#[allow(deprecated)]` on the item or on a variant, and an enum without
deprecation under `#[forbid(deprecated)]`.

## Breaking Changes

None.

## Notes & open questions

The first version of this PR added an opt-in `allow_deprecated` option
to `stack_error`. It is gone; the allowance is now inferred from the
attributes (#69, #70).

On per-arm allowances: the allowance is scoped to the generated impls,
and those only touch the type's own variants, so allowing it on the
whole impl hides no warning in user code.

## Change checklist

- [x] Self-review.
- [x] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [x] Tests if relevant.
- [x] All breaking changes documented.

---------

Co-authored-by: Ruediger Klaehn <rklaehn@protonmail.com>
Co-authored-by: Rüdiger Klaehn <rklaehn@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants