Automatically validate sncast docs snippets #2733
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit 62bb35a.
…//github.com/foundry-rs/starknet-foundry into franciszekjob/2479-2-shell-commands-validation
…//github.com/foundry-rs/starknet-foundry into franciszekjob/2479-2-shell-commands-validation
…ciszekjob/2479-2-shell-commands-validation
…s://github.com/foundry-rs/starknet-foundry into franciszekjob/2479-2-shell-commands-validation
franciszekjob
requested review from
cptartur,
ddoktorski and
kkawula
as code owners
…ps://github.com/foundry-rs/starknet-foundry into franciszekjob/2479-4-sncast-commands-validation
franciszekjob
commented
Dec 2, 2024
crates/docs/src/snippet.rs
Outdated
Comment on lines
1
to
13
| use std::sync::LazyLock; | ||
|
|
||
| use regex::Regex; | ||
| use serde::{Deserialize, Serialize}; | ||
|
|
||
| static RE_SNCAST: LazyLock<Regex> = LazyLock::new(|| { | ||
| Regex::new( r"(?ms)^(?:<!--\s*(?P<config>\{.*?\})\s*-->\n)?```shell\n\$ (?P<command>sncast .+?)\n```(?:\s*<details>\n<summary>Output:<\/summary>\n\n```shell\n(?P<output>[\s\S]+?)\n```[\s]*<\/details>)?").expect("Failed to create regex for normalizing loop function names") | ||
| }); | ||
|
|
||
| static RE_SNFORGE: LazyLock<Regex> = LazyLock::new(|| { | ||
| Regex::new( r"(?ms)^(?:<!--\s*(?P<config>\{.*?\})\s*-->\n)?```shell\n\$ (?P<command>snforge .+?)\n```(?:\s*<details>\n<summary>Output:<\/summary>\n\n```shell\n(?P<output>[\s\S]+?)\n```[\s]*<\/details>)?").expect("Failed to create regex for normalizing loop function names") | ||
| }); | ||
|
|
There was a problem hiding this comment.
note: Using static regex is more efficient.
…ps://github.com/foundry-rs/starknet-foundry into franciszekjob/2479-4-sncast-commands-validation
cptartur
reviewed
Dec 3, 2024
| Ok(Utf8PathBuf::from_str(relative_path)? | ||
| .canonicalize_utf8()? | ||
| .to_string() | ||
| .replace('\\', "/")) |
There was a problem hiding this comment.
What's the purpose of this line?
There was a problem hiding this comment.
From the user standpoint, having outputs with [..] in docs is a bit weird.
There was a problem hiding this comment.
What would be the steps to resolve this?
| @@ -74,7 +74,7 @@ To import an account into the file holding the accounts info (`~/.starknet_accou | |||
| ```shell | |||
| $ sncast \ | |||
| account import \ | |||
| --url http://127.0.0.1:5050 \ | |||
| --url http://127.0.0.1:5055 \ | |||
There was a problem hiding this comment.
Why did we change the devnet port?
| @@ -255,6 +255,8 @@ sncast_std = "0.33.0" | |||
|
|
|||
| To run the script, do: | |||
|
|
|||
| <!-- TODO: Add script example and remove ignoring output --> | |||
| .get(contract_name.as_str()) | ||
| .unwrap_or_else(|| panic!("Contract {contract_name} not found")); | ||
|
|
||
| // In case of invoke/call/verify, we need to replace contract address insnippet's |
There was a problem hiding this comment.
Suggested change
| // In case of invoke/call/verify, we need to replace contract address insnippet's | |
| // In case of invoke/call/verify, we need to replace contract address in snippet's |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Retales #2479
Introduced changes
This PR adds validation of sncast command snippets. Before validation, we declare + deploy contracts which are used in the examples.
hello_sncastpackage with necessary examplesChecklist
CHANGELOG.md