[iOS]Introduce swift-format #801

KaitoMuraoka · 2023-08-20T12:04:39Z

Issue

close [iOS] Introduce swift-format #393

Overview (Required)

Introduction of Swfit-format

I'm still unfamiliar with how to incorporate iOS libraries in KMM, so I'm a bit unsure if this is correct... 😥

日本語

- [Swift-format](https://github.com/apple/swift-format) の導入私はまだKMMにおいて、iOSのライブラリを入れる方法の仕方について知見がないため、この内容で合っているのか少し不安です😥

Links

Reference：https://tech.connehito.com/entry/swift-format

Screenshot

Before	After

github-actions · 2023-08-20T12:09:53Z

Test Results

122 tests 122 ✔️ 8m 4s ⏱️
    9 suites     0 💤
    9 files     0 ❌

Results for commit abe25c2.

This reverts commit 7ae4c51.

# Conflicts: # app-ios/Modules/Package.swift

KaitoMuraoka · 2023-08-21T14:07:08Z

app-ios/Modules/Package.swift

@@ -20,9 +20,10 @@ var package = Package(
        .package(url: "https://github.com/apple/swift-collections.git", from: "1.0.4"),
        .package(url: "https://github.com/apple/swift-algorithms.git", from: "1.0.0"),
        .package(url: "https://github.com/apple/swift-async-algorithms.git", from: "0.1.0"),
-        .package(url: "https://github.com/realm/SwiftLint", from: "0.52.4"),
+        .package(url: "https://github.com/realm/SwiftLint", from: "0.51.0"),


The following error occurred:

Failed to resolve dependencies Dependencies could not be resolved because root depends on 'swiftlint' 0.52.4..<1.0.0 and root depends on 'swift-format' 508.0.0..<509.0.0. 'swiftlint' is incompatible with 'swift-format'. 'swiftlint' >= 0.52.4 practically depends on 'swift-syntax' 509.0.0-swift-DEVELOPMENT-SNAPSHOT-2023-07-04-a because 'swiftlint' 0.52.4 depends on 'swift-syntax' 509.0.0-swift-DEVELOPMENT-SNAPSHOT-2023-07-04-a and no versions of 'swiftlint' match the requirement 0.52.5..<1.0.0. 'swift-format' >= 508.0.0 practically depends on 'swift-syntax' 508.0.0..<509.0.0 because 'swift-format' 508.0.0 depends on 'swift-syntax' 508.0.0..<509.0.0 and 'swift-format' 508.0.1 depends on 'swift-syntax' 508.0.0..<509.0.0. 'swift-format' {508.0.0, 508.0.2..<509.0.0} practically depends on 'swift-syntax' 508.0.0..<509.0.0 because no versions of 'swift-format' match the requirement 508.0.2..<509.0.0 and 'swift-format' 508.0.0 depends on 'swift-syntax' 508.0.0..<509.0.0.

From this, I belive we either need to upgrade the version of swift-format or downgrade the version of SwiftLint to match the version of swift-syntax.
However, since the current latest version of swift-format is 508.0.1 and cannot be raised any further, I downgraded the SwiftLint version to 51.0.

日本語
以下のようなエラーが発生しました。
Failed to resolve dependencies Dependencies could not be resolved because root depends on 'swiftlint' 0.52.4..<1.0.0 and root depends on 'swift-format' 508.0.0..<509.0.0. 'swiftlint' is incompatible with 'swift-format'. 'swiftlint' >= 0.52.4 practically depends on 'swift-syntax' 509.0.0-swift-DEVELOPMENT-SNAPSHOT-2023-07-04-a because 'swiftlint' 0.52.4 depends on 'swift-syntax' 509.0.0-swift-DEVELOPMENT-SNAPSHOT-2023-07-04-a and no versions of 'swiftlint' match the requirement 0.52.5..<1.0.0. 'swift-format' >= 508.0.0 practically depends on 'swift-syntax' 508.0.0..<509.0.0 because 'swift-format' 508.0.0 depends on 'swift-syntax' 508.0.0..<509.0.0 and 'swift-format' 508.0.1 depends on 'swift-syntax' 508.0.0..<509.0.0. 'swift-format' {508.0.0, 508.0.2..<509.0.0} practically depends on 'swift-syntax' 508.0.0..<509.0.0 because no versions of 'swift-format' match the requirement 508.0.2..<509.0.0 and 'swift-format' 508.0.0 depends on 'swift-syntax' 508.0.0..<509.0.0.

このことから、swift-format のバージョンを上げるか、SwiftLintのバージョンを下げないと、SwiftSyntac のバージョンに合わせることができないと思います。
しかし、swift-format の現在の最新バージョンは 508.0.1 でこれ以上上げることができないので、SwiftLintのバージョンを51.0までバージョンを下げました。

ry-itto · 2023-08-22T16:52:16Z

app-ios/Modules/Package.swift

@@ -209,6 +210,7 @@ package.targets = package.targets.map { target -> Target in
            target.plugins = []
        }
        target.plugins?.append(.plugin(name: "SwiftLintPlugin", package: "SwiftLint"))
+        target.plugins?.append(.plugin(name: "SwiftFormatPlugin", package: "swift-format"))


SwiftFormatPlugin isn't a correct name 🙏🏼
Please use FormatPlugin 🙏🏼

https://github.com/apple/swift-format/blob/508.0.1/Package.swift#L37

And format or format-lint isn't succeeded. Can you check it? 🙇🏼

woxtu · 2023-08-23T18:28:02Z

The current swift-format doesn't seem to provide any build tools, so adding it to targets as a plugin may not work.
FYI: https://qiita.com/maiyama18/items/3d0f7b288c6858b751ce

KaitoMuraoka · 2023-08-24T02:20:15Z

@woxtu
This is the first time I have heard that it is not possible to write files inside Package. Thank you very much 🎉.

As long as SwiftLint is present, the command plugin didn't work either. Below is the error message I received at that time:

error: Dependencies could not be resolved because root depends on 'swiftlint' 0.52.4..<1.0.0 and root depends on 'swift-format' 508.0.1..<509.0.0.
'swift-format' is incompatible with 'swiftlint' because 'swiftlint' 0.52.4 depends on 'swift-syntax' 509.0.0-swift-DEVELOPMENT-SNAPSHOT-2023-07-04-a and no versions of 'swiftlint' match the requirement 0.52.5..<1.0.0.
'swift-format' >= 508.0.1 practically depends on 'swift-syntax' 508.0.0..<509.0.0 because no versions of 'swift-format' match the requirement 508.0.2..<509.0.0 and 'swift-format' 508.0.1 depends on 'swift-syntax' 508.0.0..<509.0.0.

Thus, by removing SwiftLint and introducing it as a command plugin, it worked without any issues.

However, it only formats a portion of the code.
Below are the files it will format:

- Staff Tests
- SessionTests
- ComponentTests
- SponsorTests
- Session
- Navigation
- Component
- ContributorTests
- KMPContainerTests
- StampsTests
- TimetableTests
- FloorMapTests
- ModelTests
- Timetable
- Sponsor
- FloorMap
- AboutTests

日本語

[Package 内へのファイル書き込みができない](https://qiita.com/maiyama18/items/3d0f7b288c6858b751ce#package-%E5%86%85%E3%81%B8%E3%81%AE%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E6%9B%B8%E3%81%8D%E8%BE%BC%E3%81%BF)のは初めて知りました。ありがとうございます🎉

SwiftLintがある以上、コマンドプラグインでも動作しませんでした。以下はその時に出たエラー文です。

error: Dependencies could not be resolved because root depends on 'swiftlint' 0.52.4..<1.0.0 and root depends on 'swift-format' 508.0.1..<509.0.0.
'swift-format' is incompatible with 'swiftlint' because 'swiftlint' 0.52.4 depends on 'swift-syntax' 509.0.0-swift-DEVELOPMENT-SNAPSHOT-2023-07-04-a and no versions of 'swiftlint' match the requirement 0.52.5..<1.0.0.
'swift-format' >= 508.0.1 practically depends on 'swift-syntax' 508.0.0..<509.0.0 because no versions of 'swift-format' match the requirement 508.0.2..<509.0.0 and 'swift-format' 508.0.1 depends on 'swift-syntax' 508.0.0..<509.0.0.

なので、SwiftLintを抜いて、コマンドプラグインとして導入したら問題なく動作しました。

ただ、一部のコードしかformatしてくれないです。
以下はformatしてくれるファイルです。

- Staff Tests
- SessionTests
- ComponentTests
- SponsorTests
- Session
- Navigation
- Component
- ContributorTests
- KMPContainerTests
- StampsTests
- TimetableTests
- FloorMapTests
- ModelTests
- Timetable
- Sponsor
- FloorMap
- AboutTests

KaitoMuraoka added 2 commits August 20, 2023 20:47

install swift-format

7ae4c51

Merge branch 'main' into introduce-swift-format

abe25c2

github-actions bot temporarily deployed to deploygate-distribution August 20, 2023 12:07 Inactive

KaitoMuraoka added 4 commits August 20, 2023 21:36

Revert "install swift-format"

632f399

This reverts commit 7ae4c51.

add: Introducing swift-format

0b59718

Merge branch 'main' into introduce-swift-format

7ea216d

# Conflicts: # app-ios/Modules/Package.swift

downgrade swiftlint

87a4d2e

KaitoMuraoka commented Aug 21, 2023

View reviewed changes

KaitoMuraoka marked this pull request as ready for review August 21, 2023 14:10

KaitoMuraoka requested a review from a team as a code owner August 21, 2023 14:10

KaitoMuraoka requested a review from takahirom August 21, 2023 14:10

ry-itto reviewed Aug 22, 2023

View reviewed changes

KaitoMuraoka added 2 commits August 23, 2023 23:42

Merge branch 'main' into introduce-swift-format

4cedf01

Edit some versions

32abb9a

KaitoMuraoka closed this by deleting the head repository Sep 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[iOS]Introduce swift-format #801

[iOS]Introduce swift-format #801

KaitoMuraoka commented Aug 20, 2023

github-actions bot commented Aug 20, 2023

KaitoMuraoka Aug 21, 2023

ry-itto Aug 22, 2023

woxtu commented Aug 23, 2023 •

edited

Loading

KaitoMuraoka commented Aug 24, 2023

[iOS]Introduce swift-format #801

[iOS]Introduce swift-format #801

Conversation

KaitoMuraoka commented Aug 20, 2023

Issue

Overview (Required)

Links

Screenshot

github-actions bot commented Aug 20, 2023

Test Results

KaitoMuraoka Aug 21, 2023

Choose a reason for hiding this comment

ry-itto Aug 22, 2023

Choose a reason for hiding this comment

woxtu commented Aug 23, 2023 • edited Loading

KaitoMuraoka commented Aug 24, 2023

woxtu commented Aug 23, 2023 •

edited

Loading