fix: fix toolchains issue and maintainers

longlho · longlho · commit 72ebc09330ec · 2026-01-05T23:34:35.000-05:00
diff --git a/.bcr/metadata.template.json b/.bcr/metadata.template.json
@@ -1,6 +1,12 @@
 {
   "homepage": "https://github.com/formatjs/rules_formatjs",
-  "maintainers": [],
+  "maintainers": [
+    {
+      "email": "long@lho.dev",
+      "github": "longlho",
+      "name": "Long Ho"
+    }
+  ],
   "repository": ["github:formatjs/rules_formatjs"],
   "versions": [],
   "yanked_versions": {}
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -36,5 +36,9 @@ jobs:
     uses: ./.github/workflows/publish.yaml
     with:
       tag_name: ${{ inputs.tag_name || github.ref_name }}
+    permissions:
+      attestations: write
+      contents: write
+      id-token: write
     secrets:
       publish_token: ${{ secrets.publish_token || secrets.BCR_PUBLISH_TOKEN }}
diff --git a/.github/workflows/release_prep.sh b/.github/workflows/release_prep.sh
@@ -33,7 +33,5 @@ cat << EOF
 bazel_dep(name = "rules_formatjs", version = "${TAG:1}")
 \`\`\`
 
+That's it! The toolchains are automatically registered.
 EOF
-
-awk 'f;/--SNIP--/{f=1}' examples/simple/MODULE.bazel
-echo "\`\`\`"
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -52,10 +52,11 @@ formatjs_cli = use_extension("//formatjs_cli:extensions.bzl", "formatjs_cli")
 formatjs_cli.toolchain(version = "0.1.2")
 use_repo(
     formatjs_cli,
+    "formatjs_cli_toolchains",
     "formatjs_cli_toolchains_darwin_arm64",
     "formatjs_cli_toolchains_linux_x64",
 )
 
-register_toolchains("@formatjs_cli_toolchains_darwin_arm64//:toolchain")
-
-register_toolchains("@formatjs_cli_toolchains_linux_x64//:toolchain")
+# Register all toolchains - Bazel will automatically select the appropriate one
+# based on exec_compatible_with constraints
+register_toolchains("@formatjs_cli_toolchains//:all")
diff --git a/MODULE.bazel.lock b/MODULE.bazel.lock
diff --git a/examples/aggregate/MODULE.bazel b/examples/aggregate/MODULE.bazel
@@ -16,4 +16,5 @@ local_path_override(
     path = "../..",
 )
 
+# Test utilities (not required by rules_formatjs users)
 bazel_dep(name = "aspect_bazel_lib", version = "2.22.2")
diff --git a/examples/aggregate/MODULE.bazel.lock b/examples/aggregate/MODULE.bazel.lock
diff --git a/examples/simple/MODULE.bazel b/examples/simple/MODULE.bazel
@@ -11,5 +11,5 @@ local_path_override(
     path = "../..",
 )
 
-# --SNIP-- (Below here is the generated documentation)
+# Test utilities (not required by rules_formatjs users)
 bazel_dep(name = "aspect_bazel_lib", version = "2.22.2")
diff --git a/examples/simple/MODULE.bazel.lock b/examples/simple/MODULE.bazel.lock
diff --git a/formatjs_cli/BUILD.bazel b/formatjs_cli/BUILD.bazel
@@ -9,7 +9,7 @@ toolchain_type(
 alias(
     name = "cli",
     actual = select({
-        "@platforms//os:macos": "@formatjs_cli_toolchains_darwin_arm64//:cli",
+        "@platforms//os:osx": "@formatjs_cli_toolchains_darwin_arm64//:cli",
         "@platforms//os:linux": "@formatjs_cli_toolchains_linux_x64//:cli",
     }),
     visibility = ["//visibility:public"],
diff --git a/formatjs_cli/extensions.bzl b/formatjs_cli/extensions.bzl
@@ -16,27 +16,35 @@ The current default version is defined by `DEFAULT_VERSION`.
 
 ## Usage
 
-In your `MODULE.bazel` file:
+For most users, simply adding `rules_formatjs` as a dependency is sufficient:
 
 ```starlark
-# Use default version (recommended)
-formatjs_cli = use_extension("@rules_formatjs//formatjs_cli:extensions.bzl", "formatjs_cli")
-formatjs_cli.toolchain()
-use_repo(formatjs_cli, "formatjs_cli_toolchains_darwin_arm64", "formatjs_cli_toolchains_linux_x64")
+bazel_dep(name = "rules_formatjs", version = "1.0.0")
+```
 
-# Register the toolchains (required)
-register_toolchains(
-    "@formatjs_cli_toolchains_darwin_arm64//:toolchain",
-    "@formatjs_cli_toolchains_linux_x64//:toolchain",
-)
+The toolchains are automatically registered and Bazel will select the appropriate
+one for your platform.
 
-# Or specify a specific version
-formatjs_cli.toolchain(version = "0.1.2")
+### Advanced: Custom Version Selection
+
+If you need to use a specific FormatJS CLI version different from the default,
+you can configure it with the extension:
+
+```starlark
+formatjs_cli = use_extension("@rules_formatjs//formatjs_cli:extensions.bzl", "formatjs_cli")
+formatjs_cli.toolchain(version = "0.1.1")
+use_repo(
+    formatjs_cli,
+    "formatjs_cli_toolchains",
+    "formatjs_cli_toolchains_darwin_arm64",
+    "formatjs_cli_toolchains_linux_x64",
+)
+register_toolchains("@formatjs_cli_toolchains//:all")
 ```
 
-**Note**: You must explicitly call `register_toolchains()` to make the FormatJS CLI
-toolchains available for toolchain resolution. The extension creates the toolchain
-repositories but does not automatically register them.
+**Note**: This advanced configuration is only needed if you want to override the
+default FormatJS CLI version. In most cases, using the default version provided
+by `rules_formatjs` is recommended.
 """
 
 load(":repositories.bzl", "DEFAULT_VERSION", "formatjs_cli_register_toolchains")
@@ -56,6 +64,7 @@ def _formatjs_cli_toolchain_impl(module_ctx):
 
     return module_ctx.extension_metadata(
         root_module_direct_deps = [
+            "formatjs_cli_toolchains",
             "formatjs_cli_toolchains_darwin_arm64",
             "formatjs_cli_toolchains_linux_x64",
         ],
@@ -103,26 +112,33 @@ formatjs_cli = module_extension(
     - **Multi-Platform**: Automatic platform detection (macOS arm64, Linux x64)
     - **SHA256 Verification**: All binaries are verified with checksums
     - **No Node.js**: Native binaries for maximum performance
+    - **Automatic Registration**: Toolchains are automatically registered when you
+      add `rules_formatjs` as a dependency
+
+    ## Basic Usage
 
-    ## Default Behavior
+    Most users don't need to interact with this extension directly. Simply add
+    `rules_formatjs` as a dependency and the toolchains will be automatically
+    configured:
 
-    When you add `rules_formatjs` to your MODULE.bazel, you need to configure the extension
-    and register the toolchains. The extension defaults to the latest CLI version.
+    ```starlark
+    bazel_dep(name = "rules_formatjs", version = "1.0.0")
+    ```
 
-    ## Custom Version
+    ## Advanced: Custom Version Selection
 
-    To use a specific CLI version:
+    If you need to override the default FormatJS CLI version, use this extension:
 
     ```starlark
     formatjs_cli = use_extension("@rules_formatjs//formatjs_cli:extensions.bzl", "formatjs_cli")
-    formatjs_cli.toolchain(version = "0.1.1")  # Use specific version
-    use_repo(formatjs_cli, "formatjs_cli_toolchains_darwin_arm64", "formatjs_cli_toolchains_linux_x64")
-
-    # Must explicitly register toolchains
-    register_toolchains(
-        "@formatjs_cli_toolchains_darwin_arm64//:toolchain",
-        "@formatjs_cli_toolchains_linux_x64//:toolchain",
+    formatjs_cli.toolchain(version = "0.1.1")
+    use_repo(
+        formatjs_cli,
+        "formatjs_cli_toolchains",
+        "formatjs_cli_toolchains_darwin_arm64",
+        "formatjs_cli_toolchains_linux_x64",
     )
+    register_toolchains("@formatjs_cli_toolchains//:all")
     ```
 
     ## Version History
@@ -133,7 +149,7 @@ formatjs_cli = module_extension(
 
     ## Platform Support
 
-    The extension automatically selects the correct binary for your platform:
+    Bazel's toolchain resolution automatically selects the correct binary for your platform:
     - **macOS Apple Silicon** (M1/M2/M3): darwin-arm64 binary
     - **Linux x86_64**: linux-x64 binary
 
diff --git a/formatjs_cli/repositories.bzl b/formatjs_cli/repositories.bzl
@@ -110,6 +110,51 @@ _formatjs_cli_repo = repository_rule(
     },
 )
 
+def _formatjs_cli_toolchains_repo_impl(rctx):
+    """Implementation for the main toolchains repository that contains toolchain definitions for all platforms."""
+
+    build_content = """# @generated by @rules_formatjs//formatjs_cli:repositories.bzl
+#
+# These can be registered in the workspace file or passed to --extra_toolchains flag.
+# By default all these toolchains are registered by the formatjs_cli extension
+# so you don't normally need to interact with these targets.
+
+"""
+
+    # Add toolchain definitions for each platform
+    for platform_key, platform_info in [
+        ("darwin_arm64", {
+            "exec_compatible_with": ["\"@platforms//os:osx\"", "\"@platforms//cpu:arm64\""],
+        }),
+        ("linux_x64", {
+            "exec_compatible_with": ["\"@platforms//os:linux\"", "\"@platforms//cpu:x86_64\""],
+        }),
+    ]:
+        build_content += """
+toolchain(
+    name = "{platform}_toolchain",
+    exec_compatible_with = [{compatible_with}],
+    toolchain = "@{user_repository_name}_{platform}//:toolchain_impl",
+    toolchain_type = "@rules_formatjs//formatjs_cli:toolchain_type",
+    visibility = ["//visibility:public"],
+)
+""".format(
+            platform = platform_key,
+            user_repository_name = rctx.attr.user_repository_name,
+            compatible_with = ", ".join(platform_info["exec_compatible_with"]),
+        )
+
+    rctx.file("BUILD.bazel", build_content)
+
+_formatjs_cli_toolchains_repo = repository_rule(
+    implementation = _formatjs_cli_toolchains_repo_impl,
+    doc = """Creates a repository with toolchain definitions for all known platforms
+     which can be registered or selected.""",
+    attrs = {
+        "user_repository_name": attr.string(doc = "Base name for toolchains repository"),
+    },
+)
+
 def formatjs_cli_register_toolchains(name, version = DEFAULT_VERSION, register = True):
     """Register FormatJS CLI toolchains for all supported platforms.
 
@@ -125,8 +170,6 @@ def formatjs_cli_register_toolchains(name, version = DEFAULT_VERSION, register =
             FORMATJS_CLI_VERSIONS.keys(),
         ))
 
-    toolchains = []
-
     # macOS Apple Silicon (darwin-arm64)
     if "darwin-arm64" in FORMATJS_CLI_VERSIONS[version]:
         repo_name = "{}_darwin_arm64".format(name)
@@ -140,7 +183,6 @@ def formatjs_cli_register_toolchains(name, version = DEFAULT_VERSION, register =
             ],
             target_compatible_with = [],
         )
-        toolchains.append("@{}//:toolchain".format(repo_name))
 
     # Linux x86_64
     if "linux-x64" in FORMATJS_CLI_VERSIONS[version]:
@@ -155,8 +197,13 @@ def formatjs_cli_register_toolchains(name, version = DEFAULT_VERSION, register =
             ],
             target_compatible_with = [],
         )
-        toolchains.append("@{}//:toolchain".format(repo_name))
+
+    # Create the main toolchains repository with definitions for all platforms
+    _formatjs_cli_toolchains_repo(
+        name = name,
+        user_repository_name = name,
+    )
 
     # Register toolchains
     if register:
-        native.register_toolchains(*toolchains)
+        native.register_toolchains("@{}//...".format(name))

Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,5 @@ local_path_override(`
`16`	`16`	`path = "../..",`
`17`	`17`	`)`
`18`	`18`
	`19`	`+# Test utilities (not required by rules_formatjs users)`
`19`	`20`	`bazel_dep(name = "aspect_bazel_lib", version = "2.22.2")`
Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,5 @@ local_path_override(`
`11`	`11`	`path = "../..",`
`12`	`12`	`)`
`13`	`13`
`14`		`-# --SNIP-- (Below here is the generated documentation)`
	`14`	`+# Test utilities (not required by rules_formatjs users)`
`15`	`15`	`bazel_dep(name = "aspect_bazel_lib", version = "2.22.2")`