{"id":13878268,"url":"https://github.com/nshki/chusaku","last_synced_at":"2025-05-16T07:04:07.353Z","repository":{"id":46117539,"uuid":"188331568","full_name":"nshki/chusaku","owner":"nshki","description":"Annotate your Rails controllers with route info.","archived":false,"fork":false,"pushed_at":"2024-12-26T17:56:25.000Z","size":131,"stargazers_count":92,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-19T01:58:07.390Z","etag":null,"topics":["annotations","controller","gem","rails","routes","ruby"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/chusaku","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/nshki.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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,"zenodo":null}},"created_at":"2019-05-24T01:30:45.000Z","updated_at":"2025-02-26T18:43:08.000Z","dependencies_parsed_at":"2024-01-05T02:24:13.395Z","dependency_job_id":"a070e80b-b7a2-4db8-8222-efdf5423bd90","html_url":"https://github.com/nshki/chusaku","commit_stats":{"total_commits":106,"total_committers":11,"mean_commits":9.636363636363637,"dds":"0.33018867924528306","last_synced_commit":"6fe24ad565d3f24029aec9286a4dba7fd2ebbd6a"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nshki%2Fchusaku","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nshki%2Fchusaku/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nshki%2Fchusaku/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nshki%2Fchusaku/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nshki","download_url":"https://codeload.github.com/nshki/chusaku/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254485053,"owners_count":22078767,"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":["annotations","controller","gem","rails","routes","ruby"],"created_at":"2024-08-06T08:01:44.655Z","updated_at":"2025-05-16T07:04:07.326Z","avatar_url":"https://github.com/nshki.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# Chusaku\n\n[![Gem Version](https://badge.fury.io/rb/chusaku.svg)](https://badge.fury.io/rb/chusaku)\n\nAdd comments above your Rails actions that look like:\n\n```ruby\n# @route GET /waterlilies/:id (waterlily)\ndef show\n  # ...\nend\n\n# @route PATCH /waterlilies/:id (waterlily)\n# @route PUT /waterlilies/:id (waterlily)\ndef update\n  # ...\nend\n```\n\nBased on your `routes.rb` file!\n\n\n## Installation\n\nAdd this line to your Rails application's Gemfile:\n\n```ruby\ngroup :development do\n  gem \"chusaku\", require: false\nend\n```\n\nAnd then execute:\n\n```sh\nbundle install\n```\n\n\n## Usage\n\nFrom the root of your Rails application, run:\n\n```sh\nbundle exec chusaku\n```\n\nChusaku has some flags available for use as well:\n\n```\n$ bundle exec chusaku --help\nUsage: chusaku [options]\n        --dry-run                       Run without file modifications\n        --exit-with-error-on-annotation Fail if any file was annotated\n    -c, --controllers-pattern=GLOB      Specify alternative controller files glob pattern\n    -e, --exclusion-pattern=GLOB        Specify controller files exclusion glob pattern\n        --verbose                       Print all annotated files\n    -v, --version                       Show Chusaku version number and quit\n    -h, --help                          Show this help message and quit\n```\n\n### Rake usage\n\nIf you'd like to use Chusaku as a Rake task, add the following line to your `Rakefile`:\n\n```ruby\nrequire \"chusaku\"\nChusaku.load_tasks\n```\n\nThis will then allow you to call:\n\n```sh\nbin/rake chusaku\n```\n\nTo pass flags, pass them like you would from the CLI executable:\n\n```sh\nbin/rake chusaku -- --dry-run --exit-with-error-on-annotation\n```\n\n\n## Development\n\nRead the blog post explaining how the gem works at a high level: https://nshki.com/chusaku-a-controller-annotation-gem.\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo 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, git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnshki%2Fchusaku","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnshki%2Fchusaku","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnshki%2Fchusaku/lists"}