Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Automatic docs shell snippets syntax validation #2660

Merged
merged 60 commits into from
Nov 19, 2024
Merged

Automatic docs shell snippets syntax validation #2660

merged 60 commits into from
Nov 19, 2024

Conversation

franciszekjob
Copy link
Collaborator

@franciszekjob franciszekjob commented Nov 12, 2024 •
edited
Loading

Closes #2479

Introduced changes

  • Validate snforge and sncast shell snippets syntax in the docs
  • Fix docs snippets which are invalid/outdated

Checklist

  • Linked relevant issue
  • Updated relevant documentation
  • Added relevant tests
  • Performed self-review of the code
  • Added changes to CHANGELOG.md

franciszekjob and others added 30 commits November 8, 2024 17:38
@franciszekjob
Add expandable shell snippet outputs
3c4a076
@franciszekjob
Change shell snippets to expandable blocks
f8b0058
@franciszekjob
Make expandable snippet open by default
4e45711
@franciszekjob
Make tree commands expandable
23493ab
@franciszekjob
Restore prompt in shell snippets
62bb35a
@franciszekjob
Revert "Restore prompt in shell snippets"
3ef847f 
This reverts commit 62bb35a.
@franciszekjob
Restore prompt in shell snippets
304e423
@franciszekjob
Restore prompt in other shell snippets
f10ac8e
@franciszekjob
Fix forge version check snippet
be9c9e5
@franciszekjob
Add JS script to remove prompt sign when copying code
a17d919
@franciszekjob
Add validation of sncast snippets
432e366
@franciszekjob
Merge branch 'franciszekjob/2479-expandable-shell-snippets' of https:…
2cc325c 
…//github.com/foundry-rs/starknet-foundry into franciszekjob/2479-2-shell-commands-validation
@franciszekjob
Remove unnecessary else branch
f5f3e41
@franciszekjob
Fix left docs snippets
beb0855
@franciszekjob
Make tree snippet expandable in first steps section
18ffce2
@franciszekjob
Fix typo
1d7f284
@franciszekjob
Fix typo
48a3fcd
@franciszekjob
Fix typos
0438352
@franciszekjob
Merge branch 'master' into franciszekjob/2479-expandable-shell-snippets
ccfac3f
@franciszekjob
Improve sncast snippets validation test
dca617d
@franciszekjob
Merge branch 'franciszekjob/2479-expandable-shell-snippets' of https:…
ed6daa0 
…//github.com/foundry-rs/starknet-foundry into franciszekjob/2479-2-shell-commands-validation
@franciszekjob
Fix printing number of validated snippets in sncast test
3ae3107
@franciszekjob
Add snforge docs snippets validation test
2f65010
@franciszekjob
Remove print
efc2e1d
@franciszekjob
Merge branch 'master' into franciszekjob/2479-expandable-shell-snippets
2823523
@franciszekjob
Merge branch 'franciszekjob/2479-expandable-shell-snippets' into fran…
bcbb861 
…ciszekjob/2479-2-shell-commands-validation
@franciszekjob
Move docs validation into separate crate
1b968be
@franciszekjob
Merge branch 'franciszekjob/2479-2-shell-commands-validation' of http…
041f604 
…s://github.com/foundry-rs/starknet-foundry into franciszekjob/2479-2-shell-commands-validation
@franciszekjob
Fix newline
7bbcd99
@franciszekjob
Update Cargo.toml in sncast
bdcd467
@franciszekjob franciszekjob marked this pull request as draft November 15, 2024 11:32
@franciszekjob franciszekjob changed the title Automatic docs shell snippets validation Automatic docs shell snippets syntax validation Nov 18, 2024
@franciszekjob
Copy link
Collaborator Author

Running the commands and validating the output will be added in next PR.

@franciszekjob franciszekjob marked this pull request as ready for review November 18, 2024 09:05
cptartur
cptartur requested changes Nov 18, 2024
View reviewed changes
crates/docs/src/validation.rs Outdated Show resolved Hide resolved
crates/docs/src/validation.rs Outdated Show resolved Hide resolved
crates/docs/src/validation.rs Outdated Show resolved Hide resolved
crates/docs/src/validation.rs Show resolved Hide resolved
crates/docs/src/validation.rs Outdated Show resolved Hide resolved
crates/forge/tests/e2e/docs_snippets_validation.rs Outdated Show resolved Hide resolved
crates/sncast/tests/docs_snippets/validation.rs Show resolved Hide resolved
crates/sncast/tests/docs_snippets/validation.rs Outdated Show resolved Hide resolved
crates/sncast/tests/docs_snippets/validation.rs Show resolved Hide resolved
crates/sncast/tests/docs_snippets/validation.rs Show resolved Hide resolved
cptartur
cptartur reviewed Nov 18, 2024
View reviewed changes
crates/docs/src/validation.rs Outdated Show resolved Hide resolved
crates/docs/src/validation.rs Outdated Show resolved Hide resolved
crates/docs/src/validation.rs Show resolved Hide resolved
@franciszekjob franciszekjob added this pull request to the merge queue Nov 19, 2024
Merged via the queue into master with commit 78c9d31 Nov 19, 2024
26 checks passed
@franciszekjob franciszekjob deleted the franciszekjob/2479-2-shell-commands-validation branch November 19, 2024 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cptartur cptartur cptartur approved these changes

@ddoktorski ddoktorski Awaiting requested review from ddoktorski ddoktorski is a code owner

@kkawula kkawula Awaiting requested review from kkawula kkawula is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Automatic validation of shell commands in docs
2 participants
@franciszekjob @cptartur