build: integrate Rubocop with the project

jcouball · jcouball · commit a04297d8d656 · 2025-07-02T18:03:31.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,4 @@ Gemfile.lock
 node_modules
 package-lock.json
 ai-prompt.erb
+rubocop-report.json
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,7 @@
+inherit_gem:
+  main_branch_shared_rubocop_config: config/rubocop.yml
+
+AllCops:
+  # Pin this project to Ruby 3.1 in case the shared config above is upgraded to 3.2
+  # or later.
+  TargetRubyVersion: 3.2
diff --git a/Rakefile b/Rakefile
@@ -18,6 +18,16 @@ task :test do
 end
 default_tasks << :test
 
+# Rubocop
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+default_tasks << :rubocop
+
+# YARD
+
 unless RUBY_PLATFORM == 'java' || RUBY_ENGINE == 'truffleruby'
   #
   # YARD documentation for this project can NOT be built with JRuby.
@@ -51,7 +61,7 @@ default_tasks << :build
 task default: default_tasks
 
 desc 'Build and install the git gem and run a sanity check'
-task :'test:gem' => :install do
+task 'test:gem': :install do
   output = `ruby -e "require 'git'; g = Git.open('.'); puts g.log.size"`.chomp
   raise 'Gem test failed' unless $CHILD_STATUS.success?
   raise 'Expected gem test to return an integer' unless output =~ /^\d+$/
diff --git a/git.gemspec b/git.gemspec
@@ -33,9 +33,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rchardet', '~> 1.9'
 
   spec.add_development_dependency 'create_github_release', '~> 2.1'
+  spec.add_development_dependency 'main_branch_shared_rubocop_config', '~> 0.1'
   spec.add_development_dependency 'minitar', '~> 1.0'
   spec.add_development_dependency 'mocha', '~> 2.7'
   spec.add_development_dependency 'rake', '~> 13.2'
+  spec.add_development_dependency 'rubocop', '~> 1.77'
+
   spec.add_development_dependency 'test-unit', '~> 3.6'
 
   unless RUBY_PLATFORM == 'java'
