jessesquires/ DefaultStringConvertible

(2.0.1) about 5 years ago

Ruby

Swift

Objective-C

Shell

View on GitHub

Need help with DefaultStringConvertible?

Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

jessesquires

121 Stars

7 Forks

MIT License

57 Commits

2 Opened issues

Description

[DEPRECATED] A default CustomStringConvertible implementation for Swift types

Services available

Need anything else?

Contributors list

Jesse Squires jessesquires

# 950

Objecti...

Swift

React

viewcon...

52 commits

Sergej Jaskiewicz broadwaylamb

# 22,545

Swift

swift5

watchos

protoco...

3 commits

Mathew Huusko V mhuusko5

# 363,122

CSS

Objecti...

Shell

1 commit

Readme

:warning: DEPRECATED :warning:

Name: DefaultStringConvertible
Brand: DefaultStringConvertible
SKU: //jessesquires/DefaultStringConvertible
Rating: 2.0525 (121 reviews)

DefaultStringConvertible

A default

CustomStringConvertible

implementation for Swift types

About

Never implement

var description: String

again. Simply

import DefaultStringConvertible

and conform to

CustomStringConvertible

and get a default type description for free.

This micro-library is based on this post from Erica Sadun.

Requirements

Swift 3
Xcode 8
iOS 8.0+
macOS 10.10+
tvOS 9.0+
watchOS 2.0+
Ubuntu 14.04+

Installation

CocoaPods (recommended)

use_frameworks!

For latest release in cocoapods

pod 'DefaultStringConvertible'

Feeling adventurous? Get the latest on develop

pod 'DefaultStringConvertible', :git => 'https://github.com/jessesquires/DefaultStringConvertible.git', :branch => 'develop'

Carthage

github "jessesquires/DefaultStringConvertible"

Swift Package Manager

Add DefaultStringConvertible as a dependency to your

Package.swift

. For example:

let package = Package(
    name: "YourPackageName",
    dependencies: [
        .Package(url: "https://github.com/jessesquires/DefaultStringConvertible.git", majorVersion: 2)
    ]
)

Documentation

Read the docs. Generated with jazzy. Hosted by GitHub Pages.

Generate

$ ./build_docs.sh

Preview

$ open index.html -a Safari

Getting Started

import DefaultStringConvertible

class MyClass: CustomStringConvertible {
    // ...
// You *do not* need to implement `var description: String`
// by importing `DefaultStringConvertible`, you get a default `description` for free
}

Unit tests

There's a suite of unit tests for

DefaultStringConvertible

. Run them from Xcode by opening

DefaultStringConvertible.xcodeproj

Contribute

Please follow these sweet contribution guidelines.

Credits

Created and maintained by @jesse_squires.

License

DefaultStringConvertible

is released under an MIT License. See

LICENSE

for details.

Copyright © 2016-present Jesse Squires.

Please provide attribution, it is greatly appreciated.