Skip to content
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.

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

Change step with new_cop command for rubocop-rspec #1891

Merged
merged 1 commit into from
May 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,14 @@ task default: %i[build_config spec
desc 'Generate a new cop template'
task :new_cop, [:cop] do |_task, args|
require 'rubocop'
require_relative 'lib/rubocop/rspec/cop/generator'

cop_name = args.fetch(:cop) do
warn "usage: bundle exec rake 'new_cop[Department/Name]'"
exit!
end

generator = RuboCop::Cop::Generator.new(cop_name)
generator = RuboCop::RSpec::Cop::Generator.new(cop_name)
generator.write_source
generator.write_spec
generator.inject_require(root_file_path: 'lib/rubocop/cop/rspec_cops.rb')
Expand Down
25 changes: 25 additions & 0 deletions lib/rubocop/rspec/cop/generator.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# frozen_string_literal: true

module RuboCop
module RSpec
module Cop
# Source and spec generator for new cops
#
# This generator will take a cop name and generate a source file
# and spec file when given a valid qualified cop name.
# @api private
class Generator < RuboCop::Cop::Generator
def todo
<<~TODO
Do 4 steps:
1. Modify the description of #{badge} in config/default.yml
2. Implement your new cop in the generated file!
3. Add an entry about new cop to CHANGELOG.md
4. Commit your new cop with a message such as
e.g. "Add new `#{badge}` cop"
Copy link
Member

Choose a reason for hiding this comment

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

4 and 3 feel out of order. For our parent project it’s justifiable, they need the pr number in the changelog entry? For us, changelog can be added first if you follow the changelog-driven development approach 😅

Copy link
Member Author

Choose a reason for hiding this comment

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

That's true. Well, I don't think it's going to be a big problem, especially if the order goes back and forth, so I switched 3 and 4.

TODO
end
end
end
end
end