Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kufu/textlint-ruby
Ruby AST parser for textlint-ruby-plugin
https://github.com/kufu/textlint-ruby
Last synced: about 6 hours ago
JSON representation
Ruby AST parser for textlint-ruby-plugin
- Host: GitHub
- URL: https://github.com/kufu/textlint-ruby
- Owner: kufu
- License: mit
- Created: 2022-01-17T00:59:50.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-29T02:42:51.000Z (7 months ago)
- Last Synced: 2024-08-09T14:57:39.003Z (3 months ago)
- Language: Ruby
- Size: 61.5 KB
- Stars: 7
- Watchers: 58
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# textlint-ruby
Ruby AST parser for [textlint-plugin-ruby](https://github.com/kufu/textlint-plugin-ruby).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'textlint-ruby'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install textlint-ruby
## Usage
Parse ruby to textlint AST
```sh
# Parse specific file
$ textlint-ruby ./path/to/file.rb
{"type":"Document","raw":"...","range":[0,465],"loc":{"start":{"line":1,"column":0},"end":{"line":26,"column":0}},"children":[...]}
# Boot textlint-ruby server for textlint-plugin-ruby
$ textlint-ruby --stdio
```
### Supported nodes
These types are defined in `@textlint/ast-node-types`.
Supported node types are only `Document` and `Str` because this plugin is used to format strings embedded in ruby programs.
| Type name | Node type | Supported |
| ------------------------------- | ------------- | ------------------------------------ |
| ASTNodeTypes.Document | TxtParentNode | yes |
| ASTNodeTypes.DocumentExit | TxtParentNode | |
| ASTNodeTypes.Paragraph | TxtParentNode | |
| ASTNodeTypes.ParagraphExit | TxtParentNode | |
| ASTNodeTypes.BlockQuote | TxtParentNode | |
| ASTNodeTypes.BlockQuoteExit | TxtParentNode | |
| ASTNodeTypes.List | TxtParentNode | |
| ASTNodeTypes.ListExit | TxtParentNode | |
| ASTNodeTypes.ListItem | TxtParentNode | |
| ASTNodeTypes.ListItemExit | TxtParentNode | |
| ASTNodeTypes.Header | TxtParentNode | |
| ASTNodeTypes.HeaderExit | TxtParentNode | |
| ASTNodeTypes.CodeBlock | TxtParentNode | |
| ASTNodeTypes.CodeBlockExit | TxtParentNode | |
| ASTNodeTypes.HtmlBlock | TxtParentNode | |
| ASTNodeTypes.HtmlBlockExit | TxtParentNode | |
| ASTNodeTypes.Link | TxtParentNode | |
| ASTNodeTypes.LinkExit | TxtParentNode | |
| ASTNodeTypes.Delete | TxtParentNode | |
| ASTNodeTypes.DeleteExit | TxtParentNode | |
| ASTNodeTypes.Emphasis | TxtParentNode | |
| ASTNodeTypes.EmphasisExit | TxtParentNode | |
| ASTNodeTypes.Strong | TxtParentNode | |
| ASTNodeTypes.StrongExit | TxtParentNode | |
| ASTNodeTypes.Break | TxtNode | |
| ASTNodeTypes.BreakExit | TxtNode | |
| ASTNodeTypes.Image | TxtNode | |
| ASTNodeTypes.ImageExit | TxtNode | |
| ASTNodeTypes.HorizontalRule | TxtNode | |
| ASTNodeTypes.HorizontalRuleExit | TxtNode | |
| ASTNodeTypes.Comment | TxtTextNode | yes |
| ASTNodeTypes.CommentExit | TxtTextNode | |
| ASTNodeTypes.Str | TxtTextNode | yes |
| ASTNodeTypes.StrExit | TxtTextNode | |
| ASTNodeTypes.Code | TxtTextNode | |
| ASTNodeTypes.CodeExit | TxtTextNode | |
| ASTNodeTypes.Html | TxtTextNode | |
| ASTNodeTypes.HtmlExit | TxtTextNode | |
## Development
Run `bundle exec rspec` to run the tests.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/kufu/textlint-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/kufu/textlint-ruby/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the `textlint-ruby` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kufu/textlint-ruby/blob/master/CODE_OF_CONDUCT.md).