Skip to content

Commit

Permalink
chore: refactor core functionality to swifttidy package (#108)
Browse files Browse the repository at this point in the history
- Move core functionality to `swifttidy` package.
- Leave deprecated functionality in `swiftformat`.

Related to #97.
  • Loading branch information
cgrindel committed Jul 5, 2023
1 parent 2ee3835 commit b33caad
Show file tree
Hide file tree
Showing 27 changed files with 211 additions and 144 deletions.
6 changes: 4 additions & 2 deletions BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,11 @@ filegroup(
"MODULE.bazel",
"WORKSPACE",
"//swiftformat:all_files",
"//swiftformat/bzlmod:all_files",
"//swiftformat/internal:all_files",
"//swiftformat/toolchains:all_files",
"//swifttidy:all_files",
"//swifttidy/bzlmod:all_files",
"//swifttidy/internal:all_files",
"//swifttidy/toolchains:all_files",
],
visibility = ["//:__subpackages__"],
)
Expand Down
2 changes: 1 addition & 1 deletion MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ bazel_dep(
)

swift_tidy_tools = use_extension(
"//swiftformat:extensions.bzl",
"//swifttidy:extensions.bzl",
"swift_tidy_tools",
)
use_repo(
Expand Down
6 changes: 3 additions & 3 deletions examples/legacy/WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ local_repository(
)

load(
"@rules_swift_tidy//swiftformat:deps.bzl",
"swiftformat_rules_dependencies",
"@rules_swift_tidy//swifttidy:deps.bzl",
"swifttidy_rules_dependencies",
)

swiftformat_rules_dependencies()
swifttidy_rules_dependencies()

load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")

Expand Down
2 changes: 1 addition & 1 deletion examples/simple/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ load(
"updatesrc_update_all",
)
load(
"@rules_swift_tidy//swiftformat:defs.bzl",
"@rules_swift_tidy//swifttidy:defs.bzl",
"swiftformat_pkg",
)

Expand Down
2 changes: 1 addition & 1 deletion examples/simple/Foo/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
load("@build_bazel_rules_swift//swift:swift.bzl", "swift_library")
load("@rules_swift_tidy//swiftformat:defs.bzl", "swiftformat_pkg")
load("@rules_swift_tidy//swifttidy:defs.bzl", "swiftformat_pkg")

swift_library(
name = "Foo",
Expand Down
49 changes: 11 additions & 38 deletions swiftformat/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,55 +1,28 @@
load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
load("@cgrindel_bazel_starlib//bzlformat:defs.bzl", "bzlformat_pkg")

package(default_visibility = ["//visibility:public"])

bzlformat_pkg(
name = "bzlformat",
format_visibility = ["//visibility:private"],
update_visibility = ["//:__subpackages__"],
)

bzl_library(
name = "defs",
srcs = ["defs.bzl"],
deps = [
"//swiftformat/internal:src_utils",
"//swiftformat/internal:swiftformat_binary",
"//swiftformat/internal:swiftformat_format",
"//swiftformat/internal:swiftformat_library",
"//swiftformat/internal:swiftformat_pkg",
"//swiftformat/internal:swiftformat_test",
"//swiftformat/toolchains:toolchain",
],
visibility = ["//visibility:public"],
deps = ["//swifttidy:defs"],
)

bzl_library(
name = "deps",
srcs = ["deps.bzl"],
visibility = ["//visibility:public"],
deps = ["//swifttidy:deps"],
)

bzl_library(
name = "swiftformat",
srcs = ["swiftformat.bzl"],
deps = [
":defs",
],
visibility = ["//visibility:public"],
deps = ["//swifttidy:defs"],
)

filegroup(
name = "all_files",
srcs = glob(["*"]),
visibility = ["//:__subpackages__"],
)

toolchain_type(name = "toolchain")

bzl_library(
name = "deps",
srcs = ["deps.bzl"],
deps = [
"@bazel_tools//tools/build_defs/repo:http.bzl",
"@bazel_tools//tools/build_defs/repo:utils.bzl",
],
)

bzl_library(
name = "extensions",
srcs = ["extensions.bzl"],
deps = ["//swiftformat/bzlmod:swift_tidy_tools"],
)
22 changes: 8 additions & 14 deletions swiftformat/defs.bzl
Original file line number Diff line number Diff line change
@@ -1,31 +1,25 @@
"""Public API for rules_swiftformat."""
"""Deprecated. Public API for rules_swiftformat."""

# NOTE: This file is deprecated and will be removed in a future release. Please use
# //swifttidy:defs.bzl intead.

load(
"//swiftformat/internal:src_utils.bzl",
_src_utils = "src_utils",
)
load(
"//swiftformat/internal:swiftformat_binary.bzl",
_swiftformat_binary = "swiftformat_binary",
)
load(
"//swiftformat/internal:swiftformat_format.bzl",
_swiftformat_format = "swiftformat_format",
)
load(
"//swiftformat/internal:swiftformat_library.bzl",
_swiftformat_library = "swiftformat_library",
)
load(
"//swiftformat/internal:swiftformat_pkg.bzl",
_swiftformat_pkg = "swiftformat_pkg",
)
load(
"//swiftformat/internal:swiftformat_test.bzl",
_swiftformat_test = "swiftformat_test",
)
load(
"//swiftformat/toolchains:toolchain.bzl",
"//swifttidy:defs.bzl",
_src_utils = "src_utils",
_swiftformat_format = "swiftformat_format",
_swiftformat_pkg = "swiftformat_pkg",
_swiftformat_register_prebuilt_toolchains = "swiftformat_register_prebuilt_toolchains",
)

Expand Down
34 changes: 5 additions & 29 deletions swiftformat/deps.bzl
Original file line number Diff line number Diff line change
@@ -1,32 +1,8 @@
"""Dependencies for rules_swiftformat."""
"""Deprecated. Legacy external dependencies for rules_swiftformat."""

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
load("@bazel_tools//tools/build_defs/repo:utils.bzl", "maybe")
# NOTE: This file is deprecated and will be removed in a future release. Please use
# //swifttidy:deps.bzl intead.

def swiftformat_rules_dependencies():
"""Loads the dependencies for `rules_swiftformat`."""
maybe(
http_archive,
name = "bazel_skylib",
urls = [
"https://mirror.bazel.build/github.com/bazelbuild/bazel-skylib/releases/download/1.4.2/bazel-skylib-1.4.2.tar.gz",
"https://github.com/bazelbuild/bazel-skylib/releases/download/1.4.2/bazel-skylib-1.4.2.tar.gz",
],
sha256 = "66ffd9315665bfaafc96b52278f57c7e2dd09f5ede279ea6d39b2be471e7e3aa",
)
load("//swifttidy:deps.bzl", "swifttidy_rules_dependencies")

maybe(
http_archive,
name = "cgrindel_bazel_starlib",
sha256 = "ee0033d029b5eaddc21836b2944cf37c95eb5f214eb39834136a316dbc252a73",
urls = [
"https://github.com/cgrindel/bazel-starlib/releases/download/v0.16.0/bazel-starlib.v0.16.0.tar.gz",
],
)

maybe(
http_archive,
name = "build_bazel_rules_swift",
sha256 = "7929b4fd6d9f7c44ed5734a15004bfc2046146ba5ea269f0568d9efe2f405ef3",
url = "https://github.com/bazelbuild/rules_swift/releases/download/1.9.0/rules_swift.1.9.0.tar.gz",
)
swiftformat_rules_dependencies = swifttidy_rules_dependencies
48 changes: 8 additions & 40 deletions swiftformat/internal/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,48 +1,21 @@
load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
load("@cgrindel_bazel_starlib//bzlformat:defs.bzl", "bzlformat_pkg")

package(default_visibility = ["//swiftformat:__subpackages__"])

bzlformat_pkg(
name = "bzlformat",
format_visibility = ["//visibility:private"],
update_visibility = ["//:__subpackages__"],
)

bzl_library(
name = "swiftformat_format",
srcs = ["swiftformat_format.bzl"],
deps = [
"@bazel_skylib//lib:paths",
"@cgrindel_bazel_starlib//updatesrc:defs",
],
)

bzl_library(
name = "swiftformat_pkg",
srcs = ["swiftformat_pkg.bzl"],
name = "swiftformat_binary",
srcs = ["swiftformat_binary.bzl"],
visibility = ["//swiftformat:__subpackages__"],
deps = [
":src_utils",
":swiftformat_format",
"@bazel_skylib//rules:diff_test",
"@cgrindel_bazel_starlib//updatesrc:defs",
"//swifttidy:defs",
"@build_bazel_rules_swift//swift",
],
)

bzl_library(
name = "swiftformat_library",
srcs = ["swiftformat_library.bzl"],
visibility = ["//swiftformat:__subpackages__"],
deps = [
":swiftformat_pkg",
"@build_bazel_rules_swift//swift",
],
)

bzl_library(
name = "swiftformat_binary",
srcs = ["swiftformat_binary.bzl"],
deps = [
":swiftformat_pkg",
"//swifttidy:defs",
"@build_bazel_rules_swift//swift",
],
)
Expand All @@ -51,7 +24,7 @@ bzl_library(
name = "swiftformat_test",
srcs = ["swiftformat_test.bzl"], # keep
deps = [
":swiftformat_pkg",
"//swifttidy:defs",
"@build_bazel_rules_swift//swift",
],
)
Expand All @@ -61,8 +34,3 @@ filegroup(
srcs = glob(["*"]),
visibility = ["//:__subpackages__"],
)

bzl_library(
name = "src_utils",
srcs = ["src_utils.bzl"],
)
2 changes: 1 addition & 1 deletion swiftformat/internal/swiftformat_binary.bzl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Definition for swiftformat_binary macro."""

load("@build_bazel_rules_swift//swift:swift.bzl", "swift_binary")
load(":swiftformat_pkg.bzl", "swiftformat_pkg")
load("//swifttidy:defs.bzl", "swiftformat_pkg")

def swiftformat_binary(
name,
Expand Down
2 changes: 1 addition & 1 deletion swiftformat/internal/swiftformat_library.bzl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Definition for swiftformat_library macro."""

load("@build_bazel_rules_swift//swift:swift.bzl", "swift_library")
load(":swiftformat_pkg.bzl", "swiftformat_pkg")
load("//swifttidy:defs.bzl", "swiftformat_pkg")

def swiftformat_library(
name,
Expand Down
2 changes: 1 addition & 1 deletion swiftformat/internal/swiftformat_test.bzl
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
"""Definition for swiftformat_test macro."""

load("@build_bazel_rules_swift//swift:swift.bzl", "swift_test")
load(":swiftformat_pkg.bzl", "swiftformat_pkg")
load("//swifttidy:defs.bzl", "swiftformat_pkg")

def swiftformat_test(
name,
Expand Down
4 changes: 2 additions & 2 deletions swiftformat/swiftformat.bzl
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
"""Deprecated. Public API for rules_swiftformat."""

# NOTE: This file is deprecated and will be removed in a future release. Please use
# //swiftformat:defs.bzl intead.
# //swifttidy:defs.bzl intead.

load(
"//swiftformat:defs.bzl",
"//swifttidy:defs.bzl",
_src_utils = "src_utils",
_swiftformat_binary = "swiftformat_binary",
_swiftformat_format = "swiftformat_format",
Expand Down
51 changes: 51 additions & 0 deletions swifttidy/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
load("@cgrindel_bazel_starlib//bzlformat:defs.bzl", "bzlformat_pkg")

package(default_visibility = ["//visibility:public"])

bzlformat_pkg(
name = "bzlformat",
format_visibility = ["//visibility:private"],
update_visibility = ["//:__subpackages__"],
)

bzl_library(
name = "defs",
srcs = ["defs.bzl"],
deps = [
"//swifttidy/internal:src_utils",
"//swifttidy/internal:swiftformat_format",
"//swifttidy/internal:swiftformat_pkg",
"//swifttidy/toolchains:toolchain",
],
)

bzl_library(
name = "swiftformat",
deps = [
":defs",
],
)

filegroup(
name = "all_files",
srcs = glob(["*"]),
visibility = ["//:__subpackages__"],
)

toolchain_type(name = "toolchain")

bzl_library(
name = "deps",
srcs = ["deps.bzl"],
deps = [
"@bazel_tools//tools/build_defs/repo:http.bzl",
"@bazel_tools//tools/build_defs/repo:utils.bzl",
],
)

bzl_library(
name = "extensions",
srcs = ["extensions.bzl"],
deps = ["//swifttidy/bzlmod:swift_tidy_tools"],
)
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ bzl_library(
srcs = ["swift_tidy_tools.bzl"],
visibility = ["//visibility:public"],
deps = [
"//swiftformat/toolchains:prebuilt_assets",
"//swiftformat/toolchains:toolchain",
"//swifttidy/toolchains:prebuilt_assets",
"//swifttidy/toolchains:toolchain",
],
)
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
"""Extension for downloading the tools used by `rules_swift_tidy`."""

load("//swiftformat/toolchains:prebuilt_assets.bzl", "prebuilt_assets")
load("//swifttidy/toolchains:prebuilt_assets.bzl", "prebuilt_assets")
load(
"//swiftformat/toolchains:toolchain.bzl",
"//swifttidy/toolchains:toolchain.bzl",
"swiftformat_register_prebuilt_toolchains",
)

Expand Down
Loading

0 comments on commit b33caad

Please sign in to comment.