rubocop
RuboCop 1.69.2
Vorbilder sind wichtig.
- Offizier Alex J. Murphy / Robocop
Rubocop ist ein Ruby Static Code Analyzer (auch bekannt als linter ) und Codeformatierer. Aus der Schachtel wird viele der im Community Ruby Style Guide beschriebenen Richtlinien erzwingen. Abgesehen davon, dass Rubocop die in Ihrem Code entdeckten Probleme berichtet, kann er auch viele von ihnen automatisch für Sie beheben.
Rubocop ist äußerst flexibel und die meisten Aspekte seines Verhaltens können über verschiedene Konfigurationsoptionen optimiert werden.
Die Arbeit an Rubocop macht oft Spaß, erfordert aber auch viel Zeit und Energie.
Bitte erwägen Sie, seine laufende Entwicklung finanziell zu unterstützen.
Die Installation von Rubocop ist ziemlich Standard:
$ gem install rubocop Wenn Sie Rubocop lieber mit bundler installieren möchten, fügen Sie eine Zeile dafür in Ihrer Gemfile hinzu (stellen Sie die Option require auf false ein, da es sich um ein eigenständiges Tool handelt):
gem 'rubocop' , require : false Rubocop ist zwischen kleinen Versionen sowohl hinsichtlich der API als auch in der COP -Konfiguration stabil. Wir möchten die Aufrechterhaltung von Rubocop -Erweiterungen und die Verbesserungen zwischen Rubocop -Freisetzungen erleichtern. Alle großen Änderungen sind für große Veröffentlichungen vorbehalten. Um ein unerwünschtes Rubocop -Update zu verhindern, möchten Sie möglicherweise eine konservative Versionssperrung in Ihrem Gemfile verwenden:
gem 'rubocop' , '~> 1.69' , require : falseWeitere Informationen finden Sie in unserer Versionsrichtlinie.
Geben Sie einfach rubocop in den Ordner eines Ruby -Projekts ein und beobachten Sie die Magie.
$ cd my/cool/ruby/project
$ rubocop
Sie können diese Magie auch in Ihrem bevorzugten Editor mit dem integrierten LSP-Server von Rubocop verwenden.
Sie können in seinen offiziellen Dokumenten viel mehr über Rubocop lesen.
Rubocop unterstützt offiziell die folgenden Laufzeit -Ruby -Implementierungen:
Ziele Ruby 2.0+ Codeanalyse.
Weitere Informationen finden Sie in der Kompatibilitätsdokumentation.
Wenn Sie Rubocop in Ihrem Projekt verwenden, können Sie eines dieser Abzeichen in Ihr Readme aufnehmen, damit die Leute wissen, dass Ihr Code dem Community Ruby Style Guide geschrieben ist.
Hier sind die Markdown -Snippets für die beiden Abzeichen:
[ ![ 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 ) Hier ist eine Liste der Kernentwickler von Rubocop:
Weitere Informationen finden Sie auf der Teamseite.
Rubocops Logo wurde von Dimiter Petrov erstellt. Hier finden Sie das Logo in verschiedenen Formaten.
Das Logo ist unter einer Kreative Commons Attribution-Noncommercial 4.0 International Lizenz lizenziert.
Hier ist eine Liste aller Personen, die zur Entwicklung von Rubocop beigetragen haben.
Ich bin jedem einzelnen von ihnen sehr dankbar!
Wenn Sie zu Rubocop beitragen möchten, nehmen Sie sich bitte die Zeit, um unsere Richtlinien für kurze Beitragszüge zu durchlaufen.
Das Umwandeln mehr des Ruby -Style -Handbuchs in Rubocop Cops hat derzeit unsere oberste Priorität. Ein neuer Polizist zu schreiben ist eine großartige Möglichkeit, in Rubocop einzusteigen!
Natürlich sind Fehlerberichte und Verbesserungsvorschläge immer willkommen. Github Pull -Anfragen sind noch besser! :-)
Während Rubocop kostenlose Software ist und immer sein wird, würde das Projekt von einigen Finanzmitteln immens profitieren. Durch die Erhöhung eines monatlichen Budgets von ein paar tausend Dollar würde es den Menschen ermöglichen, an bestimmten komplexen Funktionen zu arbeiten, andere Entwicklungsbezogene Dinge (z. B. Hardware, Konferenzreisen) und so weiter zu finanzieren. Die Erhöhung eines monatlichen Budgets von über 5000 US-Dollar würde die Möglichkeit eröffnen, dass jemand Vollzeit an dem Projekt arbeitet, was das Entwicklungstempo erheblich beschleunigen würde.
Wir begrüßen sowohl Einzel- als auch Unternehmenssponsoren! Wir bieten auch eine Vielzahl von Finanzierungskanälen an, um Ihre Vorlieben zu berücksichtigen (obwohl das derzeit offene Kollektiv unsere bevorzugte Finanzierungsplattform ist).
Wenn Sie in einem Unternehmen arbeiten, das Rubocop erheblich nutzt, würden wir es zu schätzen wissen, wenn Sie Ihrem Unternehmen vorschlagen, Rubocop -Sponsor zu werden.
Sie können die Entwicklung von Rubocop über Github -Sponsoren, Patreon, Paypal, Open Collective und Tidelift unterstützen.
Hinweis: Wenn ein Sponsoring in Form der Spende für Ihr Unternehmen aus der Sicht des Bilanzierenden problematisch ist, empfehlen wir die Verwendung von TIDELIFT, wo Sie stattdessen ein Support-ähnliches Abonnement erhalten können.
Unterstützen Sie uns mit einer monatlichen Spende und helfen Sie uns, unsere Aktivitäten fortzusetzen. [Backer werden]
Werden Sie Sponsor und holen Sie sich Ihr Logo auf unserem Readme auf GitHub mit einem Link zu Ihrer Website. [Sponsor werden]
Rubocops ChangeLog ist hier erhältlich.
Copyright (C) 2012-2024 BOZHIDAR BATSOV. Weitere Informationen finden Sie unter Lizenz.txt.
