SwiftMacros

KO | EN

gitlite — search

#hacktoberfest #react #llm #go #golang #android #machine-learning #rust #java #nodejs #windows #kubernetes #pytorch #mcp

(★ 65)

A practical collection of Swift Macros that help code correctly and swiftly.

SwiftMacros 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SwiftMacros

A practical collection of Swift Macros that help code correctly and swiftly.

## Install

.package(url: "https://github.com/ShenghaiWang/SwiftMacros.git", from: "2.0.0")

## Macros [API Doc](https://m.timwang.au/swiftmacros/documentation/swiftmacros/)

| Macro | Description |
|------------|------------------------------------------------------------|
| @Access |An easy API to access UserDefaults, Keychain, NSCache and NSMapTable. |
| |<pre>struct TestAccess { static let cache = NSCache<NSString, AnyObject>() // Please make sure the generic type is the same as the type of the variable // Without defalut value @Access<Bool?>(.userDefaults()) var isPaidUser: Bool? // With default value @Access< Bool>(.userDefaults()) var isPaidUser2: Bool = false @Access<NSObject?>(.nsCache(TestAccess.cache)) var hasPaid: NSObject? @Access<NSObject?>(.nsMapTable(TestAccess.mapTable)) var hasPaid2: NSObject? @Access<TestStruct?>(.keychain) var keychainValue: TestStruct? }</pre>|
|@AddAssociatedValueVariable|Add variables to retrieve the associated values|
| |<pre>@AddAssociatedValueVariable enum MyEnum { case first case second(Int) case third(String, Int) case forth(a: String, b: Int), forth2(String, Int) case fifth(() -> Void) }</pre>|
| @AddInit |Generate initialiser for the class/struct/actor. The variables with optional types will have nil as default values. Using `withMock: true` if want to generate mock data. For custmoised data type, it will use `Type.mock`. In case there is no this value, need to define this yourself or use `@Mock` or `@AddInit(withMock: true)` to generate this variable. |
| @AddPublisher |Generate a Combine publisher to a Combine subject in order to avoid overexposing subject variable |
| |<pre>@AddPublisher private let mySubject = PassthroughSubject<Void, Never>()</pre>|
| |<pre>@AddInit struct InitStruct { let a: Int let b: Int? let c: (Int?) -> Void let d: ((Int?) -> Void)? } @AddInit(withMock: true) class AStruct { let a: Float }</pre>|
| #buildDate |Build a Date from components This solution addes in a resultBulder `DateBuilder`, which can be used directly if prefer builder pattern. Note: this is for a simpler API. Please use it with caution in places that require efficiency.|
| |<pre>let date = #buildDate(DateString("03/05/2003", dateFormat: "MM/dd/yyyy"), Date(), Month(10), Year(1909), YearForWeekOfYear(2025))</pre>|
| #buildURL |Build a url from components. This solution addes in a resultBulder `URLBuilder`, which can be used directly if prefer builder pattern. |
| |<pre>let url = #buildURL("http://google.com", URLScheme.https, URLQueryItems([.init(name: "q1", value: "q1v"), .init(name: "q2", value: "q2v")])) let url2 = buildURL { "http://google.com" URLScheme.https URLQueryItems([.init(name: "q1", value: "q1v"), .init(name: "q2", value: "q2v")]) }</pre>|
| #buildURLRequest |Build a URLRequest from components. This solution addes in a resultBulder `URLRequestBuilder`, which can be used directly if prefer builder pattern. |
| |<pre>let urlrequest = #buildURLRequest(url!, RequestTimeOutInterval(100)) let urlRequest2 = buildURLRequest { url! RequestTimeOutInterval(100) }</pre>|
| @ConformToEquatable|Add Equtable conformance to a class type Use it with caution per https://github.com/apple/swift-evolution/blob/main/proposals/0185-synthesize-equatable-hashable.md#synthesis-for-class-types-and-tuples|
| |<pre>@AddInit @ConformToEquatable class AClass { let a: Int? let b: () -> Void }</pre>|
| @ConformToHashable|Add Hashable conformance to a class type Use it with caution per https://github.com/apple/swift-evolution/blob/main/proposals/0185-synthesize-equatable-hashable.md#synthesis-for-class-types-and-tuples|
| |<pre>@AddInit @ConformToHashable class AClass { let a: Int? let b: () -> Void }</pre>|
| #encode |Encode an Encodable to data using JSONEncoder |
| |<pre>#encode(value)</pre>|
| #decode |Decode a Decodable to a typed value using JSONDecoder |
| |<pre>#decode(TestStruct.self, from: data)</pre>|
| #formatDate |Format date to a string |
| |<pre>#formatDate(Date(), dateStyle: .full)</pre>|
| #formatDateComponents |Format date differences/timeinterval/date components to a string |
| |<pre>#formatDateComponents(from: Date(), to: Date(), allowedUnits: [.day, .hour, .minute, .second]) #formatDateComponents(fromInterval: 100, allowedUnits: [.day, .hour, .minute, .second]) #formatDateComponents(fromComponents: DateComponents(hour: 10), allowedUnits: [.day, .hour, .minute, .second])</pre>|
| #formatDateInterval |Format two dates into interval string |
| |<pre>#formatDateInterval(from: Date(), to: Date(), dateStyle: .short)</pre>|
| @Mock |Generate a static variable `mock` using the attached initializer. For custmoised data type, it will use `Type.mock`. In case there is no this value, need to define this yourself or use `@Mock` or `@AddInit(withMock: true)` to generate this variable. |
| |<pre>class AStruct { let a: Float @Mock(type: AStruct.self) init(a: Float) { self.a = a } }</pre>|
| #postNotification | An easy way to post notifications |
| |<pre>#postNotification(.NSCalendarDayChanged)</pre>|
| @Singleton |Generate Swift singleton code for struct and class types |
| |<pre>@Singleton struct A {}</pre>|

## To be added

Please feel free to add the macros you want here. All PRs(with or without implementations) are welcome.

| Macro | Description  |
|------------|------------------------------------------------------------|
| @          |  Your new macro ideas |

SwiftMacros

SwiftMacros 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

SwiftMacros

SwiftMacros 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README