Default to creating git pre-commit

faqndo97 · Dec 31, 2023 · 5b62b80 · 5b62b80
1 parent e3da4fc
commit 5b62b80
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 2 deletions.
diff --git a/railties/CHANGELOG.md b/railties/CHANGELOG.md
@@ -1,3 +1,7 @@
+*   Add Git pre commiter to by default when rubocop is present
+
+    *faqndo97*
+
 *   Add brakeman gem by default for static analysis of security vulnerabilities. Allow skipping with --skip-brakeman option.
 
     *vipulnsward*

diff --git a/railties/lib/rails/generators/rails/app/app_generator.rb b/railties/lib/rails/generators/rails/app/app_generator.rb
@@ -102,7 +102,7 @@ def app
     end
 
     def bin
-      exclude_pattern = Regexp.union([(/rubocop/ if skip_rubocop?), (/brakeman/ if skip_brakeman?)].compact)
+      exclude_pattern = Regexp.union([(/rubocop|hooks/ if skip_rubocop?), (/brakeman/ if skip_brakeman?)].compact)
       directory "bin", { exclude_pattern: exclude_pattern } do |content|
         "#{shebang}\n" + content
       end

diff --git a/railties/lib/rails/generators/rails/app/templates/bin/hooks/pre-commit.tt b/railties/lib/rails/generators/rails/app/templates/bin/hooks/pre-commit.tt
@@ -0,0 +1 @@
+system("bin/rubocop")
diff --git a/railties/lib/rails/generators/rails/app/templates/bin/setup.tt b/railties/lib/rails/generators/rails/app/templates/bin/setup.tt
@@ -3,6 +3,8 @@ require "fileutils"
 # path to your application root.
 APP_ROOT = File.expand_path("..", __dir__)
 
+HOOKS_PATH = File.expand_path("../bin/hooks", __dir__)
+
 def system!(*args)
   system(*args, exception: true)
 end
@@ -12,7 +14,12 @@ FileUtils.chdir APP_ROOT do
   # This script is idempotent, so that you can run it at any time and get an expectable outcome.
   # Add necessary setup steps to this file.
 
-  puts "== Installing dependencies =="
+<% unless options.skip_rubocop? -%>
+  puts "== Installing Pre Commiter =="
+  system("git config core.hooksPath #{HOOKS_PATH}")
+<% end -%>
+
+  puts "\n== Installing dependencies =="
   system! "gem install bundler --conservative"
   system("bundle check") || system!("bundle install")
 <% if using_node? -%>

diff --git a/railties/test/generators/app_generator_test.rb b/railties/test/generators/app_generator_test.rb
@@ -628,14 +628,19 @@ def test_inclusion_of_a_debugger
 
   def test_inclusion_of_rubocop
     run_generator
+
     assert_gem "rubocop-rails-omakase"
+    assert_file "bin/rubocop"
+    assert_directory "bin/hooks"
+    assert_file ".rubocop.yml"
   end
 
   def test_rubocop_is_skipped_if_required
     run_generator [destination_root, "--skip-rubocop"]
 
     assert_no_gem "rubocop"
     assert_no_file "bin/rubocop"
+    assert_no_directory "bin/hooks"
     assert_no_file ".rubocop.yml"
   end