brew/Library/Homebrew/dev-cmd/generate-formula-api.rb

# typed: strict
# frozen_string_literal: true

require "abstract_command"
require "fileutils"
require "formula"

module Homebrew
  module DevCmd
    class GenerateFormulaApi < AbstractCommand
      FORMULA_JSON_TEMPLATE = <<~EOS
        ---
        layout: formula_json
        ---
        {{ content }}
      EOS

      cmd_args do
        description <<~EOS
          Generate `homebrew/core` API data files for <#{HOMEBREW_API_WWW}>.
          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

      sig { override.void }
      def run
        tap = CoreTap.instance
        raise TapUnavailableError, tap.name unless tap.installed?

        unless args.dry_run?
          directories = ["_data/formula", "api/formula", "formula", "api/internal/v3"]
          FileUtils.rm_rf directories + ["_data/formula_canonical.json"]
          FileUtils.mkdir_p directories
        end

        Homebrew.with_no_api_env do
          tap_migrations_json = JSON.dump(tap.tap_migrations)
          File.write("api/formula_tap_migrations.json", tap_migrations_json) unless args.dry_run?

          Formulary.enable_factory_cache!
          Formula.generating_hash!

          tap.formula_names.each do |name|
            formula = Formulary.factory(name)
            name = formula.name
            json = JSON.pretty_generate(formula.to_hash_with_variations)
            html_template_name = 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") unless args.dry_run?
        end
      end

      private

      sig { params(title: String).returns(String) }
      def html_template(title)
        <<~EOS
          ---
          title: '#{title}'
          layout: formula
          redirect_from: /formula-linux/#{title}
          ---
          {{ content }}
        EOS
      end
    end
  end
end