{"id":22313310,"url":"https://github.com/nwops/retrospec-plugingen","last_synced_at":"2025-03-26T02:38:08.674Z","repository":{"id":56892095,"uuid":"43047199","full_name":"nwops/retrospec-plugingen","owner":"nwops","description":"Generates the retrospec plugin scaffolding","archived":false,"fork":false,"pushed_at":"2015-10-12T04:31:59.000Z","size":208,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-01T13:46:02.894Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com","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/nwops.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}},"created_at":"2015-09-24T05:42:19.000Z","updated_at":"2015-12-18T06:38:25.000Z","dependencies_parsed_at":"2022-08-20T16:01:05.059Z","dependency_job_id":null,"html_url":"https://github.com/nwops/retrospec-plugingen","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwops%2Fretrospec-plugingen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwops%2Fretrospec-plugingen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwops%2Fretrospec-plugingen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nwops%2Fretrospec-plugingen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nwops","download_url":"https://codeload.github.com/nwops/retrospec-plugingen/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245577931,"owners_count":20638412,"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-12-03T22:06:56.237Z","updated_at":"2025-03-26T02:38:08.652Z","avatar_url":"https://github.com/nwops.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# retrospec-plugin_gen\n[![Gem Version](https://badge.fury.io/rb/retrospec-plugingen.svg)](http://badge.fury.io/rb/retrospec-plugingen)\n\n## Summary\nThis plugin is the starting point to create plugins for retrospec.  Its a widget for creating widgets!\nUse the plugin to generate the retrospec plugin layout, along with basic tests and documentation.\n\n## Install\n`gem install retrospec-plugingen`\n\n## Usage\n\nTo create a new plugin for retrospec use the following command `retrospec -m /tmp/test4 plugingen`.\nBy default plugingen will use the current directory as the name of the plugin.  \nIf you wish to override this name please pass the `-n` option. `retrospec -m /tmp/test4 plugingen -n test_plugin`\n\n```shell\n% retrospec -m /tmp/test4 plugingen -h\n% \nOptions:\n  -n, --name=\u003cs\u003e    The name of the new plugin (default: test4)\n  -h, --help        Show this message\nMacBook-Pro~ % retrospec -m /tmp/test4 plugingen   \n!! /Users/cosman/.retrospec/config.yaml.sample already exists\n + /tmp/test4/\n + /tmp/test4/.gitignore\n + /tmp/test4/.rspec\n + /tmp/test4/Gemfile\n + /tmp/test4/LICENSE.txt\n + /tmp/test4/README.md\n + /tmp/test4/Rakefile\n + /tmp/test4/lib/\n + /tmp/test4/lib/retrospec/\n + /tmp/test4/lib/retrospec/plugins/\n + /tmp/test4/lib/retrospec/plugins/v1/\n + /tmp/test4/lib/retrospec/plugins/v1/plugin/\n + /tmp/test4/lib/retrospec/plugins/v1/plugin/spec_object.rb\n + /tmp/test4/spec/\n + /tmp/test4/spec/plugin_spec.rb\n + /tmp/test4/spec/spec_helper.rb\n + /tmp/test4/lib/retrospec-test4.rb\n + /tmp/test4/lib/retrospec/plugins/v1/plugin/test4.rb\n```\n\nOnce the plugin directory has been created you are ready to start development on your plugin.  This plugin\nproduces a working retrospec plugin with unit tests.  So just add your code and go.  The templates are based off the jeweler gem\nso if you currently use [jeweler](https://github.com/technicalpickles/jeweler) you should feel right at home.  \n\nAt a minimum run:\n\n```\nbundle install\nbundle exec rake -T\nbundle exec rake version:write\n# edit the Rakefile and fill with our gem information\nbundle exec rake spec\nbundle exec rake gemspec (recreate the gemspec)\nbundle exec rake version:bump:minor (when releasing)\nbundle exec git:release \nbundle exec release (send to rubygems.org)\n# submit a PR to retrospec and tell me about your new plugin\nhttps://github.com/nwops/retrospec/blob/master/available_plugins.yaml\n\n\n## Contributing to retrospec-plugingen\nGot a change you want to see in this plugin?  Submit a PR.\n\n* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.\n* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.\n* Fork the project.\n* Start a feature/bugfix branch.\n* Commit and push until you are happy with your contribution.\n* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.\n* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.\n\n## Copyright\n\nCopyright (c) 2015 Corey Osman. See LICENSE.txt for\nfurther details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnwops%2Fretrospec-plugingen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnwops%2Fretrospec-plugingen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnwops%2Fretrospec-plugingen/lists"}