brew/Library/Homebrew/dev-cmd/create.rb

# typed: true
# frozen_string_literal: true

require "formula"
require "formula_creator"
require "missing_formula"
require "cli/parser"
require "utils/pypi"
require "cask/cask_loader"

module Homebrew
  module_function

  sig { returns(CLI::Parser) }
  def create_args
    Homebrew::CLI::Parser.new do
      description <<~EOS
        Generate a formula or, with `--cask`, a cask for the downloadable file at <URL>
        and open it in the editor. Homebrew will attempt to automatically derive the
        formula name and version, but if it fails, you'll have to make your own template.
        The `wget` formula serves as a simple example. For the complete API, see:
        <https://rubydoc.brew.sh/Formula>
      EOS
      switch "--autotools",
             description: "Create a basic template for an Autotools-style build."
      switch "--cask",
             description: "Create a basic template for a cask."
      switch "--cmake",
             description: "Create a basic template for a CMake-style build."
      switch "--crystal",
             description: "Create a basic template for a Crystal build."
      switch "--go",
             description: "Create a basic template for a Go build."
      switch "--meson",
             description: "Create a basic template for a Meson-style build."
      switch "--node",
             description: "Create a basic template for a Node build."
      switch "--perl",
             description: "Create a basic template for a Perl build."
      switch "--python",
             description: "Create a basic template for a Python build."
      switch "--ruby",
             description: "Create a basic template for a Ruby build."
      switch "--rust",
             description: "Create a basic template for a Rust build."
      switch "--no-fetch",
             description: "Homebrew will not download <URL> to the cache and will thus not add its SHA-256 " \
                          "to the formula for you, nor will it check the GitHub API for GitHub projects " \
                          "(to fill out its description and homepage)."
      switch "--HEAD",
             description: "Indicate that <URL> points to the package's repository rather than a file."
      flag   "--set-name=",
             description: "Explicitly set the <name> of the new formula or cask."
      flag   "--set-version=",
             description: "Explicitly set the <version> of the new formula or cask."
      flag   "--set-license=",
             description: "Explicitly set the <license> of the new formula."
      flag   "--tap=",
             description: "Generate the new formula within the given tap, specified as <user>`/`<repo>."
      switch "-f", "--force",
             description: "Ignore errors for disallowed formula names and names that shadow aliases."

      conflicts "--autotools", "--cmake", "--crystal", "--go", "--meson", "--node",
                "--perl", "--python", "--ruby", "--rust", "--cask"
      conflicts "--cask", "--HEAD"
      conflicts "--cask", "--set-license"

      named_args :url, number: 1
    end
  end

  # Create a formula from a tarball URL.
  def create
    args = create_args.parse

    path = if args.cask?
      create_cask(args: args)
    else
      create_formula(args: args)
    end

    exec_editor path
  end

  def create_cask(args:)
    url = args.named.first
    name = if args.set_name.blank?
      stem = Pathname.new(url).stem.rpartition("=").last
      print "Cask name [#{stem}]: "
      __gets || stem
    else
      args.set_name
    end
    token = Cask::Utils.token_from(name)

    cask_tap = Tap.fetch(args.tap || "homebrew/cask")
    raise TapUnavailableError, cask_tap.name unless cask_tap.installed?

    cask_path = cask_tap.new_cask_path(token)
    cask_path.dirname.mkpath unless cask_path.dirname.exist?
    raise Cask::CaskAlreadyCreatedError, token if cask_path.exist?

    version = if args.set_version
      Version.new(args.set_version)
    else
      Version.detect(url.gsub(token, "").gsub(/x86(_64)?/, ""))
    end

    interpolated_url, sha256 = if version.null?
      [url, ""]
    else
      sha256 = if args.no_fetch?
        ""
      else
        strategy = DownloadStrategyDetector.detect(url)
        downloader = strategy.new(url, token, version.to_s, cache: Cask::Cache.path)
        downloader.fetch
        downloader.cached_location.sha256
      end

      [url.gsub(version.to_s, "\#{version}"), sha256]
    end

    cask_path.atomic_write <<~RUBY
      # Documentation: https://docs.brew.sh/Cask-Cookbook
      #                https://docs.brew.sh/Adding-Software-to-Homebrew#cask-stanzas
      # PLEASE REMOVE ALL GENERATED COMMENTS BEFORE SUBMITTING YOUR PULL REQUEST!
      cask "#{token}" do
        version "#{version}"
        sha256 "#{sha256}"

        url "#{interpolated_url}"
        name "#{name}"
        desc ""
        homepage ""

        # Documentation: https://docs.brew.sh/Brew-Livecheck
        livecheck do
          url ""
          strategy ""
        end

        depends_on macos: ""

        app ""

        # Documentation: https://docs.brew.sh/Cask-Cookbook#stanza-zap
        zap trash: ""
      end
    RUBY

    puts "Please run `brew audit --cask --new #{token}` before submitting, thanks."
    cask_path
  end

  def create_formula(args:)
    mode = if args.autotools?
      :autotools
    elsif args.cmake?
      :cmake
    elsif args.crystal?
      :crystal
    elsif args.go?
      :go
    elsif args.meson?
      :meson
    elsif args.node?
      :node
    elsif args.perl?
      :perl
    elsif args.python?
      :python
    elsif args.ruby?
      :ruby
    elsif args.rust?
      :rust
    end

    fc = FormulaCreator.new(
      args.set_name,
      args.set_version,
      tap:     args.tap,
      url:     args.named.first,
      mode:    mode,
      license: args.set_license,
      fetch:   !args.no_fetch?,
      head:    args.HEAD?,
    )
    fc.parse_url
    # ask for confirmation if name wasn't passed explicitly
    if args.set_name.blank?
      print "Formula name [#{fc.name}]: "
      fc.name = __gets || fc.name
    end

    fc.verify

    # Check for disallowed formula, or names that shadow aliases,
    # unless --force is specified.
    unless args.force?
      if (reason = MissingFormula.disallowed_reason(fc.name))
        odie <<~EOS
          The formula '#{fc.name}' is not allowed to be created.
          #{reason}
          If you really want to create this formula use `--force`.
        EOS
      end

      Homebrew.with_no_api_env do
        if Formula.aliases.include? fc.name
          realname = Formulary.canonical_name(fc.name)
          odie <<~EOS
            The formula '#{realname}' is already aliased to '#{fc.name}'.
            Please check that you are not creating a duplicate.
            To force creation use `--force`.
          EOS
        end
      end
    end

    path = fc.write_formula!

    formula = Homebrew.with_no_api_env do
      Formula[fc.name]
    end
    PyPI.update_python_resources! formula, ignore_non_pypi_packages: true if args.python?

    puts "Please run `HOMEBREW_NO_INSTALL_FROM_API=1 brew audit --new #{fc.name}` before submitting, thanks."
    path
  end

  def __gets
    gots = $stdin.gets.chomp
    gots.empty? ? nil : gots
  end
end