Package gem-chefstyle: Information

Chefstyle - Version Pinned RuboCop with Chef approved Cop list for linting.

This is an internal style guide for chef ruby projects (chef-client, ohai,
mixlib-shellout, mixlib-config, etc).

It is not meant for consumption by cookbooks or for any general purpose uses.
Chef Users and Customers Should Generally Not Use This Tool and Should Use
Cookstyle. It is not intended for any audience outside of chef core ruby
development.

It will conflict with rubocop defaults, cookstyle, finstyle and other ruby
style guides entirely by design. The point is that the core chef authors
vehemently disagree with them on points of style and this point is generally
not up for debate.

It will have many rules that are disabled simply because fixing a project as
large as chef-client would be tedious and have little value. It will have other
rules that are disabled because chef exposes edge conditions that make them
falsely alert. Other rules will be selected based on the biases of the core
chef developers which are often violently at odds with the rubocop core
developers over ruby style.

Pull requests to this repo will not be accepted without corresponding PRs into
at least the chef-client and ohai codebases to clean the code up. PRs will not
be accepted that assume unfunded mandates for other people to finish the work.
Do not open PRs offering opinions or suggestions without offering to do the
work.

The project itself is a derivative of finstyle, but starts with all rules
disabled. The active ruleset is in the config/chefstyle.yml file.

Package gem-chefstyle: Information

Last changed