https://github.com/ruby-syntax-tree/syntax_tree-rbs
Syntax Tree support for RBS
https://github.com/ruby-syntax-tree/syntax_tree-rbs
Last synced: 5 months ago
JSON representation
Syntax Tree support for RBS
- Host: GitHub
- URL: https://github.com/ruby-syntax-tree/syntax_tree-rbs
- Owner: ruby-syntax-tree
- License: mit
- Created: 2022-04-07T00:35:58.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T17:59:51.000Z (6 months ago)
- Last Synced: 2024-11-17T14:21:06.417Z (5 months ago)
- Language: Ruby
- Size: 227 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- stars - ruby-syntax-tree/syntax_tree-rbs - Syntax Tree support for RBS (Ruby)
README
# SyntaxTree::RBS
[](https://github.com/ruby-syntax-tree/syntax_tree-rbs/actions/workflows/main.yml)
[](https://rubygems.org/gems/syntax_tree-rbs)
[Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree) support for RBS.
## Installation
Add this line to your application's Gemfile:
```ruby
gem "syntax_tree-rbs"
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install syntax_tree-rbs
## Usage
From code:
```ruby
require "syntax_tree/rbs"
pp SyntaxTree::RBS.parse(source) # print out the AST
puts SyntaxTree::RBS.format(source) # format the AST
```
From the CLI:
```sh
$ stree ast --plugins=rbs file.rbs
(root declarations=[(constant name=(type-name "Hello") type=(class-instance (type-name "World")))])
```
or
```sh
$ stree format --plugins=rbs file.rbs
Hello: World
```
or
```sh
$ stree write --plugins=rbs file.rbs
file.rbs 1ms
```
## 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.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-syntax-tree/syntax_tree-rbs.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).