榜樣很重要。
- 軍官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。