{"id":13878546,"url":"https://github.com/dduugg/yard-sorbet","last_synced_at":"2025-04-12T20:45:46.548Z","repository":{"id":37819775,"uuid":"231304796","full_name":"dduugg/yard-sorbet","owner":"dduugg","description":"Types are documentation","archived":false,"fork":false,"pushed_at":"2025-04-01T10:23:49.000Z","size":7087,"stargazers_count":34,"open_issues_count":0,"forks_count":11,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-04T00:09:55.864Z","etag":null,"topics":["rbi","ruby","sorbet","yard","yardoc"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dduugg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["dduugg"]}},"created_at":"2020-01-02T04:02:19.000Z","updated_at":"2025-04-01T14:09:24.000Z","dependencies_parsed_at":"2024-01-01T11:27:40.351Z","dependency_job_id":"11b1291b-7ec4-40f1-b8e6-fb2e990db9f8","html_url":"https://github.com/dduugg/yard-sorbet","commit_stats":{"total_commits":386,"total_committers":10,"mean_commits":38.6,"dds":"0.48963730569948183","last_synced_commit":"bbaa0c8839559cc5730f530fa7335a85bf28608d"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dduugg%2Fyard-sorbet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dduugg%2Fyard-sorbet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dduugg%2Fyard-sorbet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dduugg%2Fyard-sorbet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dduugg","download_url":"https://codeload.github.com/dduugg/yard-sorbet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248631692,"owners_count":21136559,"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":["rbi","ruby","sorbet","yard","yardoc"],"created_at":"2024-08-06T08:01:52.741Z","updated_at":"2025-04-12T20:45:46.529Z","avatar_url":"https://github.com/dduugg.png","language":"Ruby","funding_links":["https://github.com/sponsors/dduugg"],"categories":["Ruby"],"sub_categories":[],"readme":"# yard-sorbet\n[![Gem Version](https://badge.fury.io/rb/yard-sorbet.svg)](https://badge.fury.io/rb/yard-sorbet)\n[![Build Status](https://github.com/dduugg/yard-sorbet/actions/workflows/ruby.yml/badge.svg)](https://github.com/dduugg/yard-sorbet/actions/workflows/ruby.yml)\n[![codecov](https://codecov.io/gh/dduugg/yard-sorbet/branch/master/graph/badge.svg)](https://codecov.io/gh/dduugg/yard-sorbet)\n\nA YARD [plugin](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#plugin-support) that parses Sorbet type annotations\n\n## Features\n- Attaches existing documentation to methods and attributes that follow `sig` declarations. (This information is otherwise discarded.)\n- Translates `sig` type signatures into corresponding YARD tags\n- Generates method definitions from `T::Struct` fields\n- Generates constant definitions from `T::Enum` enums\n- Modules marked `abstract!` or `interface!` are tagged `@abstract`\n- Modules using `mixes_in_class_methods` will attach class methods\n- Merges `sig`s in rbi files with source code documentation (rbi files must come after source code in yard configuration)\n\n## Usage\n\nSee the Plugin Support [section](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#plugin-support) of the YARD docs.\n\n## Used By\n\nThis plugin is used by:\n- The [Homebrew Ruby API](https://rubydoc.brew.sh/index.html)\n- [Tapioca](https://github.com/Shopify/tapioca), to optionally include YARD documentation from sources when generating RBIs\n- `yard-sorbet` [itself](https://dduugg.github.io/yard-sorbet/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdduugg%2Fyard-sorbet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdduugg%2Fyard-sorbet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdduugg%2Fyard-sorbet/lists"}