rubocop
RuboCop 1.69.2
Ролевые модели важны.
- офицер Алекс Дж. Мерфи / Робокоп
Rubocop - это анализатор Ruby Static Code (он же linter ) и форматер кода. Из коробки это будет обеспечивать соблюдение многих руководств, изложенных в Руководстве по стилю сообщества. Помимо сообщений о проблемах, обнаруженных в вашем коде, Rubocop также может автоматически исправить многие из них для вас.
Rubocop чрезвычайно гибкий, и большинство аспектов его поведения можно настроить с помощью различных параметров конфигурации.
Работа над Rubocop часто весело, но это также требует много времени и энергии.
Пожалуйста, рассмотрите финансовую поддержку его постоянного развития.
Установка Rubocop довольно стандартная:
$ gem install rubocop Если вы предпочитаете установить Rubocop с помощью bundler , добавьте линию для нее в свой Gemfile (но установите опцию require на false , так как это автономный инструмент):
gem 'rubocop' , require : false Rubocop стабилен между незначительными версиями, как с точки зрения конфигурации API, так и конфигурации COP. Мы стремимся облегчить поддержание расширений Rubocop и обновления между выпусками Rubocop. Все большие изменения зарезервированы для основных выпусков. Чтобы предотвратить нежелательное обновление Rubocop, вы, возможно, захотите использовать консервативную блокировку версии в своем Gemfile :
gem 'rubocop' , '~> 1.69' , require : falseСмотрите нашу Политику управления версиями для получения более подробной информации.
Просто введите rubocop в папке проекта Ruby и посмотрите, как происходит волшебство.
$ cd my/cool/ruby/project
$ rubocop
Вы также можете использовать эту магию в своем любимом редакторе со встроенным LSP-сервером Rubocop.
Вы можете прочитать гораздо больше о Rubocop в его официальных документах.
Rubocop официально поддерживает следующие реализации Ruby во время выполнения:
Нацеливается на анализ кода Ruby 2.0+.
Смотрите документацию по совместимости для получения более подробной информации.
Если вы используете Rubocop в своем проекте, вы можете включить один из этих значков в свой ReadMe, чтобы люди знали, что ваш код написан после руководства по стилю сообщества.
Вот фрагменты разметки для двух значков:
[ ![ 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. Вы можете найти логотип в различных форматах здесь.
Логотип лицензирован по международной лицензии Creative Commons Attribution-Noncommercial 4.0.
Вот список всех людей, которые внесли свой вклад в развитие Rubocop.
Я очень благодарен каждому из них!
Если вы хотите внести свой вклад в Rubocop, пожалуйста, найдите время, чтобы пройти через наши рекомендации по короткому вкладу.
Преобразование большего количества руководства в стиле Ruby в Rubocop Cops является нашим главным приоритетом прямо сейчас. Написание нового полицейского - отличный способ погрузиться в Rubocop!
Конечно, отчеты об ошибках и предложения для улучшений всегда приветствуются. Запросы на притяжение GitHub еще лучше! :-)
В то время как Rubocop является свободным программным обеспечением и всегда будет, проект получит огромную выгоду от некоторого финансирования. Повышение ежемесячного бюджета в пару тысяч долларов позволило бы платить людям за работу по определенным сложным функциям, финансировать другие вещи, связанные с разработкой (например, оборудование, поездки на конференции) и так далее. Повышение ежемесячного бюджета в размере более 5000 долларов откроет возможность того, что кто-то работает полный рабочий день над проектом, который значительно ускорит темпы развития.
Мы приветствуем как отдельные, так и корпоративные спонсоры! Мы также предлагаем широкий спектр каналов финансирования для учета ваших предпочтений (хотя в настоящее время открытый коллектив является нашей предпочтительной платформой финансирования).
Если вы работаете в компании, которая значительно использует Rubocop, мы бы оценили его, если вы предлагаете вашей компании стать спонсором Rubocop.
Вы можете поддержать разработку Rubocop через спонсоров GitHub, Patreon, PayPal, открытый коллектив и Tidelift.
ПРИМЕЧАНИЕ. Если для вашей компании является спонсорство в виде пожертвований для вашей компании с точки зрения бухгалтерского учета, мы рекомендуем использовать Tidelift, где вы можете получить подписку, подобную поддержке, вместо этого.
Поддержите нас ежемесячным пожертвованием и помогите нам продолжить нашу деятельность. [Станьте покровителем]
Станьте спонсором и получите свой логотип на нашем Readme на GitHub по ссылке на ваш сайт. [Станьте спонсором]
Чанэлог Rubocop доступен здесь.
Copyright (C) 2012-2024 Bozhidar Batsov. См. License.txt для получения дополнительной информации.
