Skip to content

Latest commit

 

History

History
92 lines (68 loc) · 2.99 KB

only_xcode.md

File metadata and controls

92 lines (68 loc) · 2.99 KB
Raw

Xcode only install

Whoah, so, welcome to using Swift Package Manager (SwiftPM). Given work in SwiftPM has so far been focused on server-side Swift, it's not really had wide-spread adoption, but a lot of the useful third-party eco-system tools support it:

and... well...

Maybe there's enough support that now is the time to move these sort of dependencies into a package manager.

Getting started

To get started, you need to be on a Mac with Xcode 10+ installed. This means you already have Swift Package Manager available.

The Package.swift file is basically the same thing as a Podfile + Podspec combined, it combines all of your app and tooling dependencies in one places.

Because we're not going to be using Swift PM for building apps/libraries/etc then the default template isn't useful for us.

Here's what it looks like in the Artsy app, Eigen:

// swift-tools-version:4.2
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    name: "[eigen]",
    dependencies: [
      .package(url: "https://github.com/shibapm/Komondor.git", from: "1.0.0")
    ],
    targets: [
        // This is just an arbitrary Swift file in the app, that has
        // no dependencies outside of Foundation
        .target(name: "eigen", dependencies: [], path: "Artsy", sources: ["Stringify.swift"]),
    ]
)

Note: See that target? You must have a target (right now) in your Package.swift in order to use tools that come from your dependencies. Find a single source file that you can call the package with, using the path: to find its folder, and then sources: to set up that one target.

This adds Komondor to the app, and allows you to run the CLI for Komondor, you can verify by running swift run komondor and seeing the help message.

Next up: adding your git hooks to the config:

      .package(url: "https://github.com/shibapm/Komondor.git", from: "1.0.0")
    ]
)

+ #if canImport(PackageConfig)
+     import PackageConfig
+
+     let config = PackageConfiguration([
+         "komondor": [
+             "pre-commit": "echo 'Hi'"
+         ],
+     ])
+ #endif

This config is "[git hook]": ["command"], you can read more here.

Final step: run swift run komondor install, this will set up your git-hooks. If you git add . and git commit -m "Added Komondor" to the app, it will run the git-hooks and echo "Hi" to the terminal.

What now?

Improve your docs, for developers setting up your app for the first time, they will need to run:

git clone https://github.com/my/app
cd app

bundle install
bundle exec pod install
+ swift run komondor install