.bazelci/presubmit.yml

@@ -4,6 +4,9 @@ matrix:
     - ubuntu2204
     - macos
   bazel: [6.x, 7.x]
+  bcr_variant:
+    - tests/bcr/go_work
+    - tests/bcr/go_mod
 tasks:
   ubuntu2204:
     name: Ubuntu 22.04 with WORKSPACE
@@ -39,11 +42,12 @@ tasks:
     name: BCR test module
     platform: ${{ platform }}
     bazel: ${{ bazel }}
-    working_directory: tests/bcr
+    working_directory: ${{ bcr_variant }}
     shell_commands:
     # Regenerate the BUILD files for the test module using Gazelle.
     # Also verify -repo_config are generated correctly in gazelle.bash
     - rm pkg/BUILD.bazel proto/BUILD.bazel
+    - touch pkg/BUILD.bazel proto/BUILD.bazel
     - bazel run //:gazelle -- update pkg proto
     - bazel run //:gazelle -- pkg proto
     build_targets:
@@ -59,7 +63,7 @@ tasks:
     name: BCR test on Windows
     platform: windows
     bazel: ${{ bazel }}
-    working_directory: tests/bcr
+    working_directory: ${{ bcr_variant }}
     shell_commands:
     # Regenerate the BUILD file for the test module using Gazelle.
     # Also verify -repo_config are generated correctly in gazelle.bash

.bcr/presubmit.yml

@@ -1,5 +1,5 @@
 bcr_test_module:
-  module_path: tests/bcr
+  module_path: tests/bcr/go_mod
   matrix:
     platform:
       - debian10

.gitignore

@@ -2,11 +2,11 @@
 /bazel-bin
 /bazel-out
 /bazel-testlogs
-/tests/bcr/bazel-bcr
-/tests/bcr/bazel-bin
-/tests/bcr/bazel-out
-/tests/bcr/bazel-testlogs
-/tests/bcr/MODULE.bazel.lock
+/tests/bcr/*/bazel-go_*
+/tests/bcr/*/bazel-bin
+/tests/bcr/*/bazel-out
+/tests/bcr/*/bazel-testlogs
+/tests/bcr/*/MODULE.bazel.lock
 MODULE.bazel.lock
 .DS_STORE
 .ijwb/

MODULE.bazel

@@ -1,6 +1,6 @@
 module(
     name = "gazelle",
-    version = "0.36.0",
+    version = "0.37.0",
     repo_name = "bazel_gazelle",
 )
 

README.rst

@@ -4,6 +4,7 @@ Gazelle build file generator
 .. All external links are here
 .. _a gazelle extension: https://github.com/bazel-contrib/rules_jvm/tree/main/java/gazelle
 .. _Kotlin Support: https://github.com/aspect-build/aspect-cli/blob/main/gazelle/kotlin/
+.. _JavaScript and TypeScript Support: https://github.com/aspect-build/aspect-cli/blob/main/gazelle/js/
 .. _Architecture of Gazelle: Design.rst
 .. _Repository rules: repository.md
 .. _go_repository: repository.md#go_repository
@@ -43,6 +44,7 @@ Gazelle build file generator
 .. role:: cmd(code)
 .. role:: flag(code)
 .. role:: direc(code)
+.. role:: kbd
 .. role:: param(kbd)
 .. role:: type(emphasis)
 .. role:: value(code)
@@ -104,6 +106,8 @@ Gazelle can generate Bazel BUILD files for many languages:
   generating ``java_library``, ``java_binary``, ``java_test``, and ``java_test_suite`` rules.
 
 * JavaScript / TypeScript
+
+  Aspect provides `JavaScript and TypeScript Support`_ in aspect-cli (also usable separately).
 
   BenchSci's `rules_nodejs_gazelle`_ supports generating `ts_project`, `js_library`, `jest_test`,
   and `web_asset` rules, and is able to support module bundlers like Webpack and Next.js
@@ -112,8 +116,7 @@ Gazelle can generate Bazel BUILD files for many languages:
 * Kotlin
 
   Aspect Build provides some `Kotlin Support`_ in the repo of their aspect-cli (also usable separately).
-  Still under development, please check the README for
-  currently available features.
+  Still under development, please check the README for currently available features.
 
 * Protocol Buffers
 
@@ -135,7 +138,7 @@ Gazelle can generate Bazel BUILD files for many languages:
 
 * Starlark
 
-  `bazel-skylib`_ has an extension for generating ``bzl_library`` rules. See `bazel_skylib//gazelle/bzl`_.
+  `bazel-skylib`_ has an extension for generating ``bzl_library`` rules. See `bazel_skylib/gazelle/bzl`_.
 
 * Swift
 
@@ -584,7 +587,7 @@ The following flags are accepted:
 | :flag:`-cpuprofile filename`                                      | :value:`""`                            |
 +-------------------------------------------------------------------+----------------------------------------+
 | If specified, gazelle uses [runtime/pprof](https://pkg.go.dev/runtime/pprof#StartCPUProfile) to collect    |
-| CPU profiling information from the command and save it to the given file.                                          |
+| CPU profiling information from the command and save it to the given file.                                  |
 |                                                                                                            |
 | By default, this is disabled                                                                               |
 +-------------------------------------------------------------------+----------------------------------------+
@@ -607,6 +610,9 @@ used to add new repository rules or update existing rules to the specified
 version. It can also import repository rules from a ``go.mod`` or a ``go.work``
 file.
 
+WARNING: This command is mainly used for managing external Go dependencies in Bazel's WORKSPACE mode.
+For managing external Go dependencies in Bazel's BzlMod mode, please check: https://github.com/bazelbuild/rules_go/blob/master/docs/go/core/bzlmod.md#external-dependencies
+
 .. code:: bash
 
   # Add or update a repository to latest version by import path
@@ -636,7 +642,7 @@ The following flags are accepted:
 +----------------------------------------------------------------------------------------------------------+----------------------------------------------+
 | Import repositories from a file as `go_repository`_ rules. These rules will be added to the bottom of the WORKSPACE file or merged with existing rules. |
 |                                                                                                                                                         |
-| The lock file format is inferred from the file name. ``go.mod`` and ``go.work` are all supported.                                                       |
+| The lock file format is inferred from the file name. ``go.mod`` and ``go.work`` are all supported.                                                      |
 +----------------------------------------------------------------------------------------------------------+----------------------------------------------+
 | :flag:`-repo_root dir`                                                                                   |                                              |
 +----------------------------------------------------------------------------------------------------------+----------------------------------------------+
@@ -1060,7 +1066,7 @@ parts of build files from being modified. ``# keep`` may be written before
 a rule, before an attribute, or after a string within a list.
 
 ``# keep`` comments might take one of 2 forms; the ``# keep`` literal or a
-description prefixed by ``# keep: ``.
+description prefixed by ``# keep:``.
 
 Example
 ^^^^^^^

cmd/fetch_repo/BUILD.bazel

@@ -3,8 +3,11 @@ load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_library", "go_test")
 go_library(
     name = "fetch_repo_lib",
     srcs = [
+        "copy_tree.go",
         "fetch_repo.go",
+        "go_mod_download.go",
         "module.go",
+        "path.go",
         "vcs.go",
     ],
     importpath = "github.com/bazelbuild/bazel-gazelle/cmd/fetch_repo",
@@ -33,9 +36,12 @@ filegroup(
     testonly = True,
     srcs = [
         "BUILD.bazel",
+        "copy_tree.go",
         "fetch_repo.go",
         "fetch_repo_test.go",
+        "go_mod_download.go",
         "module.go",
+        "path.go",
         "vcs.go",
     ],
     visibility = ["//visibility:public"],

cmd/fetch_repo/copy_tree.go

@@ -0,0 +1,59 @@
+/* Copyright 2019 The Bazel Authors. All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package main
+
+import (
+	"io"
+	"os"
+	"path/filepath"
+)
+
+func copyTree(destRoot, srcRoot string) error {
+	return filepath.Walk(srcRoot, func(src string, info os.FileInfo, e error) (err error) {
+		if e != nil {
+			return e
+		}
+		rel, err := filepath.Rel(srcRoot, src)
+		if err != nil {
+			return err
+		}
+		if rel == "." {
+			return nil
+		}
+		dest := filepath.Join(destRoot, rel)
+
+		if info.IsDir() {
+			return os.Mkdir(dest, 0o777)
+		}
+
+		r, err := os.Open(src)
+		if err != nil {
+			return err
+		}
+		defer r.Close()
+		w, err := os.Create(dest)
+		if err != nil {
+			return err
+		}
+		defer func() {
+			if cerr := w.Close(); err == nil && cerr != nil {
+				err = cerr
+			}
+		}()
+		_, err = io.Copy(w, r)
+		return err
+	})
+}

cmd/fetch_repo/fetch_repo.go

@@ -4,7 +4,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-   http://www.apache.org/licenses/LICENSE-2.0
+  http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -34,6 +34,7 @@ import (
 var (
 	// Common flags
 	importpath = flag.String("importpath", "", "Go importpath to the repository fetch")
+	path       = flag.String("path", "", "absolute or relative path to a local go module")
 	dest       = flag.String("dest", "", "destination directory")
 
 	// Repository flags
@@ -54,17 +55,41 @@ func main() {
 	log.SetPrefix("fetch_repo: ")
 
 	flag.Parse()
-	if *importpath == "" {
-		log.Fatal("-importpath must be set")
+
+	if *importpath == "" && *path == "" {
+		log.Fatal("-importpath or -path must be set")
 	}
+
 	if *dest == "" {
 		log.Fatal("-dest must be set")
 	}
 	if flag.NArg() != 0 {
 		log.Fatal("fetch_repo does not accept positional arguments")
 	}
 
-	if *version != "" {
+	if *path != "" {
+		if *importpath != "" {
+			log.Fatal("-importpath must not be set")
+		}
+		if *remote != "" {
+			log.Fatal("-remote must not be set in module path mode")
+		}
+		if *cmd != "" {
+			log.Fatal("-vcs must not be set in module path mode")
+		}
+		if *rev != "" {
+			log.Fatal("-rev must not be set in module path mode")
+		}
+		if *version != "" {
+			log.Fatal("-version must not be set in module path mode")
+		}
+		if *sum != "" {
+			log.Fatal("-sum must not be set in module path mode")
+		}
+		if err := moduleFromPath(*path, *dest); err != nil {
+			log.Fatal(err)
+		}
+	} else if *version != "" {
 		if *remote != "" {
 			log.Fatal("-remote must not be set in module mode")
 		}

cmd/fetch_repo/go_mod_download.go

@@ -0,0 +1,70 @@
+package main
+
+import (
+	"bytes"
+	"encoding/json"
+	"errors"
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"runtime"
+	"strings"
+)
+
+type GoModDownloadResult struct {
+	Dir   string
+	Sum   string
+	Error string
+}
+
+func findGoPath() string {
+	// Locate the go binary. If GOROOT is set, we'll use that one; otherwise,
+	// we'll use PATH.
+	goPath := "go"
+	if runtime.GOOS == "windows" {
+		goPath += ".exe"
+	}
+	if goroot, ok := os.LookupEnv("GOROOT"); ok {
+		goPath = filepath.Join(goroot, "bin", goPath)
+	}
+	return goPath
+}
+
+func runGoModDownload(dl *GoModDownloadResult, dest string, importpath string, version string) error {
+	buf := bytes.NewBuffer(nil)
+	bufErr := bytes.NewBuffer(nil)
+	cmd := exec.Command(findGoPath(), "mod", "download", "-json", "-modcacherw")
+	cmd.Dir = dest
+
+	if version != "" && importpath != "" {
+		cmd.Args = append(cmd.Args, importpath+"@"+version)
+	}
+
+	cmd.Stdout = buf
+	cmd.Stderr = bufErr
+	dlErr := cmd.Run()
+	if dlErr != nil {
+		if _, ok := dlErr.(*exec.ExitError); !ok {
+			if bufErr.Len() > 0 {
+				return fmt.Errorf("go mod download exec error: %s %q: %s, %w", cmd.Path, strings.Join(cmd.Args, " "), bufErr.String(), dlErr)
+			}
+			return fmt.Errorf("go mod download exec error: %s %s: %v", cmd.Path, strings.Join(cmd.Args, " "), dlErr)
+		}
+	}
+
+	// Parse the JSON output.
+	if err := json.Unmarshal(buf.Bytes(), &dl); err != nil {
+		if bufErr.Len() > 0 {
+			return fmt.Errorf("go mod download output format: `%s %s`: parsing JSON: %q stderr: %q error: %w", cmd.Path, strings.Join(cmd.Args, " "), buf.String(), bufErr.String(), err)
+		}
+		return fmt.Errorf("go mod download output format: `%s %s`: parsing JSON: %q error: %w", cmd.Path, strings.Join(cmd.Args, " "), buf.String(), err)
+	}
+	if dl.Error != "" {
+		return errors.Join(errors.New(dl.Error), dlErr)
+	}
+	if dlErr != nil {
+		return dlErr
+	}
+	return nil
+}