foundry-rs/forge-std

docs(StdJson): document that key parameter must start with a dot

Open

#394 opened on May 29, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Solidity (1,041 stars) (499 forks)user submission
documentationgood first issue

Description

The current documentation for the JSON cheats does not explain that the key parameter must be provided with a leading dot:

https://github.com/foundry-rs/forge-std/blob/e8a047e3f40f13fa37af6fe14e6e06283d9a060e/src/Vm.sol#L213-L239

I was trying to access the key by its simple name, like so:

string memory json = '{"bar":"Hello World"}';
string memory bar = vm.parseJsonString(json, "bar");

And that didn't work until I added the leading dot, i.e. .bar.

Side note: the parameters for the parseJsonSOMETHING cheats have been left unnamed.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
95
Research direction
The issue points to the documentation for the `parseJsonString` cheatcode in `src/Vm.sol` (lines 213-239). The contributor should add a note that the `key` parameter must start with a leading dot (e.g., `.bar`). Additionally, consider addressing the side note that the parameters for `parseJsonSOMETHING` cheats are left unnamed, which could be improved by adding parameter names in the NatSpec comments.