Swift String Formatting Utilities

Utilities for formatting String objects in Swift.

Installation

Xcode Projects

Select File -> Swift Packages -> Add Package Dependency and enter https://github.com/CypherPoet/StringFormattingUtils.

Swift Package Manager Projects

You can add CypherPoetStringFormattingUtils as a package dependency in your Package.swift file:

let package = Package(
    //...
    dependencies: [
        .package(
            name: "CypherPoetStringFormattingUtils",
            url: "https://github.com/CypherPoet/StringFormattingUtils",
            .upToNextMinor(from: "0.1.0")
        ),
    ],
    //...
)

From there, refer to the StringFormattingUtils “product” delivered by the CypherPoetStringFormattingUtils “package” inside of any of your project’s target dependencies:

targets: [
    .target(
        name: "YourLibrary",
        dependencies: [
            .product(
                name: "StringFormattingUtils",
                package: "CypherPoetStringFormattingUtils"
            ),
        ],
        ...
    ),
    ...
]

Then simply import StringFormattingUtils wherever you’d like to use it.

Usage

🗺 Roadmap

• World Domination

Contributing

Contributions to CypherPoetStringFormattingUtils are most welcome. Check out some of the issue templates for more info.

💻 Developing

Requirements

• Xcode 13.0+

📜 Creating & Building Documentation

Documentation is built with Xcode’s DocC. See Apple’s guidance on how to build, run, and create DocC content.

For now, the best way to view the docs is to open the project in Xcode and run the Build Documentation command. At some point in the future, I’m hoping to leverage the tooling the develops for generating/hosting DocC documentation. (Please feel free to let me know if you have any ideas or tooling recommendations around this 🙂).

🏷 License

CypherPoetStringFormattingUtils is available under the MIT license. See the LICENSE file for more info.