From 358a2ce788ab4c4fdffc5b9f190b641f043086f5 Mon Sep 17 00:00:00 2001
From: apainintheneck <apainintheneck@gmail.com>
Date: Sat, 13 May 2023 14:49:33 -0700
Subject: [PATCH] dev-cmd/generate-*-api: add dry run option

There are two reasons for this:
- Makes it easier to run this command as a sanity check without
  having to create a temporary directory
- Is somewhat faster since you don't have to write thousands of files
---
 Library/Homebrew/dev-cmd/generate-cask-api.rb | 22 ++++++++++++-------
 .../Homebrew/dev-cmd/generate-formula-api.rb  | 22 ++++++++++++-------
 2 files changed, 28 insertions(+), 16 deletions(-)

diff --git a/Library/Homebrew/dev-cmd/generate-cask-api.rb b/Library/Homebrew/dev-cmd/generate-cask-api.rb
index 6d001a287d..a2a48ea8f6 100644
--- a/Library/Homebrew/dev-cmd/generate-cask-api.rb
+++ b/Library/Homebrew/dev-cmd/generate-cask-api.rb
@@ -16,6 +16,8 @@ module Homebrew
         The generated files are written to the current directory.
       EOS
 
+      switch "-n", "--dry-run", description: "Generate API data without writing it to files."
+
       named_args :none
     end
   end
@@ -38,13 +40,15 @@ module Homebrew
   end
 
   def generate_cask_api
-    generate_cask_api_args.parse
+    args = generate_cask_api_args.parse
 
     tap = Tap.default_cask_tap
 
-    directories = ["_data/cask", "api/cask", "api/cask-source", "cask"].freeze
-    FileUtils.rm_rf directories
-    FileUtils.mkdir_p directories
+    unless args.dry_run?
+      directories = ["_data/cask", "api/cask", "api/cask-source", "cask"].freeze
+      FileUtils.rm_rf directories
+      FileUtils.mkdir_p directories
+    end
 
     Cask::Cask.generating_hash!
 
@@ -53,10 +57,12 @@ module Homebrew
       name = cask.token
       json = JSON.pretty_generate(cask.to_hash_with_variations)
 
-      File.write("_data/cask/#{name}.json", "#{json}\n")
-      File.write("api/cask/#{name}.json", CASK_JSON_TEMPLATE)
-      File.write("api/cask-source/#{name}.rb", path.read)
-      File.write("cask/#{name}.html", html_template(name))
+      unless args.dry_run?
+        File.write("_data/cask/#{name}.json", "#{json}\n")
+        File.write("api/cask/#{name}.json", CASK_JSON_TEMPLATE)
+        File.write("api/cask-source/#{name}.rb", path.read)
+        File.write("cask/#{name}.html", html_template(name))
+      end
     rescue
       onoe "Error while generating data for cask '#{path.stem}'."
       raise
diff --git a/Library/Homebrew/dev-cmd/generate-formula-api.rb b/Library/Homebrew/dev-cmd/generate-formula-api.rb
index b5c2aded77..a51b8c4cf6 100644
--- a/Library/Homebrew/dev-cmd/generate-formula-api.rb
+++ b/Library/Homebrew/dev-cmd/generate-formula-api.rb
@@ -16,6 +16,8 @@ module Homebrew
         The generated files are written to the current directory.
       EOS
 
+      switch "-n", "--dry-run", description: "Generate API data without writing it to files."
+
       named_args :none
     end
   end
@@ -39,13 +41,15 @@ module Homebrew
   end
 
   def generate_formula_api
-    generate_formula_api_args.parse
+    args = generate_formula_api_args.parse
 
     tap = CoreTap.instance
 
-    directories = ["_data/formula", "api/formula", "formula"]
-    FileUtils.rm_rf directories + ["_data/formula_canonical.json"]
-    FileUtils.mkdir_p directories
+    unless args.dry_run?
+      directories = ["_data/formula", "api/formula", "formula"]
+      FileUtils.rm_rf directories + ["_data/formula_canonical.json"]
+      FileUtils.mkdir_p directories
+    end
 
     Formulary.enable_factory_cache!
     Formula.generating_hash!
@@ -55,15 +59,17 @@ module Homebrew
       name = formula.name
       json = JSON.pretty_generate(formula.to_hash_with_variations)
 
-      File.write("_data/formula/#{name.tr("+", "_")}.json", "#{json}\n")
-      File.write("api/formula/#{name}.json", FORMULA_JSON_TEMPLATE)
-      File.write("formula/#{name}.html", html_template(name))
+      unless args.dry_run?
+        File.write("_data/formula/#{name.tr("+", "_")}.json", "#{json}\n")
+        File.write("api/formula/#{name}.json", FORMULA_JSON_TEMPLATE)
+        File.write("formula/#{name}.html", html_template(name))
+      end
     rescue
       onoe "Error while generating data for formula '#{name}'."
       raise
     end
 
     canonical_json = JSON.pretty_generate(tap.formula_renames.merge(tap.alias_table))
-    File.write("_data/formula_canonical.json", "#{canonical_json}\n")
+    File.write("_data/formula_canonical.json", "#{canonical_json}\n") unless args.dry_run?
   end
 end