ロールモデルは重要です。
- 役員アレックス・J・マーフィー /ロボコップ
RuboCopは、Ruby Static Code Analyzer(別名linter )とコードフォーマッタです。箱から出して、コミュニティRubyスタイルガイドに概説されているガイドラインの多くを実施します。あなたのコードで発見された問題を報告することとは別に、ルボコップはあなたのためにそれらの多くを自動的に修正することもできます。
Rubocopは非常に柔軟であり、その動作のほとんどの側面は、さまざまな構成オプションを介して微調整できます。
Rubocopでの作業はしばしば楽しいですが、多くの時間とエネルギーも必要です。
継続的な開発を財政的にサポートすることを検討してください。
Rubocopのインストールはかなり標準です:
$ gem install rubocop bundlerを使用してRubocopをインストールする場合は、 Gemfileにラインを追加します(ただし、スタンドアロンツールであるため、 requireオプションをfalseに設定します):
gem 'rubocop' , require : false Rubocopは、APIとCOP構成の両方の観点から、マイナーバージョン間で安定しています。ルーボコップ拡張のメンテナンスと、ルーボコップリリース間のアップグレードを容易にすることを目指しています。すべての大きな変更は、主要なリリースのために予約されています。不要なルーボコップアップデートを防ぐには、 Gemfileに保守的なバージョンロックを使用することをお勧めします。
gem 'rubocop' , '~> 1.69' , require : false詳細については、バージョン化ポリシーを参照してください。
Ruby Projectのフォルダーにrubocopを入力して、魔法が起こるのを見るだけです。
$ cd my/cool/ruby/project
$ rubocop
また、Rubocopの組み込みLSPサーバーを使用して、お気に入りのエディターでこの魔法を使用することもできます。
Rubocopについては、公式のドキュメントで詳しく読むことができます。
Rubocopは、次のランタイムルビーの実装を正式にサポートしています。
Ruby 2.0+コード分析をターゲットにします。
詳細については、互換性のドキュメントを参照してください。
プロジェクトでrubocopを使用する場合、これらのバッジの1つをReadMeに含めて、コードがコミュニティRubyスタイルガイドに従って書かれていることを人々に知らせることができます。
2つのバッジのマークダウンスニペットは次のとおりです。
[ ![ 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のロゴは、Dimiter Petrovによって作成されました。ロゴはさまざまな形式で見つけることができます。
このロゴは、クリエイティブコモンズの帰属ノンコマーシャル4.0国際ライセンスの下でライセンスされています。
これは、ルボコップの開発に貢献したすべての人々のリストです。
私は彼らの一人一人に非常に感謝しています!
Rubocopに貢献したい場合は、時間をかけて短い貢献ガイドラインを行ってください。
Rubyスタイルのガイドをより多くのRubocop Copsに変換することは、現在私たちの最優先事項です。新しい警官を書くことは、ルーボコップに飛び込むのに最適な方法です!
もちろん、改善のためのバグのレポートと提案はいつでも大歓迎です。 Github Pullリクエストの方がさらに優れています! :-)
ルボコップはフリーソフトウェアであり、常に存在しますが、プロジェクトはいくつかの資金から非常に恩恵を受けるでしょう。数千ドルの月額予算を調達することで、特定の複雑な機能に取り組むために人々に支払うこと、他の開発関連のもの(ハードウェア、会議旅行など)に資金を提供することが可能になります。 5000ドルを超える月額予算を調達すると、開発のペースを大幅に高速化するプロジェクトにフルタイムで働いている人の可能性が開かれます。
個人と企業の両方のスポンサーを歓迎します!また、お客様の好みを説明するために幅広い資金調達チャネルを提供しています(ただし、現在オープンコレクティブが当社の優先資金プラットフォームですが)。
ルーボコップを大幅に活用している会社で働いている場合は、あなたの会社にルーボコップスポンサーになることを提案すれば感謝しています。
Githubスポンサー、Patreon、Paypal、Open Collective、Tideliftを介してRubocopの開発をサポートできます。
注:寄付という形でスポンサーシップを行うことが、会計の観点から会社にとって問題がある場合は、代わりにサポートのようなサブスクリプションを取得できるTideliftの使用をお勧めします。
毎月の寄付で私たちをサポートし、私たちが活動を続けるのを助けてください。 [支援者になる]
スポンサーになって、サイトへのリンクを使用して、GitHubのReadMeでロゴを取得します。 [スポンサーになる]
RubocopのChangelogはこちらから入手できます。
Copyright(c)2012-2024 Bozhidar Batsov。詳細については、license.txtを参照してください。