Support macros/rules packed within bazel `struct` #1524

birunts · 2023-05-04T08:46:26Z

What type of PR is this?
Feature

What package or component does this PR mostly affect?
cmd/gazelle

What does this PR do? Why is it needed?
Bazel allows to pack rules or macros within a struct, e.g. convenience interfaces for select()
(see https://github.com/bazelbuild/bazel-skylib/blob/main/lib/selects.bzl)

Changes adds support for macros/rules packed within bazel struct.

Load statements are not able to insert struct symbols. This is needed in case some macros are packaged into a struct like selects.config_setting_group
(see https://github.com/bazelbuild/bazel-skylib/blob/main/lib/selects.bzl#L245).

Any would like to generate selects.config_setting_group rule with rule.LoadInfo:

{
	Name: "@bazel_skylib//lib:selects.bzl",
	Symbols: []string{
		"selects",
	},
},

needs a load statement in BUILD.bazel of:

# GOOD
load("@bazel_skylib//lib:selects.bzl", "selects")

but NOT

# WRONG
load("@bazel_skylib//lib:selects.bzl", "selects.config_setting_group")

Which issues(s) does this PR fix?
Fixes #1523

Other notes for review

fmeum

This looks solid, just left a single comment.

rule/rule.go

This change adds test for handling macros/rules which are packed into the struct e.g.: `selects.config_setting_group`

Bazel allows to pack rules or macros within a struct, e.g. convenience interfaces for `select()` (see https://github.com/bazelbuild/bazel-skylib/blob/main/lib/selects.bzl) Currently Gazelle is not able to recognize of rules which consist of: `struct_name.rule_name` e.g. `selects.config_setting_group`. When such rule is present inside BUILD.bazel file, parsing is not able to recognize it and is simply ignored like it was never present. Thus merging mechanizm won't work for it and duplicated rule will be created (assuming thus rule was creaded before). All above highly prevents of using and creating such rules like `selects.config_setting_group`. This change adds support for recognizing macros packed within struct correctly.

fmeum

This looks solid, just left a single comment.

birunts force-pushed the struct_rules branch 2 times, most recently from c2b442a to 188f5f9 Compare May 5, 2023 13:34

fmeum reviewed May 9, 2023

View reviewed changes

rule/rule.go Outdated Show resolved Hide resolved

birunts added 2 commits May 11, 2023 07:52

test: add tests for struct macros/rules

22a5b3c

This change adds test for handling macros/rules which are packed into the struct e.g.: `selects.config_setting_group`

birunts force-pushed the struct_rules branch from 188f5f9 to b9a7cb5 Compare May 11, 2023 06:44

fmeum approved these changes May 11, 2023

View reviewed changes

fmeum merged commit 55532d5 into bazel-contrib:master May 11, 2023

birunts deleted the struct_rules branch May 18, 2023 12:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support macros/rules packed within bazel `struct` #1524

Support macros/rules packed within bazel `struct` #1524

birunts commented May 4, 2023

fmeum left a comment •

edited

Loading

fmeum left a comment

Support macros/rules packed within bazel struct #1524

Support macros/rules packed within bazel struct #1524

Conversation

birunts commented May 4, 2023

fmeum left a comment • edited Loading

Choose a reason for hiding this comment

fmeum left a comment

Choose a reason for hiding this comment

Support macros/rules packed within bazel `struct` #1524

Support macros/rules packed within bazel `struct` #1524

fmeum left a comment •

edited

Loading