SortMacro() should also sort rules by Kind() #1327

tyler-french · 2022-08-29T20:51:45Z

What type of PR is this?

Feature

What package or component does this PR mostly affect?

rule

What does this PR do? Why is it needed?

I agree we should not attempt to sort WORKSPACE. There's often some complicated interdependence between repositories declared there, so the order is important.

Sorting rules declared in macros seems less obvious, but Gazelle probably (already) can't update macros where the order is important, so I think it makes sense to always sort. If it turns out to be a problem, we can add a directive or something later to control it.

As mentioned in a discussion with @linzhp and @jayconrod:

This change also sorts rules by Kind() when running SortMacro() for cases when there are multiple kinds of rules under the same defName

Issues

Adds additional feature improvement to #696

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [bazel_gazelle](https://togithub.com/bazelbuild/bazel-gazelle) | http_archive | minor | `v0.26.0` -> `v0.29.0` | --- ### Release Notes <details> <summary>bazelbuild/bazel-gazelle</summary> ### [`v0.29.0`](https://togithub.com/bazelbuild/bazel-gazelle/releases/tag/v0.29.0) [Compare Source](https://togithub.com/bazelbuild/bazel-gazelle/compare/v0.28.0...v0.29.0) #### What's Changed - bzlmod: Update Publish to BCR app config by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1363 - Fix: Skip default_visibility extension logic if no BUILD.bazel file present by [@dnathe4th](https://togithub.com/dnathe4th) in [bazelbuild/bazel-gazelle#1364 - fix updateStmt makeslice panic by [@pcj](https://togithub.com/pcj) in [bazelbuild/bazel-gazelle#1371 - bzlmod: Add missing `strip_prefix` field to `source.template.json` by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1375 - feat: support common test args in `gazelle_generation_test` by [@cgrindel](https://togithub.com/cgrindel) in [bazelbuild/bazel-gazelle#1377 - Make the new facts pacakge public by [@linzhp](https://togithub.com/linzhp) in [bazelbuild/bazel-gazelle#1378 - fix: add timeout message for `gazelle_generation_test` by [@cgrindel](https://togithub.com/cgrindel) in [bazelbuild/bazel-gazelle#1383 - bzlmod: Add missing repository metadata by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1387 - Replace `cfg = "host"` with `cfg = "exec"` by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1395 - upgrade rules_go to 0.37.0 by [@JamyDev](https://togithub.com/JamyDev) in [bazelbuild/bazel-gazelle#1386 - Fix embed on windows by [@st3veV](https://togithub.com/st3veV) in [bazelbuild/bazel-gazelle#1361 - Update bazel-skylib to 1.3.0. by [@benjaminp](https://togithub.com/benjaminp) in [bazelbuild/bazel-gazelle#1367 - Fix Directives anchor by [@jmthvt](https://togithub.com/jmthvt) in [bazelbuild/bazel-gazelle#1353 - Use `patch` from `@bazel_tools//tools/build_defs/repo` by [@tyler-french](https://togithub.com/tyler-french) in [bazelbuild/bazel-gazelle#1381 - Add link to BenchSci's rules_nodejs_gazelle extension by [@ColinHeathman](https://togithub.com/ColinHeathman) in [bazelbuild/bazel-gazelle#1369 - bzlmod: Skip Go modules available as Bazel modules by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1403 - repo: opportunistically populate RemoteCache from go.mod by [@jayconrod](https://togithub.com/jayconrod) in [bazelbuild/bazel-gazelle#1396 - Fix Gazelle with `--incompatible_disallow_empty_glob` by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1405 - chore: remove experimental warning from bzlmod module by [@alexeagle](https://togithub.com/alexeagle) in [bazelbuild/bazel-gazelle#1406 - chore: add Swift extension to language list by [@cgrindel](https://togithub.com/cgrindel) in [bazelbuild/bazel-gazelle#1412 - Update everything for release prep, add releaser tool by [@dnathe4th](https://togithub.com/dnathe4th) in [bazelbuild/bazel-gazelle#1373 - adding go version and std_package_list to releaser by [@linzhp](https://togithub.com/linzhp) in [bazelbuild/bazel-gazelle#1415 #### New Contributors - [@damingerdai](https://togithub.com/damingerdai) made their first contribution in [bazelbuild/bazel-gazelle#1362 - [@st3veV](https://togithub.com/st3veV) made their first contribution in [bazelbuild/bazel-gazelle#1361 - [@benjaminp](https://togithub.com/benjaminp) made their first contribution in [bazelbuild/bazel-gazelle#1367 - [@jmthvt](https://togithub.com/jmthvt) made their first contribution in [bazelbuild/bazel-gazelle#1353 - [@ColinHeathman](https://togithub.com/ColinHeathman) made their first contribution in [bazelbuild/bazel-gazelle#1369 **Full Changelog**: bazelbuild/bazel-gazelle@v0.28.0...v0.29.0 ### [`v0.28.0`](https://togithub.com/bazelbuild/bazel-gazelle/releases/tag/v0.28.0) [Compare Source](https://togithub.com/bazelbuild/bazel-gazelle/compare/v0.27.0...v0.28.0) #### What's Changed - language/proto: gen_known_imports creates structs instead of function calls by [@eric-skydio](https://togithub.com/eric-skydio) in [bazelbuild/bazel-gazelle#1333 - Add DoneGeneratingRules language hook by [@illicitonion](https://togithub.com/illicitonion) in [bazelbuild/bazel-gazelle#1325 - Allow configuring timeout of generation tests by [@illicitonion](https://togithub.com/illicitonion) in [bazelbuild/bazel-gazelle#1324 - bug: Allow user-specified tags on gazelle rule by [@Helcaraxan](https://togithub.com/Helcaraxan) in [bazelbuild/bazel-gazelle#1308 - Replace \_get_auth with Bazel's read_user_netrc by [@linzhp](https://togithub.com/linzhp) in [bazelbuild/bazel-gazelle#1338 - language/go should consider default_visibility set by OtherGen ([#783](https://togithub.com/bazelbuild/bazel-gazelle/issues/783)) by [@dnathe4th](https://togithub.com/dnathe4th) in [bazelbuild/bazel-gazelle#1341 - fix: pass `visibility` attribute for `gazelle` macro to resulting `sh_binary` by [@cgrindel](https://togithub.com/cgrindel) in [bazelbuild/bazel-gazelle#1340 - Add additional bzlmod requirements to allow grpc protobufs to work by [@shs96c](https://togithub.com/shs96c) in [bazelbuild/bazel-gazelle#1345 - bzlmod: Simplify go_grpc_library support by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1346 - bzlmod: Add support for custom `go_proto_library` compilers by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1348 - Add visibility extension to support recursive default_visibility ([#783](https://togithub.com/bazelbuild/bazel-gazelle/issues/783)) by [@dnathe4th](https://togithub.com/dnathe4th) in [bazelbuild/bazel-gazelle#1343 - Make `gazelle_generation_test` respect out suffix when generating golden files by [@blorente](https://togithub.com/blorente) in [bazelbuild/bazel-gazelle#1352 - Add size argument to `gazelle_generation_test` by [@charlesoconor](https://togithub.com/charlesoconor) in [bazelbuild/bazel-gazelle#1351 #### New Contributors - [@eric-skydio](https://togithub.com/eric-skydio) made their first contribution in [bazelbuild/bazel-gazelle#1333 - [@dnathe4th](https://togithub.com/dnathe4th) made their first contribution in [bazelbuild/bazel-gazelle#1341 - [@cgrindel](https://togithub.com/cgrindel) made their first contribution in [bazelbuild/bazel-gazelle#1340 - [@shs96c](https://togithub.com/shs96c) made their first contribution in [bazelbuild/bazel-gazelle#1345 - [@blorente](https://togithub.com/blorente) made their first contribution in [bazelbuild/bazel-gazelle#1352 - [@charlesoconor](https://togithub.com/charlesoconor) made their first contribution in [bazelbuild/bazel-gazelle#1351 **Full Changelog**: bazelbuild/bazel-gazelle@v0.27.0...v0.28.0 ### [`v0.27.0`](https://togithub.com/bazelbuild/bazel-gazelle/releases/tag/v0.27.0) [Compare Source](https://togithub.com/bazelbuild/bazel-gazelle/compare/v0.26.0...v0.27.0) #### What's Changed - Use repo-relative labels everywhere by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1294 - Fix RST URL errors for rules_jvm by [@qaisjp](https://togithub.com/qaisjp) in [bazelbuild/bazel-gazelle#1296 - bzlmod prototype by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1266 - bzlmod: Do not create a repository with an invalid name by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1304 - language/go: Add support for //go:build tags by [@thempatel](https://togithub.com/thempatel) in [bazelbuild/bazel-gazelle#1243 - Unwrap `go list -m -json` errors correctly by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1301 - Make one more label repo-relative by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1297 - bzlmod: Add go_deps.from_file by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1300 - language: add BaseLang by [@sluongng](https://togithub.com/sluongng) in [bazelbuild/bazel-gazelle#1303 - Allow adding arguments to Rules by [@illicitonion](https://togithub.com/illicitonion) in [bazelbuild/bazel-gazelle#1310 - Register and parse flags before calling Kinds/Loads by [@illicitonion](https://togithub.com/illicitonion) in [bazelbuild/bazel-gazelle#1318 - SortMacro() should also sort the Loads by [@tyler-french](https://togithub.com/tyler-french) in [bazelbuild/bazel-gazelle#1321 - bzlmod: Fix canonical label literal after Bazel change by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1322 - update-repos: don't add repositories declared with gazelle:repository… by [@tyler-french](https://togithub.com/tyler-french) in [bazelbuild/bazel-gazelle#1326 - Look in call args for loadable symbols by [@illicitonion](https://togithub.com/illicitonion) in [bazelbuild/bazel-gazelle#1317 - SortMacro() should also sort rules by Kind() by [@tyler-french](https://togithub.com/tyler-french) in [bazelbuild/bazel-gazelle#1327 - bzlmod: Fix missing .format in go_deps by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1330 - bzlmod: Depend on rules_proto by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1331 #### New Contributors - [@qaisjp](https://togithub.com/qaisjp) made their first contribution in [bazelbuild/bazel-gazelle#1296 **Full Changelog**: bazelbuild/bazel-gazelle@v0.26.0...v0.27.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/kreempuff/rules_unreal_engine).

SortMacro() should also sort rules by kind

58d0d7b

blico merged commit 3df57af into bazelbuild:master Aug 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SortMacro() should also sort rules by Kind() #1327

SortMacro() should also sort rules by Kind() #1327

tyler-french commented Aug 29, 2022 •

edited

Loading

SortMacro() should also sort rules by Kind() #1327

SortMacro() should also sort rules by Kind() #1327

Conversation

tyler-french commented Aug 29, 2022 • edited Loading

tyler-french commented Aug 29, 2022 •

edited

Loading