(CONT-214) Fix rubocop inheritance #70
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GSPatton
reviewed
Oct 21, 2022
ekohl
reviewed
Oct 21, 2022
Prior to this commit we attempted to configure the puppet-lint gem so
downstream plugin authors could consume rubocops config via the gem.
This mostly worked however there seemed to be an issue when inheriting
`AllCops/Exclude` properties.
tldr; inheriting a config called `.rubocop.yml` doesn't seem to work as
expected.
This commit attempts to solve that by splitting out the main rules for
puppet-lint in to a new file called `rubocop_baseline.yml`. Them,
.rubocop.yml has been configured to inherit from this file.
This means that puppet-lint can continue to operate as normal.
The `gemspec` entry for `.rubocop.yml` has been replaced with
`rubocop_baseline.yml`. This ensures that we are packaging the baselines
config with the puppet-lint gem.
Downstream plugins can then inherit this configuration like this:
```
inherit_gem:
puppet-lint:
- rubocop_baseline.yml
```
This appears to pull in the `AllCops/Exclude` properties as expected.
chelnak
force-pushed
the
CONT-214-rubocop_inheritance
branch
from
b18c3e6
to
092aa48
Compare
ekohl
approved these changes
Jan 12, 2023
|
Sure we can get this sorted soon. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prior to this PR we attempted to configure the puppet-lint gem so downstream plugin authors could consume rubocops config via the gem.
This mostly worked however there seemed to be an issue when inheriting
AllCops/Excludeproperties.This PR attempts to solve that by splitting out the main rules for puppet-lint in to a new file called
rubocop_baseline.yml. Them, .rubocop.yml has been configured to inherit from this file.This means that puppet-lint can continue to operate as normal.
The
gemspecentry for.rubocop.ymlhas been replaced withrubocop_baseline.yml. This ensures that we are packaging the baselines config with the puppet-lint gem.Downstream plugins can then inherit this configuration like this:
This appears to pull in the
AllCops/Excludeproperties as expected.