mirror of
https://github.com/apple/swift-log
synced 2026-11-22 03:40:39 +00:00
Add CMake build support to the project to enable toolchain integration and bootstrapping compatibility. ### Motivation: Currently, swift-log does not support building with CMake. This addition resolves issue #484, allowing swift-log to be resolved and compiled within CMake-based environments (like the repos swift-certificates and swift-argument-parser which aer mentioned in the issue). ### Modifications: 1. **Project Root Config:** Added [CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/CMakeLists.txt) configuring the CMake project with Swift 6 and C, alongside setting up compiler flags for MSVC runtime library on Windows. 2. **Helper Modules:** Added the `cmake/` folder: - `SwiftSupport.cmake`: dylib/module installations and triple detection helper. - `SwiftLogConfig.cmake.in`: package config export templates. 3. **Target CMake Configurations:** Created [Sources/Logging/CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/Sources/Logging/CMakeLists.txt) & [Sources/InMemoryLogging/CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/Sources/InMemoryLogging/CMakeLists.txt) to define the library targets. Included generator expressions pointing `INTERFACE_INCLUDE_DIRECTORIES` to target output directories for Xcode generator support. 4. **SwiftPM Exclusions:** Excluded the new CMake files from target targets inside [Package.swift](file:///Users/adityamitra/Developer/swift-log/Package.swift) and [Package@swift-6.1.swift](file:///Users/adityamitra/Developer/swift-log/Package@swift-6.1.swift) to keep SwiftPM targets warning-free. 5. **Compile Options Variable:** Consolidates compile options under a single global definition `SWIFT_LOG_COMMON_COMPILE_OPTIONS` in the root configuration, enabling Swift 6 compiler features (`ExistentialAny`, `MemberImportVisibility`, `InternalImportsByDefault`, `NonisolatedNonsendingByDefault`, and explicit Sendable checks) across all targets. 6. **CI Integration & Workflow:** Integrated CMake CI validation in `.github/workflows/pull_request.yml` using the shared workflow from `apple/swift-nio/.github/workflows/cmake_tests.yml@main` running in a `swift:6.1-jammy` container. This job compiles the core libraries and verifies the validity of the CMake files. 7. **License Header Compliance:** Cleaned up license headers across all CMake files ### Result: * **SwiftPM:** All 164 unit tests compile and pass successfully under `swift test` with no warnings. * **CMake:** Successfully compiles (`** BUILD SUCCEEDED **`) under Xcode generator (`cmake -B build -G Xcode && cmake --build build`). ### Issue Tracking: Fixes #484 --------- Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com>
77 lines
2.9 KiB
Swift
77 lines
2.9 KiB
Swift
// swift-tools-version:6.2
|
|
|
|
import PackageDescription
|
|
|
|
let package = Package(
|
|
name: "swift-log",
|
|
products: [
|
|
.library(name: "Logging", targets: ["Logging"]),
|
|
.library(name: "InMemoryLogging", targets: ["InMemoryLogging"]),
|
|
],
|
|
traits: [
|
|
.trait(name: "MaxLogLevelDebug", description: "Debug and above available (compiles out trace)"),
|
|
.trait(name: "MaxLogLevelInfo", description: "Info and above available (compiles out trace, debug)"),
|
|
.trait(name: "MaxLogLevelNotice", description: "Notice and above available (compiles out trace, debug, info)"),
|
|
.trait(
|
|
name: "MaxLogLevelWarning",
|
|
description: "Warning and above available (compiles out trace, debug, info, notice)"
|
|
),
|
|
.trait(
|
|
name: "MaxLogLevelError",
|
|
description: "Error and above available (compiles out trace, debug, info, notice, warning)"
|
|
),
|
|
.trait(name: "MaxLogLevelCritical", description: "Only critical available (compiles out all except critical)"),
|
|
.trait(name: "MaxLogLevelNone", description: "All logging compiled out (no log levels available)"),
|
|
|
|
// By default, no traits are enabled (all log levels available)
|
|
.default(enabledTraits: []),
|
|
],
|
|
targets: [
|
|
.target(
|
|
name: "Logging",
|
|
dependencies: [],
|
|
exclude: ["CMakeLists.txt"]
|
|
),
|
|
.target(
|
|
name: "InMemoryLogging",
|
|
dependencies: ["Logging"],
|
|
exclude: ["CMakeLists.txt"]
|
|
),
|
|
.testTarget(
|
|
name: "LoggingTests",
|
|
dependencies: ["Logging"],
|
|
exclude: ["CMakeLists.txt"]
|
|
),
|
|
.testTarget(
|
|
name: "InMemoryLoggingTests",
|
|
dependencies: ["InMemoryLogging", "Logging"],
|
|
exclude: ["CMakeLists.txt"]
|
|
),
|
|
]
|
|
)
|
|
|
|
for target in package.targets
|
|
where [.executable, .test, .regular].contains(
|
|
target.type
|
|
) {
|
|
var settings = target.swiftSettings ?? []
|
|
|
|
// https://github.com/apple/swift-evolution/blob/main/proposals/0335-existential-any.md
|
|
// Require `any` for existential types.
|
|
settings.append(.enableUpcomingFeature("ExistentialAny"))
|
|
|
|
// https://github.com/swiftlang/swift-evolution/blob/main/proposals/0444-member-import-visibility.md
|
|
settings.append(.enableUpcomingFeature("MemberImportVisibility"))
|
|
|
|
// https://github.com/swiftlang/swift-evolution/blob/main/proposals/0409-access-level-on-imports.md
|
|
settings.append(.enableUpcomingFeature("InternalImportsByDefault"))
|
|
|
|
// https://docs.swift.org/compiler/documentation/diagnostics/nonisolated-nonsending-by-default/
|
|
settings.append(.enableUpcomingFeature("NonisolatedNonsendingByDefault"))
|
|
|
|
// Ensure all public types are explicitly annotated as Sendable or not Sendable.
|
|
settings.append(.unsafeFlags(["-Xfrontend", "-require-explicit-sendable"]))
|
|
|
|
target.swiftSettings = settings
|
|
}
|