{"id":28630978,"url":"https://github.com/piotrmurach/queen","last_synced_at":"2025-06-12T13:09:31.809Z","repository":{"id":66238130,"uuid":"115201160","full_name":"piotrmurach/queen","owner":"piotrmurach","description":"English language linter to hold your files in high esteem.","archived":false,"fork":false,"pushed_at":"2022-08-09T22:00:30.000Z","size":30,"stargazers_count":8,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-01T23:00:11.746Z","etag":null,"topics":["checker","english","linter","quality","ruby","rubygem"],"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/piotrmurach.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2017-12-23T14:36:04.000Z","updated_at":"2024-05-01T23:00:11.747Z","dependencies_parsed_at":"2023-02-20T16:31:23.745Z","dependency_job_id":null,"html_url":"https://github.com/piotrmurach/queen","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/piotrmurach/queen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piotrmurach%2Fqueen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piotrmurach%2Fqueen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piotrmurach%2Fqueen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piotrmurach%2Fqueen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/piotrmurach","download_url":"https://codeload.github.com/piotrmurach/queen/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piotrmurach%2Fqueen/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259470950,"owners_count":22862999,"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":["checker","english","linter","quality","ruby","rubygem"],"created_at":"2025-06-12T13:09:31.167Z","updated_at":"2025-06-12T13:09:31.800Z","avatar_url":"https://github.com/piotrmurach.png","language":"Ruby","readme":"# Queen\n\n[![Gem Version](https://badge.fury.io/rb/queen.svg)][gem]\n[![Build Status](https://secure.travis-ci.org/piotrmurach/queen.svg?branch=master)][travis]\n[![Build status](https://ci.appveyor.com/api/projects/status/atibfgu43dit3xkt?svg=true)][appveyor]\n[![Maintainability](https://api.codeclimate.com/v1/badges/23e0a5aab6623aebd854/maintainability)][codeclimate]\n[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/queen/badge.svg?branch=master)][coverage]\n[![Inline docs](http://inch-ci.org/github/piotrmurach/queen.svg?branch=master)][inchpages]\n\n[gem]: http://badge.fury.io/rb/queen\n[travis]: http://travis-ci.org/piotrmurach/queen\n[appveyor]: https://ci.appveyor.com/project/piotrmurach/queen\n[codeclimate]: https://codeclimate.com/github/piotrmurach/queen/maintainability\n[coverage]: https://coveralls.io/github/piotrmurach/queen?branch=master\n[inchpages]: http://inch-ci.org/github/piotrmurach/queen\n\n\u003e **Queen** is an English langauge linter that reports on spelling, grammar, and other crimes against the written word, and will help you hold your code and comments in high esteem.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'queen'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install queen\n\n## Usage\n\nRunning the `queen` command with no arguments will check all source files in the current directory:\n\n```\n$ queen\n```\n\nAlternatively, you can `specify` a list of files and/or directories to be scanned, like so:\n\n```\n$ queen lib spec file.rb\n```\n\nFor example, let's assume the following sentence by Freddie Mercury:\n\n```ruby\nclass Freddie\n  def say\n    \"I'm just a musical prostitute, my dear.\"\n  end\nend\n```\n\nAfter **Queen** reviews the file (named `freddie.rb`), the following reprimands are given:\n\n```\nReviewing 1 file\n\nReprimands:\n\nfreddie.rb:3:25: prostitute may be viewed as offensive. Consider removing this word.\n\n1 file checked, 1 reprimand given.\n```\n\nTo see all available commands add `-h` or `--help` flag:\n\n```\n$ queen -h (--help)\n```\n\n| Command flag  | Description |\n|---------------|-------------|\n| --[no-]color  | Force color output on or off. |\n| -d/--debug    | Change log level to DEBUG. |\n| -o/--out      | Write output to a file instead of stdout. |\n| -r/--require  | Require Ruby file. |\n| --verbose     | Change log level to VERBOSE. |\n| -v/--version  | Display the current version and exit. |\n\n## Configuration\n\n\nAll **Queen** rules are enabled by default and can be configured in `.queen.yml` file. Default configuration:\n\n```ruby\n---\nrules:\n  profanity:\n    enabled: true\n    exclude: []\n  spelling:\n    enabled: true\n    exclude: []\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/piotrmurach/queen. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## Copyright\n\nCopyright (c) 2017-2018 Piotr Murach. See LICENSE for further details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiotrmurach%2Fqueen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiotrmurach%2Fqueen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiotrmurach%2Fqueen/lists"}