Add to homebrew package manager for macOS about cascadia HOT 11 CLOSED

Can this issue be closed now?

from cascadia.

Here is my WIP formula, originally created with brew create --go https://github.com/suntong/cascadia/archive/refs/tags/v1.2.6.zip:

# Documentation: https://docs.brew.sh/Formula-Cookbook
#                https://rubydoc.brew.sh/Formula
# PLEASE REMOVE ALL GENERATED COMMENTS BEFORE SUBMITTING YOUR PULL REQUEST!
class Cascadia < Formula
  desc "Go cascadia package command-line CSS selector"
  homepage "https://github.com/suntong/cascadia"
  url "https://github.com/suntong/cascadia/archive/refs/tags/v1.2.6.zip"
  sha256 "d46fd0b91aabab9789c093286dccae564ece9095bf74b6bc92e865364845cfbd"
  license "MIT"
  head "https://github.com/suntong/cascadia.git", branch: "master"

  bottle do
      
  end

  depends_on "go" => :build

  def install
    # ENV.deparallelize  # if your formula fails when building in parallel
    system "go", "build", *std_go_args(ldflags: "-s -w")
  end

  test do
    # `test do` will create, run in and delete a temporary directory.
    #
    # This test will fail and we won't accept that! For Homebrew/homebrew-core
    # this will need to be a test that verifies the functionality of the
    # software. Run the test with `brew test cascadia`. Options passed
    # to `brew install` such as `--HEAD` also need to be provided to `brew test`.
    #
    # The installed folder is not in the path, so use the entire path to any
    # executables being tested: `system "#{bin}/program", "do", "something"`.
    system "false"
  end
end

When running brew install --debug cascadia I get the following error though:

==> go build -ldflags=-s -w
Last 15 lines from /Users/devalias/Library/Logs/Homebrew/cascadia/01.go:
2023-01-08 01:25:31 +0000

go
build
-trimpath
-o=/usr/local/Cellar/cascadia/1.2.6/bin/cascadia
-ldflags=-s -w

go: go.mod file not found in current directory or any parent directory; see 'go help modules'

• https://go.dev/ref/mod#go-mod-file
• https://go.dev/ref/mod#non-module-compat

I created the following issue about the missing go.mod file:

• #13

from cascadia.

According to this StackOverflow, it seems we can work around the missing go.mod file in the interim by setting GO111MODULE=off:

• https://stackoverflow.com/questions/66894200/error-message-go-go-mod-file-not-found-in-current-directory-or-any-parent-dire

Setting that in the above homebrew formula like this:

def install
    ENV['GO111MODULE'] = "off"
    system "go", "build", *std_go_args(ldflags: "-s -w")
  end

Then leads to the following new errors when building with brew install --debug cascadia:

==> go build -ldflags=-s -w
Last 15 lines from /Users/devalias/Library/Logs/Homebrew/cascadia/01.go:
cascadia_main.go:19:2: cannot find package "github.com/PuerkitoBio/goquery" in any of:
	/usr/local/Cellar/go/1.19.4/libexec/src/github.com/PuerkitoBio/goquery (from $GOROOT)
	/Users/devalias/Library/Caches/Homebrew/go_mod_cache/src/github.com/PuerkitoBio/goquery (from $GOPATH)
cascadia_main.go:20:2: cannot find package "github.com/andybalholm/cascadia" in any of:
	/usr/local/Cellar/go/1.19.4/libexec/src/github.com/andybalholm/cascadia (from $GOROOT)
	/Users/devalias/Library/Caches/Homebrew/go_mod_cache/src/github.com/andybalholm/cascadia (from $GOPATH)
cascadia_cliDef.go:13:2: cannot find package "github.com/mkideal/cli" in any of:
	/usr/local/Cellar/go/1.19.4/libexec/src/github.com/mkideal/cli (from $GOROOT)
	/Users/devalias/Library/Caches/Homebrew/go_mod_cache/src/github.com/mkideal/cli (from $GOPATH)
cascadia_cliDef.go:15:2: cannot find package "github.com/mkideal/cli/ext" in any of:
	/usr/local/Cellar/go/1.19.4/libexec/src/github.com/mkideal/cli/ext (from $GOROOT)
	/Users/devalias/Library/Caches/Homebrew/go_mod_cache/src/github.com/mkideal/cli/ext (from $GOPATH)
cascadia_main.go:22:2: cannot find package "golang.org/x/net/html" in any of:
	/usr/local/Cellar/go/1.19.4/libexec/src/golang.org/x/net/html (from $GOROOT)
	/Users/devalias/Library/Caches/Homebrew/go_mod_cache/src/golang.org/x/net/html (from $GOPATH)

Looking at some of the other go-based formulae on Hombrew:

• https://github.com/search?q=repo%3AHomebrew%2Fhomebrew-core+%22depends_on+%5C%22go%5C%22+%3D%3E+%3Abuild%22&type=code
  • https://github.com/Homebrew/homebrew-core/blob/a763982097f6d06e9fe7bf0bd8982d8cf129d878/Formula/gx-go.rb#L4
  • https://github.com/Homebrew/homebrew-core/blob/8b5b1385dfb8d668b852d13f6df9ce8ab42f68ef/Formula/sift.rb#L27-L40

It seems as though we may be able to provide the dependencies using the go_resource syntax..

Though then I found this, which suggests that it's deprecated:

• Homebrew/homebrew-core#21801

from cascadia.

It seems like the go.mod file I created from go mod init github.com/suntong/cascadia + go mod tidy in the following PR makes it work:

• #13 (comment)

As a hacky interim until that gets properly fixed, we can then seemingly change the install block of the formula to this:

def install
    # go mod init/tidy are needed until https://github.com/suntong/cascadia/issues/13 is fixed
    system "go", "mod", "init", "github.com/suntong/cascadia"
    system "go", "mod", "tidy"
    system "go", "build", *std_go_args(ldflags: "-s -w")
  end

from cascadia.

Raised a PR to Homebrew to add this formula:

• Homebrew/homebrew-core#120044

from cascadia.

Yes, GO111MODULE=off is the way I do the build.

I'll hold off turning it on as long as I could, as I personally believe it'll bring more mess to my simple project than doing it good. Huge projects with tons of dependencies is another different story.

As a hacky interim until that gets properly fixed, we can then seemingly change the install block of the formula to this:

Yes, please do. thx.

from cascadia.

I'll hold off turning it on as long as I could, as I personally believe it'll bring more mess to my simple project than doing it good.

To be honest, it's a tiny single file change, and super simplistic; with seemingly a single command required to keep it up to date if you change any dependencies.. i'd recommend maybe just merging the PR where I submitted it and being modern/compliant:

• #13
  • #14

from cascadia.

Looks like the changes from #14 will land in v1.2.7:

• https://github.com/suntong/cascadia/releases/tag/v1.2.7

Updated the PR to submit the homebrew formula to use that version in Homebrew/homebrew-core@b6e643b (#120044)

from cascadia.

Can this issue be closed now?

from cascadia.

Generally speaking it should probably stay open until this PR lands:

• Homebrew/homebrew-core#120044

But as project owner, I guess that's really up to you.

from cascadia.

Yup!

Was merged in: Homebrew/homebrew-core@52e7efb

@0xdevalias @suntong, thanks for your contribution to Homebrew! 🎉 🥇

Without awesome contributors like you, it would be impossible to maintain Homebrew to the high level of quality users have come to expect. Thank you!!!!

Originally posted by @chenrui333 in Homebrew/homebrew-core#120044 (comment)

from cascadia.