cgrindel/rules_swiftformat

Bazel rules that format Swift source files using nicklockwood/SwiftFormat.

rules_swiftformat's Issues

Support downloading pre-built SwiftFormat assets

Add Ubuntu build to GIthub Actions

Implement a release workflow

Fix README.md: replace swiftformat_update with updatesrc_update

chore: refactor items to `swifttidy` package

Considerations

• Should we centralize configuration first? (i.e., avoid having to specify a reference to configuration for each invocation)

Tasks

• Rename swiftformat directory to swifttidy.
• Create swiftformat directory that provides backward compatibility.
• Only expose swiftformat_binary, swiftformat_library, and swiftformat_test via swiftformat package. Deprecating these helpers.

Create a better target to execute swiftformat from the command-line

• The target should use the SwiftFormat config file.

Migrate Github Actions poorly formatted code change test to use bazel_integration_test

Update rules_swiftformat with latest rules_bzlformat

Upgrade to SwiftFormat 0.49.1

https://github.com/nicklockwood/SwiftFormat/releases/tag/0.48.18

Create release 0.1.0

Implement change_update_all_test.sh

Started implementing this custom test runner for the integration tests. However, it was not quite working.

Create macros that combine swiftformat_pkg and swift_library, swift_test and swift_binary

This provides an easy means for defining targets and formatting.

Rename repository to `rules_swift_tidy`

Prepare for expanded role performing formatting and linting.

Document how to use `rules_swift_package_manager` to build SwiftFormat

Add Ubuntu runner to Github Actions CI

Update the Github Action "Test Simple Example with Poorly Formatted Code Change" to use bazel_integration_test with a custom runner.

Add documentation on how to use SwiftFormat executable with IDE

Add swiftformat_exclude to swiftformat_library, swiftformat_binary, swiftformat_test

There are some files (e.g. generated files) that we may not want to format.

Support bzlmod

Add integration tests and enable for merge

Generate documentation

Allow client to specify the `version` and `sha256` values for the assets.

Considerations

• Generate the asset information like we did in buildifier-prebuilt

Dependency Dashboard self-hosted

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update dependency bazel to v7

Detected dependencies

bazel

swifttidy/deps.bzl

• bazel_skylib 1.5.0
• cgrindel_bazel_starlib v0.19.0
• build_bazel_rules_swift 1.16.0

bazel-module

MODULE.bazel

examples/exclude_files/MODULE.bazel

• rules_swift 1.16.0
• cgrindel_bazel_starlib 0.19.0

examples/rules_swift_helpers/MODULE.bazel

• rules_swift 1.16.0
• cgrindel_bazel_starlib 0.19.0

examples/simple/MODULE.bazel

• rules_swift 1.16.0
• cgrindel_bazel_starlib 0.19.0

bazelisk

.bazelversion

• bazel 6.5.0

github-actions

.github/workflows/ci.yml

• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• cgrindel/gha_set_up_bazel v1
• cgrindel/gha_install_swift_on_ubuntu v1
• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• cgrindel/gha_set_up_bazel v1
• cgrindel/gha_join_jobs v1
• macos 13
• ubuntu 22.04
• ubuntu 22.04

.github/workflows/create_release.yml

• actions/checkout v4@b4ffde65f46336ab88eb53be808477a3936bae11
• tibdex/github-app-token v2
• cgrindel/gha_configure_git_user v1
• cgrindel/gha_create_release v2

Add Gazelle plugin to populate the `swift_tidy_pkg` declarations

Considerations

• Specify the location of configuration files via Gazelle directive (#98).

Two modes:

• Using swift_tidy_pkg directly
  • Add swift_tidy_pkg alongside the swift_xxx declarations
  • Could we configure rules_swift_package_manager gazelle plugin to add arbitrary declarations.
• Using helpers that replace swift_xxx.
  • Configure rules_swift_package_manager to specify the load path for each swift_xxx rule/macro.

Publish to BCR

Upgrade SwiftFormat to 0.49.5 https://github.com/nicklockwood/SwiftFormat/releases/tag/0.49.5

Centralize configuration for `swiftformat_pkg` invocations

Right now, we have to do this:

swiftformat_pkg(
    name = "swiftformat",
    config = "//:.swiftformat",
)

We want to do this:

swiftformat_pkg(name = "swiftformat")

Figure out why Bazel symlink cleanup is not working

bazel run @rules_bazel_integration_test//tools:remove_child_wksp_bazel_symlinks

Update `rules_swiftformat` to use `swift_bazel`

Enable Bazel 7.0 pre-release integration testing after fixing rules_swift error

Slack thread

bazel_binaries(versions = [
    "//:.bazelversion",
    "7.0.0-pre.20230504.4",
])

Error:

$TEST_TMPDIR defined: output root default is '/private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33' and max_idle_secs defaul
t is '15'.
Extracting Bazel installation...
Starting local Bazel server and connecting to it...
INFO: Invocation ID: 770fb1c9-d320-4256-b18d-879faa2704b1
INFO: Options provided by the client:
  Inherited 'common' options: --isatty=0 --terminal_columns=80
INFO: Reading rc options for 'info' from /Users/chuck/code/cgrindel/dev-machine/home/.bazelrc:
  Inherited 'common' options: --announce_rc
INFO: Reading rc options for 'info' from /Users/chuck/code/cgrindel/rules_swiftformat/fix_failing_ci/shared.bazelrc:
  Inherited 'build' options: --verbose_failures --incompatible_strict_action_env=true
INFO: Reading rc options for 'info' from /Users/chuck/code/cgrindel/dev-machine/home/.bazelrc:
  Inherited 'build' options: --disk_cache=~/.bazel/disk_cache --repository_cache=~/.bazel/repo_cache --remote_header=x-buildbuddy-api-key=9DlX0JxsBj7ihhtaO0ue
bazel-bin: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/execroot/simpl
e_example/bazel-out/darwin_x86_64-fastbuild/bin
bazel-genfiles: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/execroot/
simple_example/bazel-out/darwin_x86_64-fastbuild/bin
bazel-testlogs: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/execroot/
simple_example/bazel-out/darwin_x86_64-fastbuild/testlogs
character-encoding: file.encoding = ISO-8859-1, defaultCharset = ISO-8859-1
command_log: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/command.log
committed-heap-size: 297MB
execution_root: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/execroot/
simple_example
gc-count: 8
gc-time: 47ms
install_base: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/install/c92c8a42045ec41b6a06cceb9c55b7ae
java-home: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/install/c92c8a42045ec41b6a06cceb9c55b7ae/embedd
ed_tools/jdk
java-runtime: OpenJDK Runtime Environment (build 17.0.5+8-LTS) by Azul Systems, Inc.
java-vm: OpenJDK 64-Bit Server VM (build 17.0.5+8-LTS, mixed mode) by Azul Systems, Inc.
local_resources: RAM=34359MB, CPU=16.0
max-heap-size: 8589MB
output_base: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da
output_path: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/execroot/sim
ple_example/bazel-out
package_path: %workspace%
release: release 7.0.0-pre.20230504.4
repository_cache: /Users/chuck/.bazel/repo_cache
server_log: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/java.log.chuc
ks-macbook-pro.chuck.log.java.20230527-172559.5168
server_pid: 5168
used-heap-size: 33MB
workspace: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/bazel-out/darwin-fastbuild/bin/examples/simple_test_bazel_7_0_0-pre_20230504_4.runfiles/cgrindel_r
ules_swiftformat/examples/simple
$TEST_TMPDIR defined: output root default is '/private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33' and max_idle_secs defaul
t is '15'.
INFO: Invocation ID: 2702b47a-abb9-4ccb-8aff-d7eca5a4b97d
INFO: Options provided by the client:
  Inherited 'common' options: --isatty=0 --terminal_columns=80
INFO: Reading rc options for 'test' from /Users/chuck/code/cgrindel/dev-machine/home/.bazelrc:
  Inherited 'common' options: --announce_rc
INFO: Reading rc options for 'test' from /Users/chuck/code/cgrindel/rules_swiftformat/fix_failing_ci/shared.bazelrc:
  Inherited 'build' options: --verbose_failures --incompatible_strict_action_env=true
INFO: Reading rc options for 'test' from /Users/chuck/code/cgrindel/dev-machine/home/.bazelrc:
  Inherited 'build' options: --disk_cache=~/.bazel/disk_cache --repository_cache=~/.bazel/repo_cache --remote_header=x-buildbuddy-api-key=9DlX0JxsBj7ihhtaO0ue
INFO: Reading rc options for 'test' from /Users/chuck/code/cgrindel/dev-machine/home/.bazelrc:
  'test' options: --test_output=errors --test_summary=terse
Loading: 
Loading: 
Loading: 0 packages loaded
Analyzing: 10 targets (2 packages loaded, 0 targets configured)
Analyzing: 10 targets (46 packages loaded, 357 targets configured)
DEBUG: Rule 'swiftformat_download_macos_x86_64' indicated that a canonical reproducible form can be obtained by modifying arguments sha256 = "ce40452ea8b16abc0019f9d59ae9f53231b529c0619dddfb729ec84a26c54529"
DEBUG: Repository swiftformat_download_macos_x86_64 instantiated at:
  /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/bazel-out/darwin-fastbuild/bin/examples/simple_test_bazel_7_0_0-pre_20230504_4.runfiles/cgrindel_rules_swif
tformat/examples/simple/WORKSPACE:16:32: in <toplevel>
  /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/external/cgrindel_rules
_swiftformat/swiftformat/toolchains/assets.bzl:82:21: in swiftformat_register_toolchains
Repository rule http_archive defined at:
  /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/external/bazel_tools/to
ols/build_defs/repo/http.bzl:372:31: in <toplevel>
Analyzing: 10 targets (47 packages loaded, 365 targets configured)
Analyzing: 10 targets (47 packages loaded, 365 targets configured)
Analyzing: 10 targets (47 packages loaded, 365 targets configured)
Analyzing: 10 targets (47 packages loaded, 365 targets configured)
Analyzing: 10 targets (52 packages loaded, 391 targets configured)
Analyzing: 10 targets (52 packages loaded, 391 targets configured)
Analyzing: 10 targets (53 packages loaded, 403 targets configured)
Analyzing: 10 targets (53 packages loaded, 403 targets configured)
ERROR: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/external/build_baz
el_rules_swift_local_config/BUILD:9:22: in xcode_swift_toolchain rule @build_bazel_rules_swift_local_config//:toolchain: 
Traceback (most recent call last):
        File "/private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/external/bu
ild_bazel_rules_swift/swift/internal/xcode_swift_toolchain.bzl", line 517, column 29, in _xcode_swift_toolchain_impl
                target_triples.parse(cc_toolchain.target_gnu_system_name),
        File "/private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/external/bu
ild_bazel_rules_swift/swift/internal/target_triples.bzl", line 135, column 28, in _parse
                vendor = components[1],
Error: index out of range (index is 1, but sequence has 1 elements)
ERROR: /private/var/tmp/_bazel_chuck/ac6347dedadaee9aef21bdea5246c821/execroot/cgrindel_rules_swiftformat/_tmp/298e1c6e7849152759b069a6fa7aaf33/_bazel_chuck/a895a75afb69374c31c23c0ae71bb1da/external/build_baz
el_rules_swift_local_config/BUILD:9:22: Analysis of target '@build_bazel_rules_swift_local_config//:toolchain' failed
ERROR: Analysis of target '//Foo:Foo' failed; build aborted: 
INFO: Elapsed time: 36.775s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Couldn't start the build. Unable to run tests

Add the ability to update all formatted files in a workspace

Something like:

bazel run //:format_update_all

Decide how to handle sources that labels, not paths

I am currently adding code to ignore labels for now. I am not sure if we want to format generated files. However, not every label will reference a generated file.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

bazel

swifttidy/deps.bzl

• bazel_skylib 1.4.2
• cgrindel_bazel_starlib v0.16.1
• build_bazel_rules_swift 1.9.1

bazel-module

MODULE.bazel

examples/exclude_files/MODULE.bazel

• rules_swift 1.9.1
• cgrindel_bazel_starlib 0.16.1

examples/rules_swift_helpers/MODULE.bazel

• rules_swift 1.9.1
• cgrindel_bazel_starlib 0.16.1

examples/simple/MODULE.bazel

• rules_swift 1.9.1
• cgrindel_bazel_starlib 0.16.1

bazelisk

.bazelversion

• bazel 6.2.1

github-actions

.github/workflows/ci.yml

• actions/checkout v3
• cgrindel/gha_set_up_bazel v1
• cgrindel/gha_install_swift_on_ubuntu v1
• actions/checkout v3
• cgrindel/gha_set_up_bazel v1
• cgrindel/gha_join_jobs v1

.github/workflows/create_release.yml

• actions/checkout v3
• tibdex/github-app-token v1
• cgrindel/gha_configure_git_user v1
• cgrindel/gha_create_release v2

---

• Check this box to trigger a request for Renovate to run again on this repository

Remove remaining obsolete update code

• providers.bzl
• update_all.sh

Document how to use pre-built SwiftFormat on Linux

• Set LD_LIBRARY_PATH
• Add LD_LIBRARY_PATH to --action_env

Migrate formatting check to be a validation action?

Bazel doc