{"id":18916757,"url":"https://github.com/kufu/textlint-ruby","last_synced_at":"2025-04-15T09:31:13.213Z","repository":{"id":43153776,"uuid":"448713310","full_name":"kufu/textlint-ruby","owner":"kufu","description":"Ruby AST parser for textlint-ruby-plugin","archived":false,"fork":false,"pushed_at":"2024-03-29T02:42:51.000Z","size":63,"stargazers_count":7,"open_issues_count":0,"forks_count":2,"subscribers_count":58,"default_branch":"main","last_synced_at":"2024-08-09T14:57:39.003Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kufu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-01-17T00:59:50.000Z","updated_at":"2023-11-08T13:50:39.000Z","dependencies_parsed_at":"2024-03-29T03:32:30.840Z","dependency_job_id":"bbef852e-6d15-46fb-8929-4513d7a7b75f","html_url":"https://github.com/kufu/textlint-ruby","commit_stats":{"total_commits":49,"total_committers":2,"mean_commits":24.5,"dds":"0.020408163265306145","last_synced_commit":"71070ef759a8ac8c9b772cfc7e2675c3f14f4694"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kufu%2Ftextlint-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kufu%2Ftextlint-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kufu%2Ftextlint-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kufu%2Ftextlint-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kufu","download_url":"https://codeload.github.com/kufu/textlint-ruby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223665577,"owners_count":17182345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-08T10:21:48.254Z","updated_at":"2024-11-08T10:21:48.948Z","avatar_url":"https://github.com/kufu.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# textlint-ruby\n\nRuby AST parser for [textlint-plugin-ruby](https://github.com/kufu/textlint-plugin-ruby).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'textlint-ruby'\n```\n\nAnd then execute:\n\n    $ bundle install\n\nOr install it yourself as:\n\n    $ gem install textlint-ruby\n\n## Usage\n\nParse ruby to textlint AST\n\n```sh\n# Parse specific file\n$ textlint-ruby ./path/to/file.rb\n{\"type\":\"Document\",\"raw\":\"...\",\"range\":[0,465],\"loc\":{\"start\":{\"line\":1,\"column\":0},\"end\":{\"line\":26,\"column\":0}},\"children\":[...]}\n\n# Boot textlint-ruby server for textlint-plugin-ruby\n$ textlint-ruby --stdio\n```\n\n### Supported nodes\n\nThese types are defined in `@textlint/ast-node-types`.\nSupported node types are only `Document` and `Str` because this plugin is used to format strings embedded in ruby programs.\n\n| Type name                       | Node type     | Supported                            |\n| ------------------------------- | ------------- | ------------------------------------ |\n| ASTNodeTypes.Document           | TxtParentNode | yes                                  |\n| ASTNodeTypes.DocumentExit       | TxtParentNode |                                      |\n| ASTNodeTypes.Paragraph          | TxtParentNode |                                      |\n| ASTNodeTypes.ParagraphExit      | TxtParentNode |                                      |\n| ASTNodeTypes.BlockQuote         | TxtParentNode |                                      |\n| ASTNodeTypes.BlockQuoteExit     | TxtParentNode |                                      |\n| ASTNodeTypes.List               | TxtParentNode |                                      |\n| ASTNodeTypes.ListExit           | TxtParentNode |                                      |\n| ASTNodeTypes.ListItem           | TxtParentNode |                                      |\n| ASTNodeTypes.ListItemExit       | TxtParentNode |                                      |\n| ASTNodeTypes.Header             | TxtParentNode |                                      |\n| ASTNodeTypes.HeaderExit         | TxtParentNode |                                      |\n| ASTNodeTypes.CodeBlock          | TxtParentNode |                                      |\n| ASTNodeTypes.CodeBlockExit      | TxtParentNode |                                      |\n| ASTNodeTypes.HtmlBlock          | TxtParentNode |                                      |\n| ASTNodeTypes.HtmlBlockExit      | TxtParentNode |                                      |\n| ASTNodeTypes.Link               | TxtParentNode |                                      |\n| ASTNodeTypes.LinkExit           | TxtParentNode |                                      |\n| ASTNodeTypes.Delete             | TxtParentNode |                                      |\n| ASTNodeTypes.DeleteExit         | TxtParentNode |                                      |\n| ASTNodeTypes.Emphasis           | TxtParentNode |                                      |\n| ASTNodeTypes.EmphasisExit       | TxtParentNode |                                      |\n| ASTNodeTypes.Strong             | TxtParentNode |                                      |\n| ASTNodeTypes.StrongExit         | TxtParentNode |                                      |\n| ASTNodeTypes.Break              | TxtNode       |                                      |\n| ASTNodeTypes.BreakExit          | TxtNode       |                                      |\n| ASTNodeTypes.Image              | TxtNode       |                                      |\n| ASTNodeTypes.ImageExit          | TxtNode       |                                      |\n| ASTNodeTypes.HorizontalRule     | TxtNode       |                                      |\n| ASTNodeTypes.HorizontalRuleExit | TxtNode       |                                      |\n| ASTNodeTypes.Comment            | TxtTextNode   | yes                                  |\n| ASTNodeTypes.CommentExit        | TxtTextNode   |                                      |\n| ASTNodeTypes.Str                | TxtTextNode   | yes                                  |\n| ASTNodeTypes.StrExit            | TxtTextNode   |                                      |\n| ASTNodeTypes.Code               | TxtTextNode   |                                      |\n| ASTNodeTypes.CodeExit           | TxtTextNode   |                                      |\n| ASTNodeTypes.Html               | TxtTextNode   |                                      |\n| ASTNodeTypes.HtmlExit           | TxtTextNode   |                                      |\n\n## Development\n\nRun `bundle exec rspec` to run the tests.\n\n## Contributing\n\nBug 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).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone 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).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkufu%2Ftextlint-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkufu%2Ftextlint-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkufu%2Ftextlint-ruby/lists"}