gazelle/

directory
v0.0.0-...-18fadf5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 7, 2019 License: Apache-2.0

README

Gazelle BUILD file generator

Setup

For local use, in $GOPATH/src/github.com/bazelbuild/rules_go/go/tools/gazelle/gazelle run go install

Usage

gazelle

Which will fix all build files in the current directory plus subdirectories.

First time use for a project

gazelle -go_prefix $PROJECT

If you don't even have a WORKSPACE file yet, you also need to set -repo_root

Special Markers

  • # keep on an entry to a deps or srcs attribute will instruct gazelle to keep that element even if it thinks otherwise
  • # gazelle:ignore at the top level of a BUILD file will instruct gazelle to leave the file alone.

Known Shortcomings

  • bazel-style auto generating BUILD (where the library name is other than go_default_library)

Directories

Path Synopsis
Command gazelle is a BUILD file generator for Go projects.
Command gazelle is a BUILD file generator for Go projects.
Package generator provides core functionality of BUILD file generation in gazelle.
Package generator provides core functionality of BUILD file generation in gazelle.
Package merger provides methods for merging parsed BUILD files.
Package merger provides methods for merging parsed BUILD files.
Package packages provides Go package traversal in a Bazel repository.
Package packages provides Go package traversal in a Bazel repository.
Package rules provides Bazel rule generation for Go build targets.
Package rules provides Bazel rule generation for Go build targets.
Package wspace provides functions to locate and modify a bazel WORKSPACE file.
Package wspace provides functions to locate and modify a bazel WORKSPACE file.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL