search

yonaskolb / Mint

A package manager that installs and runs executable Swift packages
MIT License
2.29k stars 123 forks source link
command-line-tool dependency-manager installer package-manager spm swift

readme

Mint 🌱

Swift Versions Platforms Git Version License

A package manager that installs and runs Swift command line tool packages.

mint run realm/SwiftLint@0.40.3

This would install and run SwiftLint version 0.40.3

Mint is designed to be used with Swift command line tools that build with the Swift Package Manager. It makes installing, running and distributing these tools much easier.

Homebrew is a popular method of distributing Swift executables, but that requires creating a formula and then maintaining that formula. Running specific versions of homebrew installations can also be tricky as only one global version is installed at any one time. Mint installs your package via SPM and lets you run multiple versions of that package, which are installed and cached in a central place.

If your Swift executable package builds with SPM, then it can be run with Mint! See Support for details.

Why is it called Mint?

Swift Package Manager Tools -> SPMT -> Spearmint -> Mint! 🌱😄

Mint: a place where something is produced or manufactured

Installing

Make sure Xcode 10.2 is installed first.

Homebrew

brew install mint

Make

git clone https://github.com/yonaskolb/Mint.git
cd Mint
make

Using Mint itself!

Install
git clone https://github.com/yonaskolb/Mint.git
cd Mint
swift run mint install yonaskolb/mint
Update
mint install yonaskolb/mint

Swift Package Manager

Use CLI

git clone https://github.com/yonaskolb/Mint.git
cd Mint
swift run mint

Use as dependency

Add the following to your Package.swift file's dependencies:

.package(url: "https://github.com/yonaskolb/Mint.git", from: "0.15.0"),

And then import wherever needed: import MintKit

Road to 1.0

Until 1.0 is reached, minor versions will be breaking.

Usage

Run mint help to see usage instructions.

Package reference

run and install commands require a package reference parameter. This can be a shorthand for a github repo (mint install realm/SwiftLint) or a fully qualified git path (mint install https://github.com/realm/SwiftLint.git). In the case of run you can also just pass the name of the repo if it is already installed (run swiftlint) or in the Mintfile. An optional version can be specified by appending @version, otherwise the newest tag or master will be used. Note that if you don't specify a version, the current tags must be loaded remotely each time.

Examples

$ mint run yonaskolb/XcodeGen@2.18.0 # run the only executable
$ mint run yonaskolb/XcodeGen@2.18.0 --spec spec.yml # pass some arguments
$ mint run yonaskolb/XcodeGen@2.18.0 xcodegen --spec spec.yml # specify a specific executable
$ mint run --executable xcodegen yonaskolb/XcodeGen@2.18.0 --spec spec.yml # specify a specific executable in case the first argument is the same name as the executable
$ mint install yonaskolb/XcodeGen@2.18.0 --no-link # installs a certain version but doesn't link it globally
$ mint install yonaskolb/XcodeGen # install newest tag
$ mint install yonaskolb/XcodeGen@master --force #reinstall the master branch
$ mint run yonaskolb/XcodeGen@2.18.0 # run 2.18.0
$ mint run XcodeGen # use newest tag and find XcodeGen in installed packages

Linking

By default Mint symlinks your installs into ~/.mint/bin on mint install, unless --no-link is passed. This means a package will be accessible from anywhere, and you don't have to prepend commands with mint run package, as long as you add ~/.mint/bin to your $PATH. Note that only one linked version can be used at a time. If you need to run a specific older version use mint run.

Mintfile

A Mintfile can specify a list of versioned packages. It makes installing and running these packages easy, as the specific repos and versions are centralized.

Simply place this file in the directory you're running Mint in. The format of the Mintfile is simply a list of packages in the same form as the usual package parameter:

yonaskolb/xcodegen@2.18.0
yonaskolb/genesis@0.4.0

Then you can simply run a package using:

mint run xcodegen

Note that mint will find the version declared in your Mintfile and run that version, even if you have multiple versions installed.

Or install all the packages (without linking them globally) in one go with:

mint bootstrap

If you prefer to link them globally, do such with:

mint bootstrap --link

Advanced

Linux

Mint works on Linux but has some limitations:

Support

If your Swift command line tool builds with the Swift Package Manager than it will automatically install and run with mint!

Make sure you have defined an executable product type in the products list within your Package.swift.

let package = Package(
    name: "Foo",
    products: [
        .executable(name: "foo", targets: ["Foo"]),
    ],
    targets: [
      .target(name: "Foo"),
      ...
    ]
)

You can then add this to the Installing section in your readme:

### [Mint](https://github.com/yonaskolb/mint)

mint run github_name/repo_name

Resources

Since Swift 5.3 resources are now built into the Swift Package manager, so if you're targetting that version or above the Package.resources file is no longer necessary https://github.com/apple/swift-evolution/blob/master/proposals/0271-package-manager-resources.md

The Swift Package Manager doesn't yet have a way of specifying resources directories. If your tool requires access to resources from the repo you require a custom Package.resources file. This is a plain text file that lists the resources directories on different lines:

MyFiles
MyOtherFiles

If this file is found in you repo, then all those directories will be copied into the same path as the executable.

A list of popular Mint compatible packages 🌱

Feel free to add your own!