Swift Academy · 课时

SwiftFormat / SwiftLint 基础

设置 SwiftFormat 自动格式化代码,并使用 SwiftLint 标记样式问题。在本地和 CI 中使用简单、适合初学者的规则运行它们。

第 1 / 3 课8 个步骤

SwiftFormat / SwiftLint 基础 是 CoddyKit 上的免费 Swift Academy 课时。 这是第 1 节课,共 3 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Swift Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Swift Academy 课程共包含 3 节课。

为什么要格式化与静态检查?

目标:让代码保持一致且易读。

  • SwiftFormat → 自动格式化源代码
  • SwiftLint → 标记样式问题
  • 在本地和持续集成中运行,以保持稳定的质量

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")

从违规到整洁代码

格式化会修复空格和换行;静态检查规则会引导您改进名称和用法。让示例保持简短,以便初学者看出差异。

// BEFORE (bad spacing, short name, unused let)
//let x=1
//print(  "Hi"  )
//
// AFTER (formatted & lint-friendly):
let count = 1
print("Hi")
print("count =", count)

自动化工作流

自动运行这两个工具:提交前在本地运行;在持续集成中使用 --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 强制执行样式规则。让配置保持简单,在本地运行,并使用 --strict 为持续集成设置质量门禁。

免费开始

用 AI 导师学习 Swift — 免费

在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。

课程
122
课程
409

常见问题解答

「SwiftFormat / SwiftLint 基础」课时是免费的吗?

是的 — 「SwiftFormat / SwiftLint 基础」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Swift Academy 课程的其余内容,请升级到 CoddyKit PRO。 Swift Academy 课程共包含 3 节课。

「SwiftFormat / SwiftLint 基础」这节课中我会学到什么?

设置 SwiftFormat 自动格式化代码,并使用 SwiftLint 标记样式问题。在本地和 CI 中使用简单、适合初学者的规则运行它们。 你通过在浏览器中直接运行的动手代码来练习 Swift Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Swift Academy 需要有经验吗?

无需任何先前经验。CoddyKit 上的 Swift Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 1 节课,共 3 节。

「SwiftFormat / SwiftLint 基础」课时需要多长时间?

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。

我能在这节 Swift Academy 课中编写并运行代码吗?

能。每节 Swift Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. SwiftFormat / SwiftLint 基础
  2. 样式指南与 API 设计指南
  3. 记录代码(DocC 入门)
← 返回 Swift Academy