Skip to content

(MAINT) Add rubocop config to gemspec #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 13, 2022
Merged

(MAINT) Add rubocop config to gemspec #60

merged 1 commit into from
Oct 13, 2022

Conversation

@chelnak
Copy link

@chelnak chelnak commented Oct 13, 2022

This commit adds .rubocop.yml as a required file in the gemspec. This is so that other puppet-lint plugins can inherit a common set of rules.

Ultimately this could make navigating the landscape easier if coding style is simiar.

@chelnak
(MAINT) Add rubocop config to gemspec
336dfc5 
This commit adds .rubocop.yml as a required file in the gemspec. This is
so that other puppet-lint plugins can inherit a common set of rules.

Ultimately this could make navigating the landscape easier if coding
style is simiar.
@chelnak chelnak requested a review from a team as a code owner October 13, 2022 10:20
@chelnak chelnak self-assigned this Oct 13, 2022
@chelnak chelnak mentioned this pull request Oct 13, 2022
Open
@david22swan david22swan merged commit 6fc3d5e into main Oct 13, 2022
@david22swan david22swan deleted the maint-add_rubocop_config_to_gem branch October 13, 2022 10:22
ekohl
ekohl reviewed Oct 13, 2022
View reviewed changes
puppet-lint.gemspec
'.rubocop.yml',
'lib/**/*',
'bin/**/*',
'spec/**/*',
Copy link

@ekohl ekohl Oct 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was already merged, but I'll just leave a note here that this breaks things for plugins. You essentially broke this method:

puppet-lint/lib/puppet-lint/plugins.rb

Lines 26 to 32 in 6fc3d5e

# Public: Load the puppet-lint spec_helper.rb
#
# Returns nothings.
def self.load_spec_helper
gemspec = gemspecs.find { |spec| spec.name == 'puppet-lint' }
load(Pathname.new(gemspec.full_gem_path) + 'spec/spec_helper.rb')
end

Copy link
Author

@chelnak chelnak Oct 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh my bad - must have been on autopilot in vim...

Will restore! Good catch!

Copy link
Author

@chelnak chelnak Oct 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed in #63

Copy link

@ekohl ekohl Oct 13, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll admit I only know this because in Fedora the spec files are part of rubygem-puppet-lint-doc and I had weird failures because I only had rubygem-puppet-lint installed. Took me a while to figure out.

chelnak added a commit that referenced this pull request Oct 13, 2022
@chelnak
(MAINT) Restore spec files in gems
5c71dd1 
This commit corrects a regression caused by the removal of `spec/**/*',`
in the gemspec.

As noted by @ekohl in #60, it would break every plugin due to the
consumption of the spec helpers from puppet-lint.
@chelnak chelnak mentioned this pull request Oct 13, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@david22swan david22swan david22swan approved these changes

+1 more reviewer

@ekohl ekohl ekohl left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@chelnak chelnak

Labels

maintenance

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@chelnak @ekohl @david22swan