榜样很重要。
- 军官Alex J. Murphy / Robocop
Rubocop是Ruby静态代码分析仪(又称linter )和代码格式。开箱即用,它将执行《社区红宝石风格指南》中概述的许多准则。除了报告代码中发现的问题外,Rubocop还可以自动为您解决许多问题。
Rubocop非常灵活,并且可以通过各种配置选项对其行为的大多数方面进行调整。
在Rubocop上工作通常很有趣,但这也需要大量的时间和精力。
请考虑在财务上支持其正在进行的发展。
Rubocop的安装是非常标准的:
$ gem install rubocop如果您想使用bundler安装RuboCop,请在您的Gemfile中添加一行(但将require选项设置为false ,因为它是独立的工具):
gem 'rubocop' , require : false在API和COP配置方面,RuboCop在次要版本之间都是稳定的。我们的目标是简化RuboCop扩展的维护和Rubocop发行版之间的升级。所有重大变化都保留给主要版本。为了防止不必要的RuboCop更新,您可能需要在Gemfile中使用保守的版本锁定:
gem 'rubocop' , '~> 1.69' , require : false有关更多详细信息,请参见我们的版本策略。
只需在Ruby Project的文件夹中键入rubocop ,然后观察魔术的发生。
$ cd my/cool/ruby/project
$ rubocop
您也可以使用Rubocop的内置LSP服务器在您喜欢的编辑器中使用此魔术。
您可以在其官方文档中阅读有关Rubocop的更多信息。
RuboCop正式支持以下运行时Ruby实现:
目标Ruby 2.0+代码分析。
有关更多详细信息,请参见兼容性文档。
如果您在项目中使用RuboCop,则可以在阅读室中包含其中一个徽章,让人们知道您的代码是按照社区Ruby Style Guide编写的。
这是两个徽章的降价片段:
[ ![ Ruby Style Guide ] ( https://img.shields.io/badge/code_style-rubocop-brightgreen.svg )] ( https://github.com/rubocop/rubocop )
[ ![ Ruby Style Guide ] ( https://img.shields.io/badge/code_style-community-brightgreen.svg )] ( https://rubystyle.guide ) 这是Rubocop的核心开发人员列表:
有关更多详细信息,请参见团队页面。
Rubocop的徽标是由Dimiter Petrov创建的。您可以在此处找到各种格式的徽标。
该徽标是根据创意共享归因非商业4.0国际许可证获得许可的。
这是所有为Rubocop发展做出贡献的人的清单。
我非常感谢他们每个人!
如果您想为Rubocop做出贡献,请花时间浏览我们的简短贡献指南。
现在,将更多的红宝石风格指南转换为Rubocop Cops是我们目前的重中之重。写一个新的警察是潜入Rubocop的好方法!
当然,总是欢迎错误报告和改进建议。 GitHub拉的请求甚至更好! :-)
虽然Rubocop是免费的软件,并且将永远是,但该项目将从一些资金中受益。筹集每月数千美元的预算将使人们可以向人们付钱以获得某些复杂的功能,为其他与开发有关的东西提供资金(例如硬件,会议之旅)等。提高每月预算超过5000美元,将为某人全职从事该项目的可能性开放,这将大大加快开发步伐。
我们欢迎个人和公司赞助商!我们还提供各种各样的资金渠道来说明您的偏好(尽管目前开放的集体是我们的首选融资平台)。
如果您在一家大量使用RuboCop的公司工作,如果您建议您向公司成为Rubocop赞助商,我们将不胜感激。
您可以通过GitHub赞助商,Patreon,PayPal,Open Collective和Tidelift来支持Rubocop的开发。
注意:如果以捐赠的形式进行赞助对于您的公司而言是有问题的,我们建议使用Tidelift,您可以在其中获得类似支持的订阅。
每月捐款支持我们,并帮助我们继续我们的活动。 [成为支持者]
成为赞助商,并在Github上获得徽标,并在Github上使用指向您网站的链接。 [成为赞助商]
Rubocop的ChangElog在这里可用。
版权(C)2012-2024 Bozhidar Batsov。有关更多详细信息,请参见License.txt。