Skip to content

Standardize formatting #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dfed merged 5 commits into from
May 24, 2025
Merged

Standardize formatting #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e152eb1
Enforce standard formatting via .editorconfig, SwiftFormat, and CI
dfed May 23, 2025
d48af9b
Run shfmt
dfed May 23, 2025
7abb0e6
Run linter
dfed May 23, 2025
49fec0f
Add convenience to modifier order
dfed May 23, 2025
a7fc32f
Run linter
dfed May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[*]
insert_final_newline = true
indent_size = 4 # We can remove this line if anyone has strong opinions.

# swift
[*.swift]
indent_style = tab

# sh
[*.sh]
indent_style = tab

# documentation, utils
[*.{md,mdx,diff}]
trim_trailing_whitespace = false
9 changes: 9 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,12 @@ jobs:
uses: actions/checkout@v4
- name: Link Checker
uses: AlexanderDokuchaev/md-dead-link-check@v1.0.1
lint-swift:
name: Lint Swift
runs-on: ubuntu-latest
container: swift:6.0
steps:
- name: Checkout Repo
uses: actions/checkout@v4
- name: Lint Swift
run: swift run --package-path CLI swiftformat . --lint
20 changes: 20 additions & 0 deletions .swiftformat
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# format options
--indent tab
--modifierorder nonisolated,open,public,internal,fileprivate,private,private(set),final,override,required,convenience
--ranges no-space
--extensionacl on-declarations
--funcattributes prev-line
--typeattributes prev-line
--storedvarattrs same-line
--hexgrouping none
--decimalgrouping 3

# rules
--enable isEmpty
--enable wrapEnumCases
--enable wrapMultilineStatementBraces
--disable consistentSwitchCaseSpacing
--disable blankLineAfterSwitchCase

# global
--swiftversion 6.0
15 changes: 15 additions & 0 deletions CLI/Package.resolved
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions CLI/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// swift-tools-version: 6.0
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
name: "CLI",
platforms: [
.macOS(.v14),
],
products: [],
dependencies: [
.package(url: "https://github.com/nicklockwood/SwiftFormat", from: "0.56.1"),
],
targets: []
)
138 changes: 69 additions & 69 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,73 +4,73 @@
import PackageDescription

let package = Package(
name: "CacheAdvance",
platforms: [
.iOS(.v13),
.tvOS(.v13),
.watchOS(.v6),
.macOS(.v10_15),
.macCatalyst(.v13),
],
products: [
.library(
name: "CacheAdvance",
targets: ["CacheAdvance"]
),
.library(
name: "CADCacheAdvance",
targets: ["CADCacheAdvance"]
),
].filter {
#if os(Linux)
$0.name != "CADCacheAdvance"
#else
true
#endif
},
targets: [
.target(
name: "CacheAdvance",
swiftSettings: [
.swiftLanguageMode(.v6),
.define("SWIFT_PACKAGE_MANAGER")
]
),
.testTarget(
name: "CacheAdvanceTests",
dependencies: ["CacheAdvance", "LorumIpsum"],
swiftSettings: [
.swiftLanguageMode(.v6),
]
),
.target(
name: "CADCacheAdvance",
dependencies: ["CacheAdvance"],
swiftSettings: [
.swiftLanguageMode(.v6),
.define("SWIFT_PACKAGE_MANAGER")
]
),
.target(
name: "LorumIpsum",
dependencies: [],
swiftSettings: [
.swiftLanguageMode(.v6),
]
),
.testTarget(
name: "CADCacheAdvanceTests",
dependencies: ["CADCacheAdvance", "LorumIpsum"],
swiftSettings: [
.swiftLanguageMode(.v6),
]
),
].filter {
#if os(Linux)
$0.name != "CADCacheAdvance"
&& $0.name != "CADCacheAdvanceTests"
#else
true
#endif
}
name: "CacheAdvance",
platforms: [
.iOS(.v13),
.tvOS(.v13),
.watchOS(.v6),
.macOS(.v10_15),
.macCatalyst(.v13),
],
products: [
.library(
name: "CacheAdvance",
targets: ["CacheAdvance"]
),
.library(
name: "CADCacheAdvance",
targets: ["CADCacheAdvance"]
),
].filter {
#if os(Linux)
$0.name != "CADCacheAdvance"
#else
true
#endif
},
targets: [
.target(
name: "CacheAdvance",
swiftSettings: [
.swiftLanguageMode(.v6),
.define("SWIFT_PACKAGE_MANAGER"),
]
),
.testTarget(
name: "CacheAdvanceTests",
dependencies: ["CacheAdvance", "LorumIpsum"],
swiftSettings: [
.swiftLanguageMode(.v6),
]
),
.target(
name: "CADCacheAdvance",
dependencies: ["CacheAdvance"],
swiftSettings: [
.swiftLanguageMode(.v6),
.define("SWIFT_PACKAGE_MANAGER"),
]
),
.target(
name: "LorumIpsum",
dependencies: [],
swiftSettings: [
.swiftLanguageMode(.v6),
]
),
.testTarget(
name: "CADCacheAdvanceTests",
dependencies: ["CADCacheAdvance", "LorumIpsum"],
swiftSettings: [
.swiftLanguageMode(.v6),
]
),
].filter {
#if os(Linux)
$0.name != "CADCacheAdvance"
&& $0.name != "CADCacheAdvanceTests"
#else
true
#endif
}
)
Loading