CI に Format Lint を追加する & Format Lint の警告に対応 #237
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
voluntas
reviewed
Feb 12, 2025
| - name: Lint | ||
| run: | | ||
| ./lint-format.sh | ||
| make lint |
zztkm
changed the title
zztkm
commented
Feb 13, 2025
Comment on lines
38
to
39
| - [UPDATE] GitHub Actions で format check をするのをやめる | ||
| - @zztkm |
Contributor
Author
There was a problem hiding this comment.
📝 format check は一時的にはやめたけど今回戻したのでこの CHANGES は混乱を生みそうな気がした。
結果的に SwiftFormat から swift-format に format lint も移行しただけなので消しておいて良いかもしれない。
zztkm
commented
Feb 13, 2025
Contributor
Author
There was a problem hiding this comment.
format lint と lint を GitHub Actions で実行する箇所とローカルでの lint 実行は Makefile に譲ったので、lint-format.sh は不要になった。今までありがとう。
| // 採用された WebSocket 以外を切断してから webSocketChannelCandidates をクリアする | ||
| weakSelf.webSocketChannelCandidates.removeAll { $0 == webSocketChannel } | ||
| weakSelf.webSocketChannelCandidates.forEach { | ||
| for candidate in weakSelf.webSocketChannelCandidates { |
Contributor
Author
There was a problem hiding this comment.
forEach ではなく、for in が推奨されていたので対応（他の forEach を使っている箇所も同様。
|
|
||
| switch signaling { | ||
| case var .offer(message): | ||
| case .offer(var message): |
Contributor
Author
There was a problem hiding this comment.
let と同様、var も () 内に定義する（警告文では let と表記されるけど...）。
Comment on lines
+649
to
+650
| // swift-format-ignore: AlwaysUseLowerCamelCase | ||
| // JSON のキー名に合わせるためにスネークケースを使用しているので、ignore する |
Contributor
Author
There was a problem hiding this comment.
CHANGES にも記載したが、JSON デコード処理に使う JSON のキー名を指定するための enum の定義については、AlwaysUseLowerCamelCase ルールを無効化するためのコメントを追加。
Signaling.swift 内に数か所同じコメントがある。
zztkm
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SwiftFormat から swift-format へ移行する対応で、
swift format lintによるスタイルチェックを有効化し、すべての警告を修正しました。AlwaysUseLowerCamelCaseルールを無効化するためのコメントを追加This pull request includes several changes to improve the codebase by updating documentation comments and modifying the build and lint process. The most important changes include updating the GitHub Actions workflow to use a Makefile for linting, transitioning documentation comments from block comments to line comments, and simplifying switch case syntax.
Build and Lint Process Updates:
.github/workflows/build.yml: Added a new step for format linting and updated the linting step to usemake lintinstead of./lint-format.sh.CHANGES.md: Documented the transition to using a Makefile for linting in GitHub Actions, including the removal oflint-format.sh. [1] [2]Documentation Comment Updates:
Sora/CameraVideoCapturer.swift: Updated multiple documentation comments from block comments to line comments for methods and properties. [1] [2] [3] [4] [5]Sora/Configuration.swift: Updated documentation comments from block comments to line comments for initializers and properties. [1] [2] [3] [4] [5] [6] [7]Sora/ICECandidate.swift: Updated documentation comments from block comments to line comments for methods and properties. [1] [2]Sora/MediaChannel.swift: Updated documentation comments from block comments to line comments for methods and properties. [1] [2] [3] [4] [5] [6] [7]Sora/MediaStream.swift: Updated documentation comments from block comments to line comments for methods and properties. [1] [2]Code Simplification:
Sora/ConnectionTimer.swift: Simplified switch case syntax by moving theletkeyword inside the case pattern.Sora/DataChannel.swift: Simplified switch case syntax by moving theletkeyword inside the case pattern.Sora/Logger.swift: Simplified switch case syntax by moving theletkeyword inside the case pattern.