README.md

AliasMacro

Swift Macro for defining aliases for types, functions, or variables.

Usage

A macro that can be attached to a type, function or variable.

Variable

You can define an alias for a variable as follows

class SomeClass {
    @Alias("title")
    var text: String = "hello"
}

/* ↓↓↓↓↓ */

let someClass = SomeClass()

print(text) // => "hello"
print(title) // => "hello"

Function/Method

You can define an alias for a function as follows. In this way, you can call both hello("aaa", at: Date()) and こんにちは("aaa", at: Date()).

class SomeClass {
    @Alias("こんにちは")
    func hello(_ text: String, at date: Date) {
        /* --- */
        print(text)
    }
}

/* ↓↓↓↓↓ */

let someClass = SomeClass()

someClass.hello("aaa", at: Date()) // => "aaa"
someClass.こんにちは("aaa", at: Date()) // => "aaa"

Customize Argument Label

Argument labels can also be customized by separating them with ":".

class SomeClass {
    @Alias("こんにちは::いつ")
    func hello(_ text: String, at date: Date) {
        /* --- */
        print(text)
    }

    @Alias("こんにちは2:_:_") // Omit argument labels
    func hello2(_ text: String, at date: Date) {
        /* --- */
        print(text)
    }

    @Alias("こんにちは3::宛") // The first argument label is inherited. The second is customized
    func hello3(_ text: String, at date: Date, to: String) {
        /* --- */
        print(text)
    }
}

/* ↓↓↓↓↓ */

let someClass = SomeClass()

someClass.hello("aaa", at: Date()) // => "aaa"
someClass.こんにちは("aaa", いつ: Date()) // => "aaa"

someClass.hello2("aaa", at: Date()) // => "aaa"
someClass.こんにちは2("aaa", Date()) // => "aaa"

someClass.hello3("aaa", at: Date(), to: "you") // => "aaa"
someClass.こんにちは3("aaa", at: Date(), 宛: "あなた") // => "aaa"

Enum Case

You can define alias for enum case.

For example, suppose we define the following.

enum Difficulty {
    @Alias("beginner")
    case easy

    @Alias("normal")
    case medium

    @Alias("challenge")
    case hard

    @Alias("extreme")
    case expert

    @Alias("ultimate")
    case master(level: Int)
}

At this time, the macro is expanded as follows.

enum Difficulty {
    case easy
    case medium
    case hard
    case expert
    case master(level: Int)

    static let beginner: Self = .easy
    static let normal: Self = .medium
    static let challenge: Self = .hard
    static let extreme: Self = .expert

    static func ultimate(level: Int) -> Self {
        .master(level)
    }
}

associatedtype

protocol APIRequest {
    @Alias("Reply")
    associatedtype Response
}

↓↓↓

protocol APIRequest {
    associatedtype Response

    typealias Reply = Response
}

Class/Struct/Enum/Actor

For example, the ViewController can also be referenced as a VC by writing the following. (If this macro is used for type, it is defined internally simply using typealias.)

Warning PeerMacro with arbitrary specified in names cannot be used in global scope. Restrictions on arbitrary names

@Alias("VC")
class ViewContoroller: UIViewController {
    /* --- */
}

/* ↓↓↓↓↓ */

print(ViewContoroller.self) // => "ViewController"
print(VC.self) // => "ViewController"

Multiple Aliases

Multiple aliases can be defined by adding multiple macros as follows

@Alias("hello")
@Alias("こんにちは")
var text: String = "Hello"

Specify Access Modifier of Alias

You can specify an alias access modifier as follows.

@Alias("hello", access: .public)
private var text: String = "Hello"

If set "inherit", it will inherit from the original definition.

@Alias("hello", access: .inherit)
private var text: String = "Hello"

License

AliasMacro is released under the MIT License. See LICENSE