Skip to content

Command Line Tool for Starting Your Swift Packages with Continuous Integration

License

Notifications You must be signed in to change notification settings

brightdigit/EggSeed

Repository files navigation

 

SwiftPM Twitter GitHub GitHub issues

macOS ubuntu arm Travis (.com) CircleCI Bitrise

Codecov CodeFactor Grade codebeat badge Code Climate maintainability Code Climate technical debt Code Climate issues Reviewed by Hound


EggSeed is a command-line tool for creating swift pacakges with continous integration support. While swift package init, creates simple packages, there is no guarantee that your package will work on everyone else's device. That's where continuous integration goes in.

By using eggseed, you can create a package with full integration into CI services such as: GitHub Actions, Travis-CI, BitRise, CircleCI and more. Not only that but EggSeed also sets up code documentation, linting, and more...

Check out the roadmap below for more details on future integrations.

Installation

mint install brightdigit/EggSeed

Swift Package Manager

Use as CLI

git clone https://github.com/brightdigit/EggSeed.git
cd EggSeed
swift run eggseed

Use as dependency

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

.package(url: "https://github.com/brightdigit/EggSeed.git", from: "0.2.0"),

And then import wherever needed: import EggSeed

Usage

USAGE: eggseed [--package-type <package-type>] [--user-name <user-name>] [--path <path>]

OPTIONS:
  --package-type <package-type>
                          Swift Package Type (default: library)
  --user-name <user-name> User name or Owner of Repostory. 
  --path <path>           Root path of the Swift Package. 
  -h, --help              Show help information.

Eggseed can be run without any options. However there are a few options which can help customize your package:

Package Type --package-type (library or executable)

Desginates what type of package you are creating.

User Name --user-name

The owner to user name of the repository. If not specified, EggSeed will attempt to parse the URL for that information.

Path --path

Directory to create the Swift Package in, otherwise use the current directory.

Documentation

All code documentation is here.

Roadmap

Future Released Will Include:

Feel free to add an issue for any suggestions.

Contact

Follow and contact me on Twitter. If you find an issue, just open a ticket on it. Pull requests are warmly welcome as well.

License

EggSeed is licensed under the MIT license. See LICENSE for more info.