SwiftFormat for VS Code:自动美化Swift代码的利器
SwiftFormat for VS Code是一个强大的扩展工具,旨在通过nicklockwood/SwiftFormat或apple/swift-format来自动美化您的Swift代码。无论您是通过Homebrew、Mint进行全局安装,还是通过Swift Package Manager进行本地安装,SwiftFormat都能为您的Swift开发带来便捷和高效。
安装方式:
全局安装: 您可以使用Homebrew或Mint进行全局安装。
# 使用Homebrew
$ brew update && brew install swiftformat
# 使用Mint
$ mint install nicklockwood/SwiftFormat
本地安装: 将SwiftFormat添加到您的Package.swift文件中的依赖项中。
// swift-tools-version:4.2
import PackageDescription
let package = Package(
name: "Komondor",
products: [ ... ],
dependencies: [
// 我的依赖项
.package(url: "https://github.com/orta/PackageConfig.git", from: "0.0.1"),
// 开发依赖项
.package(url: "https://github.com/orta/Komondor.git", from: "0.0.1"),
.package(url: "https://github.com/nicklockwood/SwiftFormat.git", from: "0.55.5"),
],
targets: [...]
)
配置选项:
SwiftFormat for VS Code提供了多种配置选项,以满足您的个性化需求:
配置项 | 类型 | 默认值 | 描述 |
---|---|---|---|
swiftformat.enable | Bool | true | 是否启用SwiftFormat进行代码美化。 |
swiftformat.onlyEnableOnSwiftPMProjects | Bool | false | 仅在SwiftPM项目中启用SwiftFormat,并在首次启动时构建Swift包。 |
swiftformat.onlyEnableWithConfig | Bool | false | 仅在存在配置文件时启用格式化。 |
swiftformat.path | [String]或String | swiftformat | 全局安装的SwiftFormat的位置(如果仅是文件名,则会根据当前路径解析)。 |
swiftformat.options | [String] | [] | SwiftFormat的附加选项。 |
swiftformat.configSearchPaths | [String] | [".swiftformat"] | SwiftFormat配置文件的可能路径。 |
请注意,当启用swiftformat.onlyEnableOnSwiftPMProjects
时,扩展程序将仅运行工作区中打开的Swift包构建的swiftformat可执行文件。它会在首次启动时尝试构建一次二进制文件。如果构建失败,扩展程序不会回退到全局安装的swiftformat。如果您偏好本地构建的swiftformat,但想跳过自动初始构建,可以让swiftformat.path
指向您手动构建或通过其他独立于扩展程序的方式构建的本地可执行文件。
常见问题:
如何启用输入时格式化?
要在输入代码时启用格式化而不需要保存,只需启用设置"editor.formatOnType": true
。如果您只想在编辑Swift文件时启用,可以覆盖为特定于[swift]语言的设置。
许可证:
vscode-swiftformat在MIT许可证下可用。
本站所有资源都是由网友投稿发布,或转载各大下载站, 请自行检测软件的完整性!
本站所有资源仅供学习与参考,请勿用于商业用途,否则 产生的一切后果将由您自己承担!
如有侵权请联系我们删除下架,联系方式:study_golang@163.com