Skip to content

bug(cheatcodes): non-stable cheatcodes should emit warnings and errors #7323

Open
@zerosnacks

Description

@zerosnacks

Component

Forge

Have you ensured that all of these are up to date?

  • Foundry
  • Foundryup

What version of Foundry are you on?

forge 0.2.0 (ce22450 2024-03-06T00:18:18.671530895Z)

What command(s) is the bug in?

No response

Operating System

None

Describe the bug

Cheatcodes can be tagged with a status:

/// The cheatcode is unstable, meaning it may contain bugs and may break its API on any
/// release.
///
/// Use of experimental cheatcodes will result in a warning.
Experimental,
/// The cheatcode has been deprecated, meaning it will be removed in a future release.
///
/// Use of deprecated cheatcodes is discouraged and will result in a warning.
Deprecated,
/// The cheatcode has been removed and is no longer available for use.
///
/// Use of removed cheatcodes will result in a hard error.
Removed,
/// The cheatcode is only used internally for foundry testing and may be changed or removed at
/// any time.
///
/// Use of internal cheatcodes is discouraged and will result in a warning.
Internal,

Use of these cheatcodes should result in a warning or hard error when appropriate, which currently does not appear to have been implemented.

Related: #7317 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-cheatcodesArea: cheatcodesP-lowPriority: lowT-bugType: bugfirst issueA good way to start contributing

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions