feat(gazelle)!: Move the plugin to a separate workspace#972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
f0rmiga merged 1 commit into from
Jan 25, 2023
Merged

feat(gazelle)!: Move the plugin to a separate workspace #972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions .bazelci/presubmit.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
# As a regression test for #225, check that wheel targets still build when
# their package path is qualified with the repo name.
- "@rules_python//examples/wheel/..."
- "-//gazelle/..."
build_flags:
- "--keep_going"
test_targets:
- "--"
- "..."
# The gazelle tests are not compatible with Windows, so we only test them
# on Linux. The build file generation, which uses this Gazelle extension,
# runs on all platforms, and is asserted by the build_file_generation
# integration tests below.
- "-//gazelle/..."
test_flags:
- "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
gazelle_extension:
name: Test the Gazelle extension
platform: ubuntu2004
build_targets: ["//gazelle/..."]
test_targets: ["//gazelle/..."]
build_targets: ["//..."]
test_targets: ["//..."]
working_directory: gazelle
ubuntu:
<<: *reusable_config
name: Default test on Ubuntu
Expand Down
16 changes: 15 additions & 1 deletion .github/workflows/workspace_snippet.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ register_toolchains(
)
\`\`\`

## Using WORKSPACE:
## Using WORKSPACE

Paste this snippet into your \`WORKSPACE\` file:

Expand All@@ -58,4 +58,18 @@ load("@rules_python//python:repositories.bzl", "py_repositories")

py_repositories()
\`\`\`

### Gazelle plugin

Paste this snippet into your \`WORKSPACE\` file:

\`\`\`starlark
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "rules_python_gazelle_plugin",
sha256 = "${SHA}",
strip_prefix = "${PREFIX}/gazelle",
url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/${TAG}.tar.gz",
)
\`\`\`
EOF
5 changes: 0 additions & 5 deletions .gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,5 @@ user.bazelrc
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/
20 changes: 1 addition & 19 deletions BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,10 +31,10 @@ filegroup(
"WORKSPACE",
"internal_deps.bzl",
"internal_setup.bzl",
"//gazelle:distribution",
"//python:distribution",
"//python/pip_install:distribution",
"//tools:distribution",
"@rules_python_gazelle_plugin//:distribution",
],
visibility = [
"//examples:__pkg__",
Expand All@@ -61,23 +60,6 @@ filegroup(
visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
name = "gazelle_update_repos",
args = [
"-from_file=go.mod",
"-to_macro=gazelle/deps.bzl%gazelle_deps",
"-prune",
],
command = "update-repos",
)

genrule(
name = "assert_bazelversion",
srcs = [".bazelversion"],
Expand Down
19 changes: 14 additions & 5 deletions WORKSPACE
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
name = "buildkite_config",
toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
name = "rules_python_gazelle_plugin",
path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()
8 changes: 4 additions & 4 deletions examples/build_file_generation/BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,11 @@
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

compile_pip_requirements(
name = "requirements",
Expand DownExpand Up@@ -53,7 +53,7 @@ gazelle_python_manifest(
gazelle(
name = "gazelle",
data = GAZELLE_PYTHON_RUNTIME_DEPS,
gazelle = "@rules_python//gazelle:gazelle_python_binary",
gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down
18 changes: 17 additions & 1 deletion examples/build_file_generation/WORKSPACE
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,22 @@ local_repository(
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# We import the repository-local rules_python_gazelle_plugin version in order to
# be able to test development changes to the plugin.
local_repository(
name = "rules_python_gazelle_plugin",
path = "../../gazelle",
)

# When loading the gazelle plugin outside this repo, use the http_archive rule as follows:
#
#http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
#)

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")

Expand DownExpand Up@@ -124,7 +140,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down
2 changes: 1 addition & 1 deletion examples/build_file_generation/gazelle_python.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -114,4 +114,4 @@ manifest:
zipp.py310compat: zipp
pip_repository:
name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
integrity: 2c84a3cabeaff134a1d045e5a173a3178086f236ab20f895ffbd7f3b7a6e5bb0
13 changes: 13 additions & 0 deletions gazelle/.bazelrc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks
12 changes: 12 additions & 0 deletions gazelle/.gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out
43 changes: 28 additions & 15 deletions gazelle/BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
alias(
name = "gazelle",
actual = "//gazelle/python",
visibility = ["//visibility:public"],
)
load("@bazel_gazelle//:def.bzl", "gazelle")

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python/gazelle
# gazelle:exclude bazel-out
gazelle(name = "gazelle")

alias(
name = "gazelle_python_binary",
actual = "//gazelle/python:gazelle_binary",
visibility = ["//visibility:public"],
gazelle(
name = "gazelle_update_repos",
args = [
"-from_file=go.mod",
"-to_macro=deps.bzl%gazelle_deps",
"-prune",
],
command = "update-repos",
)

filegroup(
name = "distribution",
srcs = glob(["**"]) + [
"//gazelle/manifest:distribution",
"//gazelle/modules_mapping:distribution",
"//gazelle/python:distribution",
"//gazelle/pythonconfig:distribution",
srcs = [
":BUILD.bazel",
":README.md",
":WORKSPACE",
":def.bzl",
":deps.bzl",
":go.mod",
":go.sum",
"//manifest:distribution",
"//modules_mapping:distribution",
"//python:distribution",
"//pythonconfig:distribution",
],
visibility = ["//:__pkg__"],
visibility = ["@rules_python//:__pkg__"],
)
18 changes: 13 additions & 5 deletions gazelle/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,17 @@ depends on.
Add this to your `WORKSPACE`:

```starlark
http_archive(
name = "rules_python_gazelle_plugin",
sha256 = "",
strip_prefix = "rules_python-0.17.0/gazelle",
url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.17.0.tar.gz",
)

# To compile the rules_python gazelle extension from source,
# we must fetch some third-party go dependencies that it uses.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")

load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

_py_gazelle_deps()
```
Expand All@@ -40,8 +48,8 @@ To keep the metadata updated, put this in your `BUILD.bazel` file next to `gazel

```starlark
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

# This rule fetches the metadata for python packages we depend on. That data is
# required for the gazelle_python_manifest rule to update our manifest file.
Expand DownExpand Up@@ -75,7 +83,7 @@ with the rules_python extension included. This typically goes in your root

```
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")

# Our gazelle target points to the python gazelle binary.
# This is the simple case where we only need one language supported.
Expand All@@ -85,7 +93,7 @@ load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
gazelle(
name = "gazelle",
data = GAZELLE_PYTHON_RUNTIME_DEPS,
gazelle = "@rules_python//gazelle:gazelle_python_binary",
gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)
```

Expand Down
47 changes: 47 additions & 0 deletions gazelle/WORKSPACE
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
workspace(name = "rules_python_gazelle_plugin")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
name = "io_bazel_rules_go",
sha256 = "099a9fb96a376ccbbb7d291ed4ecbdfd42f6bc822ab77ae6f1b5cb9e914e94fa",
urls = [
"https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
"https://github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
],
)

http_archive(
name = "bazel_gazelle",
sha256 = "448e37e0dbf61d6fa8f00aaa12d191745e14f07c31cabfa731f0c8e8a4f41b97",
urls = [
"https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
"https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
],
)

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

go_rules_dependencies()

go_register_toolchains(version = "1.19.4")

gazelle_dependencies()

local_repository(
name = "rules_python",
path = "..",
)

load("@rules_python//python:repositories.bzl", "python_register_toolchains")

python_register_toolchains(
name = "python39",
python_version = "3.9",
)

load("//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# gazelle:repository_macro deps.bzl%gazelle_deps
_py_gazelle_deps()
4 changes: 2 additions & 2 deletions gazelle/def.bzl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,6 @@
"""

GAZELLE_PYTHON_RUNTIME_DEPS = [
"@rules_python//gazelle/python:parse",
"@rules_python//gazelle/python:std_modules",
"@rules_python_gazelle_plugin//python:parse",
"@rules_python_gazelle_plugin//python:std_modules",
]
2 changes: 1 addition & 1 deletion go.mod → gazelle/go.mod
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
module github.com/bazelbuild/rules_python
module github.com/bazelbuild/rules_python/gazelle

go 1.19

Expand Down
0 go.sum → gazelle/go.sum
View file
Open in desktop
File renamed without changes.
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(gazelle)!: Move the plugin to a separate workspace#972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

f0rmiga
merged 1 commit into

from

Jan 25, 2023
 Merged


feat(gazelle)!: Move the plugin to a separate workspace
#972
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

16 changes: 15 additions & 1 deletion
.github/workflows/workspace_snippet.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ register_toolchains(
)
\`\`\`

## Using WORKSPACE:
## Using WORKSPACE

Paste this snippet into your \`WORKSPACE\` file:

Expand All@@ -58,4 +58,18 @@ load("@rules_python//python:repositories.bzl", "py_repositories")

py_repositories()
\`\`\`

### Gazelle plugin

Paste this snippet into your \`WORKSPACE\` file:

\`\`\`starlark
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "${SHA}",
 strip_prefix = "${PREFIX}/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/${TAG}.tar.gz",
)
\`\`\`
EOF

5 changes: 0 additions & 5 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,5 @@ user.bazelrc
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,10 +31,10 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -61,23 +60,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

8 changes: 4 additions & 4 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,11 @@
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

compile_pip_requirements(
 name = "requirements",
Expand DownExpand Up@@ -53,7 +53,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

18 changes: 17 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,22 @@ local_repository(
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# We import the repository-local rules_python_gazelle_plugin version in order to
# be able to test development changes to the plugin.
local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When loading the gazelle plugin outside this repo, use the http_archive rule as follows:
#
#http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
#)

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")

Expand DownExpand Up@@ -124,7 +140,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 1 addition & 1 deletion
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,4 +114,4 @@ manifest:
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
integrity: 2c84a3cabeaff134a1d045e5a173a3178086f236ab20f895ffbd7f3b7a6e5bb0

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

12 changes: 12 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

43 changes: 28 additions & 15 deletions
gazelle/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
alias(
 name = "gazelle",
 actual = "//gazelle/python",
 visibility = ["//visibility:public"],
)
load("@bazel_gazelle//:def.bzl", "gazelle")

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python/gazelle
# gazelle:exclude bazel-out
gazelle(name = "gazelle")

alias(
 name = "gazelle_python_binary",
 actual = "//gazelle/python:gazelle_binary",
 visibility = ["//visibility:public"],
gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

filegroup(
 name = "distribution",
 srcs = glob(["**"]) + [
 "//gazelle/manifest:distribution",
 "//gazelle/modules_mapping:distribution",
 "//gazelle/python:distribution",
 "//gazelle/pythonconfig:distribution",
 srcs = [
 ":BUILD.bazel",
 ":README.md",
 ":WORKSPACE",
 ":def.bzl",
 ":deps.bzl",
 ":go.mod",
 ":go.sum",
 "//manifest:distribution",
 "//modules_mapping:distribution",
 "//python:distribution",
 "//pythonconfig:distribution",
 ],
 visibility = ["//:__pkg__"],
 visibility = ["@rules_python//:__pkg__"],
)

18 changes: 13 additions & 5 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,17 @@ depends on.
Add this to your `WORKSPACE`:

```starlark
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "",
 strip_prefix = "rules_python-0.17.0/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.17.0.tar.gz",
)

# To compile the rules_python gazelle extension from source,
# we must fetch some third-party go dependencies that it uses.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")

load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

_py_gazelle_deps()
```
Expand All@@ -40,8 +48,8 @@ To keep the metadata updated, put this in your `BUILD.bazel` file next to `gazel

```starlark
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

# This rule fetches the metadata for python packages we depend on. That data is
# required for the gazelle_python_manifest rule to update our manifest file.
Expand DownExpand Up@@ -75,7 +83,7 @@ with the rules_python extension included. This typically goes in your root

```
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")

# Our gazelle target points to the python gazelle binary.
# This is the simple case where we only need one language supported.
Expand All@@ -85,7 +93,7 @@ load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)
```

Expand Down

47 changes: 47 additions & 0 deletions
gazelle/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
workspace(name = "rules_python_gazelle_plugin")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
 name = "io_bazel_rules_go",
 sha256 = "099a9fb96a376ccbbb7d291ed4ecbdfd42f6bc822ab77ae6f1b5cb9e914e94fa",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 "https://github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 ],
)

http_archive(
 name = "bazel_gazelle",
 sha256 = "448e37e0dbf61d6fa8f00aaa12d191745e14f07c31cabfa731f0c8e8a4f41b97",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 ],
)

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

go_rules_dependencies()

go_register_toolchains(version = "1.19.4")

gazelle_dependencies()

local_repository(
 name = "rules_python",
 path = "..",
)

load("@rules_python//python:repositories.bzl", "python_register_toolchains")

python_register_toolchains(
 name = "python39",
 python_version = "3.9",
)

load("//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# gazelle:repository_macro deps.bzl%gazelle_deps
_py_gazelle_deps()

4 changes: 2 additions & 2 deletions
gazelle/def.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,6 @@
"""

GAZELLE_PYTHON_RUNTIME_DEPS = [
 "@rules_python//gazelle/python:parse",
 "@rules_python//gazelle/python:std_modules",
 "@rules_python_gazelle_plugin//python:parse",
 "@rules_python_gazelle_plugin//python:std_modules",
]

2 changes: 1 addition & 1 deletion
go.mod → gazelle/go.mod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
module github.com/bazelbuild/rules_python
module github.com/bazelbuild/rules_python/gazelle

go 1.19

Expand Down

0
go.sum → gazelle/go.sum

View file


Open in desktop


File renamed without changes.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(gazelle)!: Move the plugin to a separate workspace#972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

f0rmiga
merged 1 commit into

from

Jan 25, 2023
 Merged


feat(gazelle)!: Move the plugin to a separate workspace
#972
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

16 changes: 15 additions & 1 deletion
.github/workflows/workspace_snippet.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ register_toolchains(
)
\`\`\`

## Using WORKSPACE:
## Using WORKSPACE

Paste this snippet into your \`WORKSPACE\` file:

Expand All@@ -58,4 +58,18 @@ load("@rules_python//python:repositories.bzl", "py_repositories")

py_repositories()
\`\`\`

### Gazelle plugin

Paste this snippet into your \`WORKSPACE\` file:

\`\`\`starlark
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "${SHA}",
 strip_prefix = "${PREFIX}/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/${TAG}.tar.gz",
)
\`\`\`
EOF

5 changes: 0 additions & 5 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,5 @@ user.bazelrc
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,10 +31,10 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -61,23 +60,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

8 changes: 4 additions & 4 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,11 @@
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

compile_pip_requirements(
 name = "requirements",
Expand DownExpand Up@@ -53,7 +53,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

18 changes: 17 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,22 @@ local_repository(
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# We import the repository-local rules_python_gazelle_plugin version in order to
# be able to test development changes to the plugin.
local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When loading the gazelle plugin outside this repo, use the http_archive rule as follows:
#
#http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
#)

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")

Expand DownExpand Up@@ -124,7 +140,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 1 addition & 1 deletion
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,4 +114,4 @@ manifest:
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
integrity: 2c84a3cabeaff134a1d045e5a173a3178086f236ab20f895ffbd7f3b7a6e5bb0

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

12 changes: 12 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

43 changes: 28 additions & 15 deletions
gazelle/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
alias(
 name = "gazelle",
 actual = "//gazelle/python",
 visibility = ["//visibility:public"],
)
load("@bazel_gazelle//:def.bzl", "gazelle")

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python/gazelle
# gazelle:exclude bazel-out
gazelle(name = "gazelle")

alias(
 name = "gazelle_python_binary",
 actual = "//gazelle/python:gazelle_binary",
 visibility = ["//visibility:public"],
gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

filegroup(
 name = "distribution",
 srcs = glob(["**"]) + [
 "//gazelle/manifest:distribution",
 "//gazelle/modules_mapping:distribution",
 "//gazelle/python:distribution",
 "//gazelle/pythonconfig:distribution",
 srcs = [
 ":BUILD.bazel",
 ":README.md",
 ":WORKSPACE",
 ":def.bzl",
 ":deps.bzl",
 ":go.mod",
 ":go.sum",
 "//manifest:distribution",
 "//modules_mapping:distribution",
 "//python:distribution",
 "//pythonconfig:distribution",
 ],
 visibility = ["//:__pkg__"],
 visibility = ["@rules_python//:__pkg__"],
)

18 changes: 13 additions & 5 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,17 @@ depends on.
Add this to your `WORKSPACE`:

```starlark
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "",
 strip_prefix = "rules_python-0.17.0/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.17.0.tar.gz",
)

# To compile the rules_python gazelle extension from source,
# we must fetch some third-party go dependencies that it uses.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")

load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

_py_gazelle_deps()
```
Expand All@@ -40,8 +48,8 @@ To keep the metadata updated, put this in your `BUILD.bazel` file next to `gazel

```starlark
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

# This rule fetches the metadata for python packages we depend on. That data is
# required for the gazelle_python_manifest rule to update our manifest file.
Expand DownExpand Up@@ -75,7 +83,7 @@ with the rules_python extension included. This typically goes in your root

```
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")

# Our gazelle target points to the python gazelle binary.
# This is the simple case where we only need one language supported.
Expand All@@ -85,7 +93,7 @@ load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)
```

Expand Down

47 changes: 47 additions & 0 deletions
gazelle/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
workspace(name = "rules_python_gazelle_plugin")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
 name = "io_bazel_rules_go",
 sha256 = "099a9fb96a376ccbbb7d291ed4ecbdfd42f6bc822ab77ae6f1b5cb9e914e94fa",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 "https://github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 ],
)

http_archive(
 name = "bazel_gazelle",
 sha256 = "448e37e0dbf61d6fa8f00aaa12d191745e14f07c31cabfa731f0c8e8a4f41b97",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 ],
)

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

go_rules_dependencies()

go_register_toolchains(version = "1.19.4")

gazelle_dependencies()

local_repository(
 name = "rules_python",
 path = "..",
)

load("@rules_python//python:repositories.bzl", "python_register_toolchains")

python_register_toolchains(
 name = "python39",
 python_version = "3.9",
)

load("//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# gazelle:repository_macro deps.bzl%gazelle_deps
_py_gazelle_deps()

4 changes: 2 additions & 2 deletions
gazelle/def.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,6 @@
"""

GAZELLE_PYTHON_RUNTIME_DEPS = [
 "@rules_python//gazelle/python:parse",
 "@rules_python//gazelle/python:std_modules",
 "@rules_python_gazelle_plugin//python:parse",
 "@rules_python_gazelle_plugin//python:std_modules",
]

2 changes: 1 addition & 1 deletion
go.mod → gazelle/go.mod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
module github.com/bazelbuild/rules_python
module github.com/bazelbuild/rules_python/gazelle

go 1.19

Expand Down

0
go.sum → gazelle/go.sum

View file


Open in desktop


File renamed without changes.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(gazelle)!: Move the plugin to a separate workspace#972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

f0rmiga
merged 1 commit into

from

Jan 25, 2023
 Merged


feat(gazelle)!: Move the plugin to a separate workspace
#972
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

16 changes: 15 additions & 1 deletion
.github/workflows/workspace_snippet.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ register_toolchains(
)
\`\`\`

## Using WORKSPACE:
## Using WORKSPACE

Paste this snippet into your \`WORKSPACE\` file:

Expand All@@ -58,4 +58,18 @@ load("@rules_python//python:repositories.bzl", "py_repositories")

py_repositories()
\`\`\`

### Gazelle plugin

Paste this snippet into your \`WORKSPACE\` file:

\`\`\`starlark
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "${SHA}",
 strip_prefix = "${PREFIX}/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/${TAG}.tar.gz",
)
\`\`\`
EOF

5 changes: 0 additions & 5 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,5 @@ user.bazelrc
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,10 +31,10 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -61,23 +60,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

8 changes: 4 additions & 4 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,11 @@
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

compile_pip_requirements(
 name = "requirements",
Expand DownExpand Up@@ -53,7 +53,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

18 changes: 17 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,22 @@ local_repository(
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# We import the repository-local rules_python_gazelle_plugin version in order to
# be able to test development changes to the plugin.
local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When loading the gazelle plugin outside this repo, use the http_archive rule as follows:
#
#http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
#)

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")

Expand DownExpand Up@@ -124,7 +140,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 1 addition & 1 deletion
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,4 +114,4 @@ manifest:
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
integrity: 2c84a3cabeaff134a1d045e5a173a3178086f236ab20f895ffbd7f3b7a6e5bb0

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

12 changes: 12 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

43 changes: 28 additions & 15 deletions
gazelle/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
alias(
 name = "gazelle",
 actual = "//gazelle/python",
 visibility = ["//visibility:public"],
)
load("@bazel_gazelle//:def.bzl", "gazelle")

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python/gazelle
# gazelle:exclude bazel-out
gazelle(name = "gazelle")

alias(
 name = "gazelle_python_binary",
 actual = "//gazelle/python:gazelle_binary",
 visibility = ["//visibility:public"],
gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

filegroup(
 name = "distribution",
 srcs = glob(["**"]) + [
 "//gazelle/manifest:distribution",
 "//gazelle/modules_mapping:distribution",
 "//gazelle/python:distribution",
 "//gazelle/pythonconfig:distribution",
 srcs = [
 ":BUILD.bazel",
 ":README.md",
 ":WORKSPACE",
 ":def.bzl",
 ":deps.bzl",
 ":go.mod",
 ":go.sum",
 "//manifest:distribution",
 "//modules_mapping:distribution",
 "//python:distribution",
 "//pythonconfig:distribution",
 ],
 visibility = ["//:__pkg__"],
 visibility = ["@rules_python//:__pkg__"],
)

18 changes: 13 additions & 5 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,17 @@ depends on.
Add this to your `WORKSPACE`:

```starlark
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "",
 strip_prefix = "rules_python-0.17.0/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.17.0.tar.gz",
)

# To compile the rules_python gazelle extension from source,
# we must fetch some third-party go dependencies that it uses.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")

load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

_py_gazelle_deps()
```
Expand All@@ -40,8 +48,8 @@ To keep the metadata updated, put this in your `BUILD.bazel` file next to `gazel

```starlark
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

# This rule fetches the metadata for python packages we depend on. That data is
# required for the gazelle_python_manifest rule to update our manifest file.
Expand DownExpand Up@@ -75,7 +83,7 @@ with the rules_python extension included. This typically goes in your root

```
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")

# Our gazelle target points to the python gazelle binary.
# This is the simple case where we only need one language supported.
Expand All@@ -85,7 +93,7 @@ load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)
```

Expand Down

47 changes: 47 additions & 0 deletions
gazelle/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
workspace(name = "rules_python_gazelle_plugin")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
 name = "io_bazel_rules_go",
 sha256 = "099a9fb96a376ccbbb7d291ed4ecbdfd42f6bc822ab77ae6f1b5cb9e914e94fa",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 "https://github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 ],
)

http_archive(
 name = "bazel_gazelle",
 sha256 = "448e37e0dbf61d6fa8f00aaa12d191745e14f07c31cabfa731f0c8e8a4f41b97",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 ],
)

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

go_rules_dependencies()

go_register_toolchains(version = "1.19.4")

gazelle_dependencies()

local_repository(
 name = "rules_python",
 path = "..",
)

load("@rules_python//python:repositories.bzl", "python_register_toolchains")

python_register_toolchains(
 name = "python39",
 python_version = "3.9",
)

load("//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# gazelle:repository_macro deps.bzl%gazelle_deps
_py_gazelle_deps()

4 changes: 2 additions & 2 deletions
gazelle/def.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,6 @@
"""

GAZELLE_PYTHON_RUNTIME_DEPS = [
 "@rules_python//gazelle/python:parse",
 "@rules_python//gazelle/python:std_modules",
 "@rules_python_gazelle_plugin//python:parse",
 "@rules_python_gazelle_plugin//python:std_modules",
]

2 changes: 1 addition & 1 deletion
go.mod → gazelle/go.mod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
module github.com/bazelbuild/rules_python
module github.com/bazelbuild/rules_python/gazelle

go 1.19

Expand Down

0
go.sum → gazelle/go.sum

View file


Open in desktop


File renamed without changes.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(gazelle)!: Move the plugin to a separate workspace#972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

f0rmiga
merged 1 commit into

from

Jan 25, 2023
 Merged


feat(gazelle)!: Move the plugin to a separate workspace
#972
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

16 changes: 15 additions & 1 deletion
.github/workflows/workspace_snippet.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ register_toolchains(
)
\`\`\`

## Using WORKSPACE:
## Using WORKSPACE

Paste this snippet into your \`WORKSPACE\` file:

Expand All@@ -58,4 +58,18 @@ load("@rules_python//python:repositories.bzl", "py_repositories")

py_repositories()
\`\`\`

### Gazelle plugin

Paste this snippet into your \`WORKSPACE\` file:

\`\`\`starlark
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "${SHA}",
 strip_prefix = "${PREFIX}/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/${TAG}.tar.gz",
)
\`\`\`
EOF

5 changes: 0 additions & 5 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,5 @@ user.bazelrc
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,10 +31,10 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -61,23 +60,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

8 changes: 4 additions & 4 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,11 @@
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

compile_pip_requirements(
 name = "requirements",
Expand DownExpand Up@@ -53,7 +53,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

18 changes: 17 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,22 @@ local_repository(
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# We import the repository-local rules_python_gazelle_plugin version in order to
# be able to test development changes to the plugin.
local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When loading the gazelle plugin outside this repo, use the http_archive rule as follows:
#
#http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
#)

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")

Expand DownExpand Up@@ -124,7 +140,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 1 addition & 1 deletion
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,4 +114,4 @@ manifest:
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
integrity: 2c84a3cabeaff134a1d045e5a173a3178086f236ab20f895ffbd7f3b7a6e5bb0

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

12 changes: 12 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

43 changes: 28 additions & 15 deletions
gazelle/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
alias(
 name = "gazelle",
 actual = "//gazelle/python",
 visibility = ["//visibility:public"],
)
load("@bazel_gazelle//:def.bzl", "gazelle")

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python/gazelle
# gazelle:exclude bazel-out
gazelle(name = "gazelle")

alias(
 name = "gazelle_python_binary",
 actual = "//gazelle/python:gazelle_binary",
 visibility = ["//visibility:public"],
gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

filegroup(
 name = "distribution",
 srcs = glob(["**"]) + [
 "//gazelle/manifest:distribution",
 "//gazelle/modules_mapping:distribution",
 "//gazelle/python:distribution",
 "//gazelle/pythonconfig:distribution",
 srcs = [
 ":BUILD.bazel",
 ":README.md",
 ":WORKSPACE",
 ":def.bzl",
 ":deps.bzl",
 ":go.mod",
 ":go.sum",
 "//manifest:distribution",
 "//modules_mapping:distribution",
 "//python:distribution",
 "//pythonconfig:distribution",
 ],
 visibility = ["//:__pkg__"],
 visibility = ["@rules_python//:__pkg__"],
)

18 changes: 13 additions & 5 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,17 @@ depends on.
Add this to your `WORKSPACE`:

```starlark
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "",
 strip_prefix = "rules_python-0.17.0/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.17.0.tar.gz",
)

# To compile the rules_python gazelle extension from source,
# we must fetch some third-party go dependencies that it uses.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")

load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

_py_gazelle_deps()
```
Expand All@@ -40,8 +48,8 @@ To keep the metadata updated, put this in your `BUILD.bazel` file next to `gazel

```starlark
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

# This rule fetches the metadata for python packages we depend on. That data is
# required for the gazelle_python_manifest rule to update our manifest file.
Expand DownExpand Up@@ -75,7 +83,7 @@ with the rules_python extension included. This typically goes in your root

```
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")

# Our gazelle target points to the python gazelle binary.
# This is the simple case where we only need one language supported.
Expand All@@ -85,7 +93,7 @@ load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)
```

Expand Down

47 changes: 47 additions & 0 deletions
gazelle/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
workspace(name = "rules_python_gazelle_plugin")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
 name = "io_bazel_rules_go",
 sha256 = "099a9fb96a376ccbbb7d291ed4ecbdfd42f6bc822ab77ae6f1b5cb9e914e94fa",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 "https://github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 ],
)

http_archive(
 name = "bazel_gazelle",
 sha256 = "448e37e0dbf61d6fa8f00aaa12d191745e14f07c31cabfa731f0c8e8a4f41b97",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 ],
)

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

go_rules_dependencies()

go_register_toolchains(version = "1.19.4")

gazelle_dependencies()

local_repository(
 name = "rules_python",
 path = "..",
)

load("@rules_python//python:repositories.bzl", "python_register_toolchains")

python_register_toolchains(
 name = "python39",
 python_version = "3.9",
)

load("//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# gazelle:repository_macro deps.bzl%gazelle_deps
_py_gazelle_deps()

4 changes: 2 additions & 2 deletions
gazelle/def.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,6 @@
"""

GAZELLE_PYTHON_RUNTIME_DEPS = [
 "@rules_python//gazelle/python:parse",
 "@rules_python//gazelle/python:std_modules",
 "@rules_python_gazelle_plugin//python:parse",
 "@rules_python_gazelle_plugin//python:std_modules",
]

2 changes: 1 addition & 1 deletion
go.mod → gazelle/go.mod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
module github.com/bazelbuild/rules_python
module github.com/bazelbuild/rules_python/gazelle

go 1.19

Expand Down

0
go.sum → gazelle/go.sum

View file


Open in desktop


File renamed without changes.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(gazelle)!: Move the plugin to a separate workspace#972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

f0rmiga
merged 1 commit into

from

Jan 25, 2023
 Merged


feat(gazelle)!: Move the plugin to a separate workspace
#972
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

16 changes: 15 additions & 1 deletion
.github/workflows/workspace_snippet.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ register_toolchains(
)
\`\`\`

## Using WORKSPACE:
## Using WORKSPACE

Paste this snippet into your \`WORKSPACE\` file:

Expand All@@ -58,4 +58,18 @@ load("@rules_python//python:repositories.bzl", "py_repositories")

py_repositories()
\`\`\`

### Gazelle plugin

Paste this snippet into your \`WORKSPACE\` file:

\`\`\`starlark
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "${SHA}",
 strip_prefix = "${PREFIX}/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/${TAG}.tar.gz",
)
\`\`\`
EOF

5 changes: 0 additions & 5 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,5 @@ user.bazelrc
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,10 +31,10 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -61,23 +60,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

8 changes: 4 additions & 4 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,11 @@
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

compile_pip_requirements(
 name = "requirements",
Expand DownExpand Up@@ -53,7 +53,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

18 changes: 17 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,22 @@ local_repository(
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# We import the repository-local rules_python_gazelle_plugin version in order to
# be able to test development changes to the plugin.
local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When loading the gazelle plugin outside this repo, use the http_archive rule as follows:
#
#http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
#)

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")

Expand DownExpand Up@@ -124,7 +140,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 1 addition & 1 deletion
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,4 +114,4 @@ manifest:
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
integrity: 2c84a3cabeaff134a1d045e5a173a3178086f236ab20f895ffbd7f3b7a6e5bb0

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

12 changes: 12 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

43 changes: 28 additions & 15 deletions
gazelle/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
alias(
 name = "gazelle",
 actual = "//gazelle/python",
 visibility = ["//visibility:public"],
)
load("@bazel_gazelle//:def.bzl", "gazelle")

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python/gazelle
# gazelle:exclude bazel-out
gazelle(name = "gazelle")

alias(
 name = "gazelle_python_binary",
 actual = "//gazelle/python:gazelle_binary",
 visibility = ["//visibility:public"],
gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

filegroup(
 name = "distribution",
 srcs = glob(["**"]) + [
 "//gazelle/manifest:distribution",
 "//gazelle/modules_mapping:distribution",
 "//gazelle/python:distribution",
 "//gazelle/pythonconfig:distribution",
 srcs = [
 ":BUILD.bazel",
 ":README.md",
 ":WORKSPACE",
 ":def.bzl",
 ":deps.bzl",
 ":go.mod",
 ":go.sum",
 "//manifest:distribution",
 "//modules_mapping:distribution",
 "//python:distribution",
 "//pythonconfig:distribution",
 ],
 visibility = ["//:__pkg__"],
 visibility = ["@rules_python//:__pkg__"],
)

18 changes: 13 additions & 5 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,17 @@ depends on.
Add this to your `WORKSPACE`:

```starlark
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "",
 strip_prefix = "rules_python-0.17.0/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.17.0.tar.gz",
)

# To compile the rules_python gazelle extension from source,
# we must fetch some third-party go dependencies that it uses.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")

load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

_py_gazelle_deps()
```
Expand All@@ -40,8 +48,8 @@ To keep the metadata updated, put this in your `BUILD.bazel` file next to `gazel

```starlark
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

# This rule fetches the metadata for python packages we depend on. That data is
# required for the gazelle_python_manifest rule to update our manifest file.
Expand DownExpand Up@@ -75,7 +83,7 @@ with the rules_python extension included. This typically goes in your root

```
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")

# Our gazelle target points to the python gazelle binary.
# This is the simple case where we only need one language supported.
Expand All@@ -85,7 +93,7 @@ load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)
```

Expand Down

47 changes: 47 additions & 0 deletions
gazelle/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
workspace(name = "rules_python_gazelle_plugin")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
 name = "io_bazel_rules_go",
 sha256 = "099a9fb96a376ccbbb7d291ed4ecbdfd42f6bc822ab77ae6f1b5cb9e914e94fa",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 "https://github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 ],
)

http_archive(
 name = "bazel_gazelle",
 sha256 = "448e37e0dbf61d6fa8f00aaa12d191745e14f07c31cabfa731f0c8e8a4f41b97",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 ],
)

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

go_rules_dependencies()

go_register_toolchains(version = "1.19.4")

gazelle_dependencies()

local_repository(
 name = "rules_python",
 path = "..",
)

load("@rules_python//python:repositories.bzl", "python_register_toolchains")

python_register_toolchains(
 name = "python39",
 python_version = "3.9",
)

load("//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# gazelle:repository_macro deps.bzl%gazelle_deps
_py_gazelle_deps()

4 changes: 2 additions & 2 deletions
gazelle/def.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,6 @@
"""

GAZELLE_PYTHON_RUNTIME_DEPS = [
 "@rules_python//gazelle/python:parse",
 "@rules_python//gazelle/python:std_modules",
 "@rules_python_gazelle_plugin//python:parse",
 "@rules_python_gazelle_plugin//python:std_modules",
]

2 changes: 1 addition & 1 deletion
go.mod → gazelle/go.mod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
module github.com/bazelbuild/rules_python
module github.com/bazelbuild/rules_python/gazelle

go 1.19

Expand Down

0
go.sum → gazelle/go.sum

View file


Open in desktop


File renamed without changes.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(gazelle)!: Move the plugin to a separate workspace#972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

f0rmiga
merged 1 commit into

from

Jan 25, 2023
 Merged


feat(gazelle)!: Move the plugin to a separate workspace
#972
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

16 changes: 15 additions & 1 deletion
.github/workflows/workspace_snippet.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ register_toolchains(
)
\`\`\`

## Using WORKSPACE:
## Using WORKSPACE

Paste this snippet into your \`WORKSPACE\` file:

Expand All@@ -58,4 +58,18 @@ load("@rules_python//python:repositories.bzl", "py_repositories")

py_repositories()
\`\`\`

### Gazelle plugin

Paste this snippet into your \`WORKSPACE\` file:

\`\`\`starlark
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "${SHA}",
 strip_prefix = "${PREFIX}/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/${TAG}.tar.gz",
)
\`\`\`
EOF

5 changes: 0 additions & 5 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,5 @@ user.bazelrc
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,10 +31,10 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -61,23 +60,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

8 changes: 4 additions & 4 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,11 @@
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

compile_pip_requirements(
 name = "requirements",
Expand DownExpand Up@@ -53,7 +53,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

18 changes: 17 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,22 @@ local_repository(
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# We import the repository-local rules_python_gazelle_plugin version in order to
# be able to test development changes to the plugin.
local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When loading the gazelle plugin outside this repo, use the http_archive rule as follows:
#
#http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
#)

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")

Expand DownExpand Up@@ -124,7 +140,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 1 addition & 1 deletion
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,4 +114,4 @@ manifest:
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
integrity: 2c84a3cabeaff134a1d045e5a173a3178086f236ab20f895ffbd7f3b7a6e5bb0

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

12 changes: 12 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

43 changes: 28 additions & 15 deletions
gazelle/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
alias(
 name = "gazelle",
 actual = "//gazelle/python",
 visibility = ["//visibility:public"],
)
load("@bazel_gazelle//:def.bzl", "gazelle")

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python/gazelle
# gazelle:exclude bazel-out
gazelle(name = "gazelle")

alias(
 name = "gazelle_python_binary",
 actual = "//gazelle/python:gazelle_binary",
 visibility = ["//visibility:public"],
gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

filegroup(
 name = "distribution",
 srcs = glob(["**"]) + [
 "//gazelle/manifest:distribution",
 "//gazelle/modules_mapping:distribution",
 "//gazelle/python:distribution",
 "//gazelle/pythonconfig:distribution",
 srcs = [
 ":BUILD.bazel",
 ":README.md",
 ":WORKSPACE",
 ":def.bzl",
 ":deps.bzl",
 ":go.mod",
 ":go.sum",
 "//manifest:distribution",
 "//modules_mapping:distribution",
 "//python:distribution",
 "//pythonconfig:distribution",
 ],
 visibility = ["//:__pkg__"],
 visibility = ["@rules_python//:__pkg__"],
)

18 changes: 13 additions & 5 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,17 @@ depends on.
Add this to your `WORKSPACE`:

```starlark
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "",
 strip_prefix = "rules_python-0.17.0/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.17.0.tar.gz",
)

# To compile the rules_python gazelle extension from source,
# we must fetch some third-party go dependencies that it uses.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")

load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

_py_gazelle_deps()
```
Expand All@@ -40,8 +48,8 @@ To keep the metadata updated, put this in your `BUILD.bazel` file next to `gazel

```starlark
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

# This rule fetches the metadata for python packages we depend on. That data is
# required for the gazelle_python_manifest rule to update our manifest file.
Expand DownExpand Up@@ -75,7 +83,7 @@ with the rules_python extension included. This typically goes in your root

```
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")

# Our gazelle target points to the python gazelle binary.
# This is the simple case where we only need one language supported.
Expand All@@ -85,7 +93,7 @@ load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)
```

Expand Down

47 changes: 47 additions & 0 deletions
gazelle/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
workspace(name = "rules_python_gazelle_plugin")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
 name = "io_bazel_rules_go",
 sha256 = "099a9fb96a376ccbbb7d291ed4ecbdfd42f6bc822ab77ae6f1b5cb9e914e94fa",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 "https://github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 ],
)

http_archive(
 name = "bazel_gazelle",
 sha256 = "448e37e0dbf61d6fa8f00aaa12d191745e14f07c31cabfa731f0c8e8a4f41b97",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 ],
)

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

go_rules_dependencies()

go_register_toolchains(version = "1.19.4")

gazelle_dependencies()

local_repository(
 name = "rules_python",
 path = "..",
)

load("@rules_python//python:repositories.bzl", "python_register_toolchains")

python_register_toolchains(
 name = "python39",
 python_version = "3.9",
)

load("//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# gazelle:repository_macro deps.bzl%gazelle_deps
_py_gazelle_deps()

4 changes: 2 additions & 2 deletions
gazelle/def.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,6 @@
"""

GAZELLE_PYTHON_RUNTIME_DEPS = [
 "@rules_python//gazelle/python:parse",
 "@rules_python//gazelle/python:std_modules",
 "@rules_python_gazelle_plugin//python:parse",
 "@rules_python_gazelle_plugin//python:std_modules",
]

2 changes: 1 addition & 1 deletion
go.mod → gazelle/go.mod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
module github.com/bazelbuild/rules_python
module github.com/bazelbuild/rules_python/gazelle

go 1.19

Expand Down

0
go.sum → gazelle/go.sum

View file


Open in desktop


File renamed without changes.

Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(gazelle)!: Move the plugin to a separate workspace#972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

f0rmiga
merged 1 commit into

from

Jan 25, 2023
 Merged


feat(gazelle)!: Move the plugin to a separate workspace
#972
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 3 additions & 8 deletions
.bazelci/presubmit.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,17 +10,11 @@ buildifier:
 # As a regression test for #225, check that wheel targets still build when
 # their package path is qualified with the repo name.
 - "@rules_python//examples/wheel/..."
 - "-//gazelle/..."
 build_flags:
 - "--keep_going"
 test_targets:
 - "--"
 - "..."
 # The gazelle tests are not compatible with Windows, so we only test them
 # on Linux. The build file generation, which uses this Gazelle extension,
 # runs on all platforms, and is asserted by the build_file_generation
 # integration tests below.
 - "-//gazelle/..."
 test_flags:
 - "--test_tag_filters=-integration-test"
.reusable_build_test_all: &reusable_build_test_all
Expand All@@ -30,8 +24,9 @@ tasks:
 gazelle_extension:
 name: Test the Gazelle extension
 platform: ubuntu2004
 build_targets: ["//gazelle/..."]
 test_targets: ["//gazelle/..."]
 build_targets: ["//..."]
 test_targets: ["//..."]
 working_directory: gazelle
 ubuntu:
 <<: *reusable_config
 name: Default test on Ubuntu
Expand Down

16 changes: 15 additions & 1 deletion
.github/workflows/workspace_snippet.sh

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ register_toolchains(
)
\`\`\`

## Using WORKSPACE:
## Using WORKSPACE

Paste this snippet into your \`WORKSPACE\` file:

Expand All@@ -58,4 +58,18 @@ load("@rules_python//python:repositories.bzl", "py_repositories")

py_repositories()
\`\`\`

### Gazelle plugin

Paste this snippet into your \`WORKSPACE\` file:

\`\`\`starlark
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "${SHA}",
 strip_prefix = "${PREFIX}/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/${TAG}.tar.gz",
)
\`\`\`
EOF

5 changes: 0 additions & 5 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -43,10 +43,5 @@ user.bazelrc
*.swp
*.swo

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

# Python cache
**/__pycache__/

20 changes: 1 addition & 19 deletions
BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,7 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_gazelle//:def.bzl", "gazelle")
load(":version.bzl", "BAZEL_VERSION")

package(default_visibility = ["//visibility:public"])
Expand All@@ -32,10 +31,10 @@ filegroup(
 "WORKSPACE",
 "internal_deps.bzl",
 "internal_setup.bzl",
 "//gazelle:distribution",
 "//python:distribution",
 "//python/pip_install:distribution",
 "//tools:distribution",
 "@rules_python_gazelle_plugin//:distribution",
 ],
 visibility = [
 "//examples:__pkg__",
Expand All@@ -61,23 +60,6 @@ filegroup(
 visibility = ["//visibility:public"],
)

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python
# gazelle:exclude bazel-out
# gazelle:exclude examples/**
gazelle(name = "gazelle")

gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=gazelle/deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

genrule(
 name = "assert_bazelversion",
 srcs = [".bazelversion"],
Expand Down

19 changes: 14 additions & 5 deletions
WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,11 +34,6 @@ python_register_multi_toolchains(
 python_versions = MINOR_MAPPING.values(),
)

load("//gazelle:deps.bzl", "gazelle_deps")

# gazelle:repository_macro gazelle/deps.bzl%gazelle_deps
gazelle_deps()

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

# Used for Bazel CI
Expand All@@ -58,3 +53,17 @@ rbe_preconfig(
 name = "buildkite_config",
 toolchain = "ubuntu1804-bazel-java11",
)

local_repository(
 name = "rules_python_gazelle_plugin",
 path = "gazelle",
)

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
# for python requirements.
_py_gazelle_deps()

8 changes: 4 additions & 4 deletions
examples/build_file_generation/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,11 +4,11 @@
# ruleset. When the symbol is loaded you can use the rule.
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
load("@rules_python//python:pip.bzl", "compile_pip_requirements")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

compile_pip_requirements(
 name = "requirements",
Expand DownExpand Up@@ -53,7 +53,7 @@ gazelle_python_manifest(
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)

# This rule is auto-generated and managed by Gazelle,
Expand Down

18 changes: 17 additions & 1 deletion
examples/build_file_generation/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -82,6 +82,22 @@ local_repository(
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
# )

# We import the repository-local rules_python_gazelle_plugin version in order to
# be able to test development changes to the plugin.
local_repository(
 name = "rules_python_gazelle_plugin",
 path = "../../gazelle",
)

# When loading the gazelle plugin outside this repo, use the http_archive rule as follows:
#
#http_archive(
# name = "rules_python_gazelle_plugin",
# sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
# strip_prefix = "rules_python-0.16.1/gazelle",
# url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
#)

# Next we load the toolchain from rules_python.
load("@rules_python//python:repositories.bzl", "python_register_toolchains")

Expand DownExpand Up@@ -124,7 +140,7 @@ install_deps()

# The rules_python gazelle extension has some third-party go dependencies
# which we need to fetch in order to compile it.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")
load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# See: https://github.com/bazelbuild/rules_python/blob/main/gazelle/README.md
# This rule loads and compiles various go dependencies that running gazelle
Expand Down

2 changes: 1 addition & 1 deletion
examples/build_file_generation/gazelle_python.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -114,4 +114,4 @@ manifest:
 zipp.py310compat: zipp
 pip_repository:
 name: pip
integrity: 4153df7683d64d7d6ad56c14ea1c7f7bec84a2ddf9ef8f075d1bb9313b8d11aa
integrity: 2c84a3cabeaff134a1d045e5a173a3178086f236ab20f895ffbd7f3b7a6e5bb0

13 changes: 13 additions & 0 deletions
gazelle/.bazelrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
test --test_output=errors

# Do NOT implicitly create empty __init__.py files in the runfiles tree.
# By default, these are created in every directory containing Python source code
# or shared libraries, and every parent directory of those directories,
# excluding the repo root directory. With this flag set, we are responsible for
# creating (possibly empty) __init__.py files and adding them to the srcs of
# Python targets as required.
build --incompatible_default_to_explicit_init_py

# Windows makes use of runfiles for some rules
build --enable_runfiles
startup --windows_enable_symlinks

12 changes: 12 additions & 0 deletions
gazelle/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
# Bazel directories
/bazel-*
/bazel-bin
/bazel-genfiles
/bazel-out
/bazel-testlogs
user.bazelrc

# Go/Gazelle files
# These otherwise match patterns above
!go.mod
!BUILD.out

43 changes: 28 additions & 15 deletions
gazelle/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
alias(
 name = "gazelle",
 actual = "//gazelle/python",
 visibility = ["//visibility:public"],
)
load("@bazel_gazelle//:def.bzl", "gazelle")

# Gazelle configuration options.
# See https://github.com/bazelbuild/bazel-gazelle#running-gazelle-with-bazel
# gazelle:prefix github.com/bazelbuild/rules_python/gazelle
# gazelle:exclude bazel-out
gazelle(name = "gazelle")

alias(
 name = "gazelle_python_binary",
 actual = "//gazelle/python:gazelle_binary",
 visibility = ["//visibility:public"],
gazelle(
 name = "gazelle_update_repos",
 args = [
 "-from_file=go.mod",
 "-to_macro=deps.bzl%gazelle_deps",
 "-prune",
 ],
 command = "update-repos",
)

filegroup(
 name = "distribution",
 srcs = glob(["**"]) + [
 "//gazelle/manifest:distribution",
 "//gazelle/modules_mapping:distribution",
 "//gazelle/python:distribution",
 "//gazelle/pythonconfig:distribution",
 srcs = [
 ":BUILD.bazel",
 ":README.md",
 ":WORKSPACE",
 ":def.bzl",
 ":deps.bzl",
 ":go.mod",
 ":go.sum",
 "//manifest:distribution",
 "//modules_mapping:distribution",
 "//python:distribution",
 "//pythonconfig:distribution",
 ],
 visibility = ["//:__pkg__"],
 visibility = ["@rules_python//:__pkg__"],
)

18 changes: 13 additions & 5 deletions
gazelle/README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,17 @@ depends on.
Add this to your `WORKSPACE`:

```starlark
http_archive(
 name = "rules_python_gazelle_plugin",
 sha256 = "",
 strip_prefix = "rules_python-0.17.0/gazelle",
 url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.17.0.tar.gz",
)

# To compile the rules_python gazelle extension from source,
# we must fetch some third-party go dependencies that it uses.
load("@rules_python//gazelle:deps.bzl", _py_gazelle_deps = "gazelle_deps")

load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

_py_gazelle_deps()
```
Expand All@@ -40,8 +48,8 @@ To keep the metadata updated, put this in your `BUILD.bazel` file next to `gazel

```starlark
load("@pip//:requirements.bzl", "all_whl_requirements")
load("@rules_python//gazelle/manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python//gazelle/modules_mapping:def.bzl", "modules_mapping")
load("@rules_python_gazelle_plugin//manifest:defs.bzl", "gazelle_python_manifest")
load("@rules_python_gazelle_plugin//modules_mapping:def.bzl", "modules_mapping")

# This rule fetches the metadata for python packages we depend on. That data is
# required for the gazelle_python_manifest rule to update our manifest file.
Expand DownExpand Up@@ -75,7 +83,7 @@ with the rules_python extension included. This typically goes in your root

```
load("@bazel_gazelle//:def.bzl", "gazelle")
load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
load("@rules_python_gazelle_plugin//:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")

# Our gazelle target points to the python gazelle binary.
# This is the simple case where we only need one language supported.
Expand All@@ -85,7 +93,7 @@ load("@rules_python//gazelle:def.bzl", "GAZELLE_PYTHON_RUNTIME_DEPS")
gazelle(
 name = "gazelle",
 data = GAZELLE_PYTHON_RUNTIME_DEPS,
 gazelle = "@rules_python//gazelle:gazelle_python_binary",
 gazelle = "@rules_python_gazelle_plugin//python:gazelle_binary",
)
```

Expand Down

47 changes: 47 additions & 0 deletions
gazelle/WORKSPACE

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
workspace(name = "rules_python_gazelle_plugin")

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")

http_archive(
 name = "io_bazel_rules_go",
 sha256 = "099a9fb96a376ccbbb7d291ed4ecbdfd42f6bc822ab77ae6f1b5cb9e914e94fa",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 "https://github.com/bazelbuild/rules_go/releases/download/v0.35.0/rules_go-v0.35.0.zip",
 ],
)

http_archive(
 name = "bazel_gazelle",
 sha256 = "448e37e0dbf61d6fa8f00aaa12d191745e14f07c31cabfa731f0c8e8a4f41b97",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 "https://github.com/bazelbuild/bazel-gazelle/releases/download/v0.28.0/bazel-gazelle-v0.28.0.tar.gz",
 ],
)

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

go_rules_dependencies()

go_register_toolchains(version = "1.19.4")

gazelle_dependencies()

local_repository(
 name = "rules_python",
 path = "..",
)

load("@rules_python//python:repositories.bzl", "python_register_toolchains")

python_register_toolchains(
 name = "python39",
 python_version = "3.9",
)

load("//:deps.bzl", _py_gazelle_deps = "gazelle_deps")

# gazelle:repository_macro deps.bzl%gazelle_deps
_py_gazelle_deps()

4 changes: 2 additions & 2 deletions
gazelle/def.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,6 @@
"""

GAZELLE_PYTHON_RUNTIME_DEPS = [
 "@rules_python//gazelle/python:parse",
 "@rules_python//gazelle/python:std_modules",
 "@rules_python_gazelle_plugin//python:parse",
 "@rules_python_gazelle_plugin//python:std_modules",
]

2 changes: 1 addition & 1 deletion
go.mod → gazelle/go.mod

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
module github.com/bazelbuild/rules_python
module github.com/bazelbuild/rules_python/gazelle

go 1.19

Expand Down

0
go.sum → gazelle/go.sum

View file


Open in desktop


File renamed without changes.

Loading