SwiftFormat/SwiftLintの基礎
コードを自動フォーマットする SwiftFormat と、スタイル上の問題を指摘する SwiftLint を設定します。初心者にも扱いやすいシンプルなルールで、ローカルとCIの両方で実行します。
「SwiftFormat/SwiftLintの基礎」はCoddyKit上の無料Swift Academyレッスンです。 これはレッスン1/3です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはSwift Academy学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Swift Academyコースには全3レッスンが含まれています。
フォーマットとLintの理由
目標:コードの一貫性と読みやすさを保ちます。
- SwiftFormat → ソースを自動フォーマット
- SwiftLint → スタイル上の問題を指摘
- 品質を安定させるため、ローカルとCIで実行
SwiftFormat:使い始める
SwiftFormatはファイルを書き換えてスタイルを統一します。リポジトリに.swiftformatを置き、コミット前に実行してください。
// Install & run (examples):
// mint install nicklockwood/SwiftFormat // via Mint
// swiftformat . // format repo
// swiftformat Sources --config .swiftformat // use config file
//
// Minimal .swiftformat (put in repo root):
// --ifdef no
// --wrapcollections before-first
// --maxwidth 100
print("SwiftFormat: run to auto-format code consistently")SwiftLint:基本
SwiftLintはファイルを解析し、違反を報告します。ルールは.swiftlint.ymlで設定し、初心者にも扱いやすい制限にしてください。
// Install & run (examples):
// brew install swiftlint // macOS example
// swiftlint lint // check whole repo
// swiftlint lint --strict // fail on warnings in CI
//
// Minimal .swiftlint.yml (example):
// disabled_rules:
// - trailing_whitespace
// opt_in_rules:
// - empty_count
// line_length: 100
// identifier_name:
// min_length: 3
print("SwiftLint: report style issues with configurable rules")違反からきれいなコードへ
フォーマットによって空白や改行が整えられ、lintルールによって命名や使い方が改善されます。初心者が違いを確認できるよう、例は小さくしてください。
// BEFORE (bad spacing, short name, unused let)
//let x=1
//print( "Hi" )
//
// AFTER (formatted & lint-friendly):
let count = 1
print("Hi")
print("count =", count)自動化ワークフロー
両方のツールを自動化します。コミット前にローカルで実行し、CIでは--strictを使って後退を阻止してください。
// Simple pre-commit idea (document in README):
// swiftformat . && swiftlint lint --strict
//
// GitHub Actions (sketch) — put in CI config, not here:
// - run: swiftformat --version && swiftformat .
// - run: swiftlint lint --strict
//
// Tip: start lenient (warnings), then turn strict in CI once the repo is clean.
print("Automate: run format+lint locally and in CI")おすすめの開始ルール
初心者向けのデフォルト設定:
- line_length: 100
- identifier_name.min_length: 3
- 単純な末尾カンマを許可する
- 初期段階では、ノイズの多いルールをいくつか無効にする(後で有効化します)
フォーマッターとリンター
確認問題:コードを自動フォーマットするツールはどれですか?
まとめ
まとめ:SwiftFormatでクリーンで一貫性のあるソースを書き、SwiftLintでスタイルルールを適用します。設定はシンプルに保ち、ローカルで実行し、CIでは--strictでチェックしてください。
よくある質問
「SwiftFormat/SwiftLintの基礎」レッスンは無料ですか?
はい。「SwiftFormat/SwiftLintの基礎」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し(組み込みコードエディタと24時間対応のAIチューター)、Swift Academyコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Swift Academyコースには全3レッスンが含まれています。
「SwiftFormat/SwiftLintの基礎」で何を学びますか?
コードを自動フォーマットする SwiftFormat と、スタイル上の問題を指摘する SwiftLint を設定します。初心者にも扱いやすいシンプルなルールで、ローカルとCIの両方で実行します。 ブラウザで直接実行するハンズオンコードでSwift Academyを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。
Swift Academyを始めるのに経験は必要ですか?
事前経験は必要ありません。CoddyKitのSwift Academyは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン1/3です。
「SwiftFormat/SwiftLintの基礎」レッスンにはどのくらい時間がかかりますか?
ほとんどのCoddyKitレッスンは約5~10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。
このSwift Academyレッスンでコードを書いて実行できますか?
はい。すべてのSwift Academyレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。
このコースのすべてのレッスン
- SwiftFormat/SwiftLintの基礎
- スタイルガイドとAPI設計ガイドライン
- コードのドキュメント化(DocC入門)