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

Update Tests README.md #6618

Merged
merged 2 commits into from
Apr 30, 2024
Merged

Update Tests README.md #6618

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8817e07
Update README.md
sovdeeth Apr 27, 2024
16b7b94
Merge branch 'dev/feature' into assert-info
Moderocky Apr 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/test/skript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,10 @@ some syntaxes for test development are available.
* Contents of tests are not parsed when conditions are not met.
* Typically the condition isn't required.
* Required to start a test script.
* Assertions are available as effects: <code>assert <.+> [(1¦to fail)] with %string%</code>
* Assertions are available as effects: <code>assert <.+> [(1¦to fail)] with [error] %string%[, expected [value] %object%, [and] (received|got) [value] %object%]</code>
* Example: <code>assert {_entity} is a zombie with "failure message"</code> will error if it's not a zombie.
* The optional 'expected' and 'got' values are used in the error report to show what the assertion expected and what it actually got.
* Assertions using some conditions, like CondCompare and CondIsSet, may automatically fill in the expected/got values.
* If the tag `to fail` is defined, it will assume the condition is to fail. If it's successful the string is printed.
* Take a look at existing tests for examples https://github.com/SkriptLang/Skript/tree/master/src/test/skript/tests
<code>misc/dummy.sk</code> is useful for beginners
Expand Down