このプロジェクトについて
SwiftFormatは、macOS、Linux、Windows上でSwiftコードを再整形するためのコードライブラリ兼コマンドラインールです。単純な空白の調整にとどまらず、暗黙の`self`の挿入や削除、冗長な括弧の削除、その他標準的なSwiftイディオムからの多くの逸脱を修正できます。
このプロジェクトの明示された動機は、共通のコーディングスタイルに合意することがコラボレーションに役立つ一方で、それを手動で強制するのは退屈でエラーが発生しやすいという点にあります。自動フォーマッタを使えば、チームは見た目ではなくコードの動作に集中できます。
使用方法:
- コマンドラインツールとして、手動またはツールチェーンの一部として実行
- Xcode Source Editor Extensionとして、Editor > SwiftFormatメニューから呼び出し
- Xcodeビルドフェーズとして、各ビルド時に実行
- Git pre-commitフックとして、コミット前に変更されたファイルを整形
- Swift Package Managerコマンドプラグイン(Swift 5.6以降)
- VSCode(Run on Save経由)、Sublime Text、Nova向けの統合
- GitHub Actions、CI上のDanger、Bazel、Docker、AppleScript
インストール方法には、Homebrew(`brew install swiftformat`)、Mint、Nix/nixpkgs、CocoaPods、Package.swift内のバイナリartifactbundle、または`swift build -c release`による手動ビルドがあります。Xcode拡張機能はHomebrew caskまたはGitHub Releasesから入手できます。
基本的な使い方は`swiftformat .`で、カレントディレクトリ内のSwiftファイルを整形します。READMEは、これがファイルをその場で上書きするため、ユーザーは先に変更をコミットすべきだと警告しています。`--infer-options`は既存のプロジェクトスタイルに合った設定を提案できます。標準入出力のパイプもサポートされ、`--stdin-path`でファイル位置のコンテキストを提供できます。
設定は、オプション、ルール、Swiftバージョン、`.swiftformat`設定ファイル、glob、リンティングモード、エラーコード、キャッシュ、ファイルヘッダー、Markdown整形をカバーしています。READMEにはFAQ、既知の問題、チップジャー、クレジットも含まれています。このプロジェクトはMITライセンスです。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.