Skip to content

Commit ad074cb

Browse files
authored
refactor: rename starlark register_configure_extension API to register_orion_plugin (#80)
### Changes are visible to end-users: yes - Searched for relevant documentation and updated as needed: yes - Breaking change (forces users to change their own code or config): no - Suggested release notes appear below: yes The Orion plugin API has been renamed from the legacy aspect-cli `register_configure_extension`+`register_rule_kind` terminology to `orion_extension` and `gazelle_rule_kind`. The legacy methods are DEPRECATED but will remain for backwards compatibility. ### Test plan - Covered by existing test cases - New test cases added
1 parent 1b62c35 commit ad074cb

File tree

43 files changed

+99
-73
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+99
-73
lines changed

language/orion/plugins/bzl.axl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ BZL_LIBRARY = "bzl_library"
33
LANG_NAME = "starlark"
44
BZL_EXT = ".bzl"
55

6-
aspect.register_rule_kind(BZL_LIBRARY, {
6+
aspect.gazelle_rule_kind(BZL_LIBRARY, {
77
"From": "@bazel_skylib//:bzl_library.bzl",
88
"NonEmptyAttrs": ["srcs"],
99
"MergeableAttrs": ["srcs"],
@@ -74,7 +74,7 @@ def declare_targets(ctx):
7474
)
7575
return {}
7676

77-
aspect.register_configure_extension(
77+
aspect.orion_extension(
7878
id = LANG_NAME,
7979
properties = {},
8080
prepare = prepare,

language/orion/plugins/ext.axl.tmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ def is_native(imp):
9696

9797
return False
9898

99-
aspect.register_rule_kind("my_rule", {
99+
aspect.gazelle_rule_kind("my_rule", {
100100
"From": "@my_ruleset//:defs.bzl",
101101
"NonEmptyAttrs": ["srcs"],
102102
"MergeableAttrs": ["srcs"],

language/orion/plugins/kotlin.axl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ PROVIDER_NAME = "kt"
99

1010
LANG_NAME = "kotlin"
1111

12-
aspect.register_rule_kind(KT_JVM_LIBRARY, {
12+
aspect.gazelle_rule_kind(KT_JVM_LIBRARY, {
1313
"From": "@" + RULES_KOTLIN_REPO_NAME + "//kotlin:jvm.bzl",
1414
"NonEmptyAttrs": ["srcs"],
1515
"MergeableAttrs": ["srcs"],
1616
"ResolveAttrs": ["deps"],
1717
})
1818

19-
aspect.register_rule_kind(KT_JVM_BINARY, {
19+
aspect.gazelle_rule_kind(KT_JVM_BINARY, {
2020
"From": "@" + RULES_KOTLIN_REPO_NAME + "//kotlin:jvm.bzl",
2121
"NonEmptyAttrs": ["srcs", "main_class"],
2222
})
@@ -183,7 +183,7 @@ def is_native(imp):
183183

184184
return False
185185

186-
aspect.register_configure_extension(
186+
aspect.orion_extension(
187187
id = LANG_NAME,
188188
properties = {},
189189
prepare = prepare,

language/orion/plugins/maven.axl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def declare_maven_targets(ctx):
3333
),
3434
)
3535

36-
aspect.register_configure_extension(
36+
aspect.orion_extension(
3737
id = "maven",
3838
properties = {
3939
JAVA_MAVEN_INSTALL_FILE: aspect.Property(

language/orion/starzelle/sdk.go

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,18 @@ import (
1515
"go.starlark.net/starlark"
1616
)
1717

18-
func registerConfigureExtension(t *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
18+
func deprecatedRegisterConfigureExtension(t *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
19+
fmt.Printf("DEPRECATED: 'register_configure_extension' is deprecated, please use 'orion_extension' instead.\n")
20+
return registerOrionPlugin(t, b, args, kwargs)
21+
}
22+
23+
func registerOrionPlugin(t *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
1924
var pluginId starlark.String
2025
var properties *starlark.Dict
2126
var prepare, analyze, declare *starlark.Function
2227

2328
err := starlark.UnpackArgs(
24-
"register_configure_extension",
29+
"orion_extension",
2530
args,
2631
kwargs,
2732
"id", &pluginId,
@@ -46,12 +51,18 @@ func registerConfigureExtension(t *starlark.Thread, b *starlark.Builtin, args st
4651
return starlark.None, err
4752
}
4853

49-
func registerRuleKind(t *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
54+
func deprecatedRegisterRuleKind(t *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
55+
fmt.Printf("DEPRECATED: 'register_rule_kind' is deprecated, please use 'gazelle_rule_kind' instead.\n")
56+
57+
return registerGazelleRuleKind(t, b, args, kwargs)
58+
}
59+
60+
func registerGazelleRuleKind(t *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
5061
var kind starlark.String
5162
var attributes *starlark.Dict
5263

5364
err := starlark.UnpackArgs(
54-
"register_rule_kind",
65+
"gazelle_rule_kind",
5566
args,
5667
kwargs,
5768
"name", &kind,
@@ -443,8 +454,10 @@ func newProperty(_ *starlark.Thread, b *starlark.Builtin, args starlark.Tuple, k
443454
var aspectModule = starUtils.CreateModule(
444455
"aspect",
445456
map[string]starUtils.ModuleFunction{
446-
"register_configure_extension": registerConfigureExtension,
447-
"register_rule_kind": registerRuleKind,
457+
"register_configure_extension": deprecatedRegisterConfigureExtension,
458+
"register_rule_kind": deprecatedRegisterRuleKind,
459+
"orion_extension": registerOrionPlugin,
460+
"gazelle_rule_kind": registerGazelleRuleKind,
448461
"AstQuery": newAstQuery,
449462
"RegexQuery": newRegexQuery,
450463
"RawQuery": newRawQuery,

language/orion/tests/starzelle/attr-types/attr-types.axl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
aspect.register_rule_kind("x_lib", {
1+
aspect.gazelle_rule_kind("x_lib", {
22
"From": "@deps-test//my:rules.bzl",
33
"ResolveAttrs": ["deps"],
44
})
@@ -94,7 +94,7 @@ def declare(ctx):
9494
)],
9595
)
9696

97-
aspect.register_configure_extension(
97+
aspect.orion_extension(
9898
id = "attribute-types-test",
9999
declare = declare,
100100
)

language/orion/tests/starzelle/bad_prepareresult/bad-prep.axl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
aspect.register_configure_extension(
1+
aspect.orion_extension(
22
id = "bad_prepareresult-bool",
33
prepare = lambda _ : aspect.PrepareResult(
44
sources = aspect.SourceGlobs(True, 3, [4]),

language/orion/tests/starzelle/builtins/copy-txt.axl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ def declare_targets(ctx):
1616
},
1717
)
1818

19-
aspect.register_configure_extension(
19+
aspect.orion_extension(
2020
id = "copy-txt",
2121
prepare = prepare,
2222
declare = declare_targets,

language/orion/tests/starzelle/builtins/filegroup.axl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ def declare_targets(ctx):
1818
},
1919
)
2020

21-
aspect.register_configure_extension(
21+
aspect.orion_extension(
2222
id = "fgs",
2323
prepare = prepare,
2424
declare = declare_targets,

language/orion/tests/starzelle/deprecated_names/BUILD.in

Whitespace-only changes.

0 commit comments

Comments
 (0)