Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Plug gazelle_cabal.ImportData in Resolve to allow both gazelle extensions to run in the same gazelle_binary #41

Closed
wants to merge 17 commits into from
Closed

Plug gazelle_cabal.ImportData in Resolve to allow both gazelle extensions to run in the same gazelle_binary #41

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
afe761a
Plug gazelle_cabal.ImportData in Resolve to allow both gazelle extens…
GuillaumeGen Oct 6, 2022
ff90217
Add gazelle_cabal as a dependency in the example WORKSPACE
GuillaumeGen Oct 7, 2022
8bdb276
Add gazelle_cabal in the test WORKSPACE
GuillaumeGen Oct 7, 2022
efd78dd
Add json package in stack_snapshot of tests
GuillaumeGen Oct 7, 2022
2894e7a
Please buildifier
GuillaumeGen Oct 7, 2022
f2078a7
Reuse addNonHaskellModuleRule
GuillaumeGen Oct 7, 2022
a94dfc9
Clean r attributes based on newr
GuillaumeGen Oct 7, 2022
ba7e574
Update README
GuillaumeGen Oct 10, 2022
a7d8ffd
Handling of not existing yet BUILD.bazel files and cleaning of non ha…
GuillaumeGen Oct 10, 2022
283dfcf
Add a test
GuillaumeGen Oct 12, 2022
bb8e1c8
Add the bazelrc.local file in the new test folder
GuillaumeGen Oct 12, 2022
6dbbf31
Add Nix stuffs in WORKSPACE
GuillaumeGen Oct 12, 2022
bcf8101
Add RunImports and clean the tests
GuillaumeGen Oct 13, 2022
e02fbbc
Update WORKSPACE
GuillaumeGen Oct 13, 2022
6958aae
Add enrichIx map to generate the dependencies between modules and nar…
GuillaumeGen Oct 17, 2022
12ac604
Add missing setup_deps for ghc_922
GuillaumeGen Oct 17, 2022
8281ff2
Gitignore generated file
GuillaumeGen Oct 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 51 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,36 @@ This [example project][example] shows it in action.
## Configuration

Firstly, setup [gazelle][gazelle] and [rules_haskell][rules_haskell].
Then import `gazelle_haskell_modules`.
Then import `gazelle_cabal` and `gazelle_haskell_modules`.

```python
####################
# Gazelle_cabal
####################

http_archive(
name = "io_tweag_gazelle_cabal",
strip_prefix = "gazelle_cabal-240ad1af8d0d0ca5c3fd3ff7afcdb2f0fe0dbbe2",
urls = ["https://github.com/tweag/gazelle_cabal/archive/240ad1af8d0d0ca5c3fd3ff7afcdb2f0fe0dbbe2.zip"],
)
Copy link
Member

@facundominguez facundominguez Oct 11, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is a unsatisfying that we now have to bring gazelle_cabal even if the user does not intend to use it. But I don't see how to avoid it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree


load("@io_tweag_gazelle_cabal//:defs.bzl", "gazelle_cabal_dependencies")

gazelle_cabal_dependencies()

####################
# Gazelle_haskell_modules
####################

http_archive(
name = "io_tweag_gazelle_haskell_modules",
strip_prefix = "gazelle_haskell_modules-main",
url = "https://github.com/tweag/gazelle_haskell_modules/archive/main.zip",
strip_prefix = "gazelle_haskell_modules-a94dfc9591029aa35a7a62519735d0fe04b0e4fa",
urls = ["https://github.com/tweag/gazelle_haskell_modules/archive/a94dfc9591029aa35a7a62519735d0fe04b0e4fa.zip"],
)

load("@io_tweag_gazelle_haskell_modules//:defs.bzl", "gazelle_haskell_modules_dependencies")

gazelle_haskell_modules_dependencies()
```

Additionally, some Haskell packages are needed to build
Expand All @@ -69,13 +91,11 @@ Additionally, some Haskell packages are needed to build

```python
load("@rules_haskell//haskell:cabal.bzl", "stack_snapshot")
load("@io_tweag_gazelle_haskell_modules//:defs.bzl", "gazelle_haskell_modules_dependencies")
gazelle_haskell_modules_dependencies()

stack_snapshot(
name = "stackage",
packages = [
"hspec",
"json", #keep
],
# Most snapshots of your choice might do
snapshot = "lts-18.28",
Expand Down Expand Up @@ -106,6 +126,31 @@ gazelle_binary(
)
```

### Combining `gazelle_cabal` and `gazelle_haskell_modules`

One can run both extensions in one invocation,
to both update the binary/library/tests rules depending of the changes made to your cabal files,
and generate/update the associated `haskell_module` rules.

To do so, one simply has to declare the `gazelle_binary` as

```python
gazelle_binary(
name = "gazelle_binary",
name = "gazelle_binary",
languages = DEFAULT_LANGUAGES + [
"@io_tweag_gazelle_cabal//gazelle_cabal",
"@io_tweag_gazelle_haskell_modules//gazelle_haskell_modules",
],
)
```

Please note that the order of the language extension is relevant here.
One must first grab the updates from the cabal files using `gazelle_cabal`
and then create/update the associated `haskell_module` rules.
If the order of the extensions is wrong,
the creation/updating of `haskell_modules` will be based on an outdated version of the library/binary/test rules.

### Using GHC version 9.2

Due to a regression in `cabal`, which badly handles relocatable build now,
Expand Down
3 changes: 0 additions & 3 deletions WORKSPACE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,6 @@ gazelle_dependencies()
# Gazelle Cabal
####################

# QUESTION: When the pull request adding the 2 missing library functions in gazelle_cabal is merged,
# should we refer to an explicit commit of gazelle_cabal or to `main`?

http_archive(
name = "io_tweag_gazelle_cabal",
sha256 = "853acd38dc69284c915c0d30fe6e051593bf4e7f900e6be13ef306fc7ffa74c0",
Expand Down
3 changes: 0 additions & 3 deletions example/WORKSPACE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,6 @@ gazelle_dependencies()
# Gazelle Cabal
####################

# QUESTION: When the pull request adding the 2 missing library functions in gazelle_cabal is merged,
# should we refer to an explicit commit of gazelle_cabal or to `main`?

http_archive(
name = "io_tweag_gazelle_cabal",
sha256 = "853acd38dc69284c915c0d30fe6e051593bf4e7f900e6be13ef306fc7ffa74c0",
Expand Down
3 changes: 0 additions & 3 deletions tests/alternative-deps/WORKSPACE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,6 @@ gazelle_dependencies()
# Gazelle Cabal
####################

# QUESTION: When the pull request adding the 2 missing library functions in gazelle_cabal is merged,
# should we refer to an explicit commit of gazelle_cabal or to `main`?

http_archive(
name = "io_tweag_gazelle_cabal",
sha256 = "853acd38dc69284c915c0d30fe6e051593bf4e7f900e6be13ef306fc7ffa74c0",
Expand Down