{"id":20166174,"url":"https://github.com/utkarsh2102/rubocop-packaging","last_synced_at":"2025-04-04T21:07:12.751Z","repository":{"id":43203642,"uuid":"270371910","full_name":"utkarsh2102/rubocop-packaging","owner":"utkarsh2102","description":"A RuboCop extension focused on enforcing upstream best practices and coding conventions.","archived":false,"fork":false,"pushed_at":"2025-03-23T05:19:55.000Z","size":171,"stargazers_count":36,"open_issues_count":3,"forks_count":10,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-28T20:06:26.666Z","etag":null,"topics":["code-formatter","downstream","linter","packaging","rubocop","ruby","static-code-analysis","upstream"],"latest_commit_sha":null,"homepage":"","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/utkarsh2102.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2020-06-07T16:56:01.000Z","updated_at":"2025-02-17T14:50:24.000Z","dependencies_parsed_at":"2025-02-22T19:11:03.577Z","dependency_job_id":"33fac596-de00-42a3-a341-9409b430f401","html_url":"https://github.com/utkarsh2102/rubocop-packaging","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utkarsh2102%2Frubocop-packaging","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utkarsh2102%2Frubocop-packaging/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utkarsh2102%2Frubocop-packaging/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utkarsh2102%2Frubocop-packaging/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/utkarsh2102","download_url":"https://codeload.github.com/utkarsh2102/rubocop-packaging/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247249524,"owners_count":20908212,"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":["code-formatter","downstream","linter","packaging","rubocop","ruby","static-code-analysis","upstream"],"created_at":"2024-11-14T00:42:49.264Z","updated_at":"2025-04-04T21:07:12.734Z","avatar_url":"https://github.com/utkarsh2102.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RuboCop::Packaging\n\n`RuboCop::Packaging` is an extension of [RuboCop](https://rubocop.org/),\nwhich is a Ruby static code analyzer (a.k.a. linter) and code formatter.\n\nIt helps enforcing some of the guidelines that are expected of upstream\nmaintainers so that the downstream can build their packages in a clean\nenvironment without any problems.\n\n## Documentation\n\nA detailed documentation, explaining what this extension is doing and the\nreasoning behind it, can be found here: https://docs.rubocop.org/rubocop-packaging/\n\nWe also have a [packaging-style-guide](https://packaging.rubystyle.guide/),\nlisting some good and bad examples and the rationale behind these cops.\n\nIn case anything is not clear, please feel free to raise an issue, asking\nfor more explanation!\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'rubocop-packaging'\n```\n\nAnd then execute:\n\n```bash\n$ bundle install\n```\n\nOr install it yourself as:\n\n```bash\n$ gem install rubocop-packaging\n```\n\n## Usage\n\nYou need to tell RuboCop to load the Packaging extension. There are three\nways to do this:\n\n### RuboCop configuration file\n\nPut this into your `.rubocop.yml` file:\n\n```yaml\nplugins: rubocop-packaging\n```\n\nAlternatively, use the following array notation when specifying multiple\nextensions:\n\n```yaml\nplugins:\n  - rubocop-other-extension\n  - rubocop-packaging\n```\n\nNow you can run `rubocop` and it will automatically load the RuboCop Packaging\ncops together with the standard cops.\n\n\u003e [!NOTE]\n\u003e The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.\n\n### Command line\n\n```bash\nrubocop --plugin rubocop-packaging\n```\n\n### Rake task\n\n```ruby\nRuboCop::RakeTask.new do |task|\n  task.plugins \u003c\u003c 'rubocop-packaging'\nend\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then,\nrun `rake spec` to run the tests. You can also run `bin/console` for an\ninteractive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`.\n\n## Contributing\n\nAs always, bug reports and pull requests are heartily welcomed! 💖\nThis project is intended to be a safe and welcoming space for collaboration.\n\n## License\n`rubocop-packaging` is available as open-source under the\n[MIT License](https://github.com/utkarsh2102/rubocop-packaging/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futkarsh2102%2Frubocop-packaging","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Futkarsh2102%2Frubocop-packaging","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futkarsh2102%2Frubocop-packaging/lists"}