Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
grosser committed Oct 9, 2023
1 parent 334e758 commit 40370e3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Features
- `pending { assert false }` is skip when it fails, but fails when it passes
- implicit subject via `require 'maxitest/implicit_subject'`
- `xit` to skip test (also does not call setup or teardown)
- `with_env` to change environment variables during test run
- `capture_stdout` and `capture_stderr` to capture stdout or stderr but not both (like `capture_io` does)
- `require 'maxitest/timeout'` to make hanging tests fail after `Maxitest.timeout` seconds
- `require 'maxitest/threads'` fail tests that leave extra threads running
- `require 'maxitest/global_must'` (before autorun) disable deprecation on global `must_*` or [global_expectations](https://github.com/jeremyevans/minitest-global_expectations) gem
Expand All @@ -42,6 +44,11 @@ require "maxitest/autorun"
... normal tests ...
```

### pending

- `pending "need to fix" do` to show why something is pending
- `pending "need to fix", if: ENV["CI"] do` to only skip on CI (if something is supposed to work locally)

Development
===========
- everything vendored into 1 gem to avoid dependency madness
Expand Down
4 changes: 4 additions & 0 deletions spec/maxitest_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@
output_in.should_not include 'lib/maxitest'
end

it "has helpers" do
run_cmd("ruby spec/cases/helpers.rb")
end

describe "before/after/around" do
it "works" do
out = run_cmd("ruby spec/cases/hook_all.rb")
Expand Down

0 comments on commit 40370e3

Please sign in to comment.