├── .gitignore ├── .swiftformat ├── .swiftpm └── xcode │ └── package.xcworkspace │ └── xcshareddata │ └── IDEWorkspaceChecks.plist ├── LICENSE ├── Package.resolved ├── Package.swift ├── README.md ├── Sources ├── StaticLogger │ └── StaticLogger.swift └── StaticLoggerMacros │ └── StaticLoggerMacro.swift └── Tests └── StaticLoggerTests └── StaticLoggerTests.swift /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | /.build 3 | /Packages 4 | xcuserdata/ 5 | DerivedData/ 6 | .swiftpm/configuration/registries.json 7 | .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata 8 | .netrc 9 | -------------------------------------------------------------------------------- /.swiftformat: -------------------------------------------------------------------------------- 1 | --enable blankLineAfterImports 2 | --enable blankLinesBetweenImports 3 | --enable blockComments 4 | --enable docComments 5 | --enable isEmpty 6 | --enable markTypes 7 | --enable organizeDeclarations 8 | 9 | --disable numberFormatting 10 | --disable redundantNilInit 11 | --disable trailingCommas 12 | --disable wrapMultilineStatementBraces 13 | 14 | --ifdef no-indent 15 | --funcattributes same-line 16 | --typeattributes same-line 17 | --varattributes same-line 18 | --ranges no-space 19 | --header strip 20 | --selfrequired log,debug,info,notice,warning,trace,error,critical,fault 21 | -------------------------------------------------------------------------------- /.swiftpm/xcode/package.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | IDEDidComputeMac32BitWarning 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | -------------------------------------------------------------------------------- /Package.resolved: -------------------------------------------------------------------------------- 1 | { 2 | "pins" : [ 3 | { 4 | "identity" : "swift-syntax", 5 | "kind" : "remoteSourceControl", 6 | "location" : "https://github.com/swiftlang/swift-syntax.git", 7 | "state" : { 8 | "revision" : "64889f0c732f210a935a0ad7cda38f77f876262d", 9 | "version" : "509.1.1" 10 | } 11 | } 12 | ], 13 | "version" : 2 14 | } 15 | -------------------------------------------------------------------------------- /Package.swift: -------------------------------------------------------------------------------- 1 | // swift-tools-version: 5.9 2 | 3 | import CompilerPluginSupport 4 | import PackageDescription 5 | 6 | let package = Package( 7 | name: "StaticLogger", 8 | platforms: [.macOS(.v11), .iOS(.v14), .tvOS(.v14), .watchOS(.v7), .macCatalyst(.v14)], 9 | products: [ 10 | .library( 11 | name: "StaticLogger", 12 | targets: ["StaticLogger"] 13 | ) 14 | ], 15 | dependencies: [ 16 | .package(url: "https://github.com/swiftlang/swift-syntax.git", from: "509.0.0"), 17 | ], 18 | targets: [ 19 | .macro( 20 | name: "StaticLoggerMacros", 21 | dependencies: [ 22 | .product(name: "SwiftSyntaxMacros", package: "swift-syntax"), 23 | .product(name: "SwiftCompilerPlugin", package: "swift-syntax") 24 | ] 25 | ), 26 | .target(name: "StaticLogger", dependencies: ["StaticLoggerMacros"]), 27 | .testTarget( 28 | name: "StaticLoggerTests", 29 | dependencies: [ 30 | "StaticLoggerMacros", 31 | .product(name: "SwiftSyntaxMacrosTestSupport", package: "swift-syntax"), 32 | ] 33 | ), 34 | ] 35 | ) 36 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # StaticLogger 2 | [![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FFinnvoor%2FStaticLogger%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/Finnvoor/StaticLogger) 3 | 4 | A simple Swift macro that adds a static `logger` method to a class, struct, actor, or enum, with a default subsystem and category based on the bundle identifier and type name. 5 | 6 | ## Usage 7 | 8 | ```swift 9 | import OSLog 10 | import StaticLogger 11 | 12 | @StaticLogger 13 | struct MyStruct { 14 | let x: Int 15 | 16 | func test() { 17 | Self.logger.debug("X is \(x)") 18 | } 19 | } 20 | ``` 21 | 22 | Expands to: 23 | 24 | ```swift 25 | struct MyStruct { 26 | let x: Int 27 | 28 | func test() { 29 | Self.logger.debug("X is \(x)") 30 | } 31 | 32 | static let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "", category: "MyStruct") 33 | } 34 | ``` 35 | 36 | You can also override the logger's subsystem or category by passing them to `@StaticLogger`: 37 | 38 | ```swift 39 | @StaticLogger(subsystem: "MySubsystem", category: "MyCategory") 40 | ``` 41 | -------------------------------------------------------------------------------- /Sources/StaticLogger/StaticLogger.swift: -------------------------------------------------------------------------------- 1 | /// Adds a static `logger` member to the type. 2 | /// - Parameters: 3 | /// - subsystem: An optional subsystem for the logger to use. Defaults to `Bundle.main.bundleIdentifier`. 4 | /// - category: An optional category for the logger to use. Defaults to `String(describing: Self.self)`. 5 | @attached(member, names: named(logger)) public macro StaticLogger( 6 | subsystem: String? = nil, 7 | category: String? = nil 8 | ) = #externalMacro(module: "StaticLoggerMacros", type: "StaticLogger") 9 | -------------------------------------------------------------------------------- /Sources/StaticLoggerMacros/StaticLoggerMacro.swift: -------------------------------------------------------------------------------- 1 | import SwiftCompilerPlugin 2 | import SwiftDiagnostics 3 | import SwiftSyntax 4 | import SwiftSyntaxBuilder 5 | import SwiftSyntaxMacros 6 | 7 | // MARK: - StaticLogger 8 | 9 | public struct StaticLogger: MemberMacro { 10 | public static func expansion( 11 | of node: SwiftSyntax.AttributeSyntax, 12 | providingMembersOf declaration: some SwiftSyntax.DeclGroupSyntax, 13 | in _: some SwiftSyntaxMacros.MacroExpansionContext 14 | ) throws -> [SwiftSyntax.DeclSyntax] { 15 | guard let declarationName = declaration.as(ClassDeclSyntax.self)?.name.text ?? declaration.as(StructDeclSyntax.self)?.name.text ?? declaration.as(ActorDeclSyntax.self)?.name.text ?? declaration.as(EnumDeclSyntax.self)?.name.text else { 16 | throw Error.unknownDeclaration 17 | } 18 | 19 | let subsystem: String? = if case let .argumentList(arguments) = node.arguments { 20 | Array(arguments) 21 | .first(where: { $0.label?.text == "subsystem" })? 22 | .expression 23 | .as(StringLiteralExprSyntax.self)? 24 | .representedLiteralValue 25 | } else { 26 | nil 27 | } 28 | 29 | let category: String? = if case let .argumentList(arguments) = node.arguments { 30 | Array(arguments) 31 | .first(where: { $0.label?.text == "category" })? 32 | .expression 33 | .as(StringLiteralExprSyntax.self)? 34 | .representedLiteralValue 35 | } else { 36 | nil 37 | } 38 | 39 | let syntaxNodeString = "static let logger = Logger(subsystem: \(subsystem != nil ? "\"\(subsystem!)\"" : "Bundle.main.bundleIdentifier ?? \"\""), category: \"\(category != nil ? category! : declarationName)\")" 40 | 41 | return try [DeclSyntax(VariableDeclSyntax(.init(stringLiteral: syntaxNodeString)))] 42 | } 43 | } 44 | 45 | // MARK: StaticLogger.Error 46 | 47 | extension StaticLogger { 48 | enum Error: Swift.Error, CustomStringConvertible { 49 | case unknownDeclaration 50 | 51 | // MARK: Internal 52 | 53 | var description: String { 54 | switch self { 55 | case .unknownDeclaration: 56 | "Unknown declaration — StaticLogger must be used on a class, struct, actor, or enum" 57 | } 58 | } 59 | } 60 | } 61 | 62 | // MARK: - StaticLoggerPlugin 63 | 64 | @main struct StaticLoggerPlugin: CompilerPlugin { 65 | let providingMacros: [Macro.Type] = [ 66 | StaticLogger.self, 67 | ] 68 | } 69 | -------------------------------------------------------------------------------- /Tests/StaticLoggerTests/StaticLoggerTests.swift: -------------------------------------------------------------------------------- 1 | import SwiftSyntaxMacros 2 | import SwiftSyntaxMacrosTestSupport 3 | import XCTest 4 | 5 | #if canImport(StaticLoggerMacros) 6 | import StaticLoggerMacros 7 | 8 | let testMacros: [String: Macro.Type] = [ 9 | "StaticLogger": StaticLogger.self, 10 | ] 11 | #endif 12 | 13 | // MARK: - StaticLoggerTests 14 | 15 | final class StaticLoggerTests: XCTestCase { 16 | func testDefaults() throws { 17 | #if canImport(StaticLoggerMacros) 18 | assertMacroExpansion( 19 | """ 20 | @StaticLogger 21 | struct MyStruct { 22 | let x: Int 23 | } 24 | """, 25 | expandedSource: """ 26 | struct MyStruct { 27 | let x: Int 28 | 29 | static let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "", category: "MyStruct") 30 | } 31 | """, 32 | macros: testMacros 33 | ) 34 | #else 35 | throw XCTSkip("macros are only supported when running tests for the host platform") 36 | #endif 37 | } 38 | 39 | func testSubsystem() throws { 40 | #if canImport(StaticLoggerMacros) 41 | assertMacroExpansion( 42 | """ 43 | @StaticLogger(subsystem: "MySubsystem") 44 | struct MyStruct { 45 | let x: Int 46 | } 47 | """, 48 | expandedSource: """ 49 | struct MyStruct { 50 | let x: Int 51 | 52 | static let logger = Logger(subsystem: "MySubsystem", category: "MyStruct") 53 | } 54 | """, 55 | macros: testMacros 56 | ) 57 | #else 58 | throw XCTSkip("macros are only supported when running tests for the host platform") 59 | #endif 60 | } 61 | 62 | func testCategory() throws { 63 | #if canImport(StaticLoggerMacros) 64 | assertMacroExpansion( 65 | """ 66 | @StaticLogger(category: "MyCategory") 67 | struct MyStruct { 68 | let x: Int 69 | } 70 | """, 71 | expandedSource: """ 72 | struct MyStruct { 73 | let x: Int 74 | 75 | static let logger = Logger(subsystem: Bundle.main.bundleIdentifier ?? "", category: "MyCategory") 76 | } 77 | """, 78 | macros: testMacros 79 | ) 80 | #else 81 | throw XCTSkip("macros are only supported when running tests for the host platform") 82 | #endif 83 | } 84 | 85 | func testSubsystemAndCategory() throws { 86 | #if canImport(StaticLoggerMacros) 87 | assertMacroExpansion( 88 | """ 89 | @StaticLogger(subsystem: "MySubsystem", category: "MyCategory") 90 | struct MyStruct { 91 | let x: Int 92 | } 93 | """, 94 | expandedSource: """ 95 | struct MyStruct { 96 | let x: Int 97 | 98 | static let logger = Logger(subsystem: "MySubsystem", category: "MyCategory") 99 | } 100 | """, 101 | macros: testMacros 102 | ) 103 | #else 104 | throw XCTSkip("macros are only supported when running tests for the host platform") 105 | #endif 106 | } 107 | } 108 | --------------------------------------------------------------------------------