Adding Deprecated CLI Attribute List #437
Conversation
| - [feat] Report links generated by the CLI are private by default; use `"url_visibility": "public"` to share publicly. In CI runs, links remain public by default. | ||
| - [feat] Foundry remappings support: when `packages` is not set, the tool uses `forge remappings` to resolve package mappings from `foundry.toml`. | ||
| - [deprecation] Deprecated CLI options have been removed; update configuration files to use supported alternatives listed in the CLI options docs. | ||
| - The full list is as follows: • auto_nondet_difficult_internal_funcs • auto_nondet_minimal_difficulty • contract_compiler_skip_severe_warning_as_error • send_only • use_memory_safe_autofinders • disable_finder_friendly_optimizer • do_not_use_memory_safe_autofinders • finder_friendly_optimizer • assert_contracts • allow_solidity_calls_in_quantifiers |
There was a problem hiding this comment.
To help the users and reduce support questions, would it make sense to present these as a table with columns "Deprecated Option" and "Suggested Alternative"?
E.g. for allow_solidity_calls_in_quantifiers, could say "Use direct storage access if possible". Some may be "None" or "N/A".
There was a problem hiding this comment.
I support Shane's idea. Also, wrap the option names in code quotes to make them look nicer and so that the spell checker will know to ignore them.
There was a problem hiding this comment.
tbh I don't really know how to add a table in those .md files.
Can I provide the "Suggested Alternative" and either one of you help here?
| - [feat] Report links generated by the CLI are private by default; use `"url_visibility": "public"` to share publicly. In CI runs, links remain public by default. | ||
| - [feat] Foundry remappings support: when `packages` is not set, the tool uses `forge remappings` to resolve package mappings from `foundry.toml`. | ||
| - [deprecation] Deprecated CLI options have been removed; update configuration files to use supported alternatives listed in the CLI options docs. | ||
| - The full list is as follows: • auto_nondet_difficult_internal_funcs • auto_nondet_minimal_difficulty • contract_compiler_skip_severe_warning_as_error • send_only • use_memory_safe_autofinders • disable_finder_friendly_optimizer • do_not_use_memory_safe_autofinders • finder_friendly_optimizer • assert_contracts • allow_solidity_calls_in_quantifiers |
There was a problem hiding this comment.
I support Shane's idea. Also, wrap the option names in code quotes to make them look nicer and so that the spell checker will know to ignore them.
Naming convention:
Before requesting review:
spelling_wordlist.txtREADME.mdfor information about style and markdown syntaxJira ticket: TODO
Link to generated documentation: TODO