Skip to content

Commit

Permalink
Document Steep::RakeTask in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Aesthetikx authored and soutaro committed Jun 7, 2024
1 parent 55e5ca4 commit 81c72bd
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,24 @@ Steep implements some of the Language Server Protocol features.

Other LSP supporting tools may work with Steep where it starts the server as `steep langserver`.

## Rake Tasks

Steep comes with a set of configurable Rake tasks.

```ruby
# Rakefile

require "steep/rake_task"
Steep::RakeTask.new do |t|
t.check.severity_level = :error
t.watch.verbose
end

task default: [:steep]
```

Use `bundle exec rake -T` to see all available tasks.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
Expand Down

0 comments on commit 81c72bd

Please sign in to comment.