owensd / apous Goto Github PK

Let's make Swift scripting a reality.

License: MIT License

Swift 83.30% Shell 7.59% Makefile 9.11%

apous's Introduction

 _______
|   _   .-----.-----.--.--.-----.
|.  1   |  _  |  _  |  |  |__ --|
|.  _   |   __|_____|_____|_____|
|:  |   |__|
|::.|:. |
`--- ---'

Apous

Apous is a simple tool that allows for easier authoring of Swift scripts.

Primary features:

Allow the breaking up of scripts into multiple files.
Dependency management through Carthage or CocoaPods.

How it Works

Apous works by first checking for a Cartfile or Podfile in your script's directory. If one is present, then carthage update or pod install --no-integrate will be run.

Next, all of your Swift files are compiled into a single .apousscript binary that will then be run automatically for you.

It's really that simple.

Getting Started

First, you need to install the latest build of Apous.

Download the latest version of apous from "Releases".
Copy it to a location in your path, such as /usr/local/bin/.

Homebrew support is pending: Homebrew/legacy-homebrew#41473

Creating Your First Script

Create a new directory for your scripts, say mkdir demo
Change to that directory: cd demo
Create a new script file: touch demo.swift

Change the contents of the file to:

import Foundation

print("Welcome to Apous!")

Run the script: apous .

This will output:

Welcome to Apous!

You can see some other samples here: Samples.

Alternatively

Apous also supports running scripts with #!. Note that your entry point script must be named main.swift.

#!/usr/local/bin/apous

import Foundation

print("Welcome to Apous!")

Then run:

> chmod +x main.swift
> ./main.swift
Welcome to Apous!

FAQ

Q: What is Apous mean?

A: It's from the ancient Greek απους, meaning "without feet".

apous's People

Contributors

Stargazers

Watchers

Forkers

orta neonichu rayfix weekenlee levicn mrackwitz smile7827 carabina z415073783

apous's Issues

Figure out what is the deal with stdout interception.

OMG!

Support for folder structure packages.

Add support for nest folders as packages and package dependencies.

main.swift
    io/
        path/
    sys/

Each of the folders could be packages and/or dependencies, and most importantly, not require and Xcode project to build.

Fix the versioning system so it's automatic.

Add caching support

A script that hasn't changed shouldn't need to be recompiled. Make sure this recompile isn't happening.

Add support for Travis CI.

Add support for files without extensions, also for files not named main.swift

For example, if I were to create a file called main.swift and fill it with:

#!/usr/local/bin/apous
print("Hello, World!")

then executing the following:

$ chmod +x main.swift
$ ./main.swift

Would simply output

Hello, World!

However, if I were to rename it to just main, or main1.swift, it starts throwing errors:

$ ./main
<unknown>:0: error: no input files

$ ./main1.swift
Only a 'main.swift' file can be specified.

If I wanted to, for example, have a build script created through apous, calling the file main.swift would be sort of ridiculous, setup or install makes much more sense.

Just a few thoughts - I really like apous either way 👍

xcrun parameters missing?

I created the following script:

#!/usr/local/bin/apous

import Foundation
import CommonMark
import LiterateSwift

print("Hello")

And the following Podfile:

platform :osx, 10.9

plugin 'cocoapods-rome'

use_frameworks!

pod 'CommonMark'
pod 'LiterateSwift'

However, when I run it, I get the following error (regardless of whether I take the hasbang approach or compile everything).

<unknown>:0: error: cannot load underlying module for CoreGraphics
<unknown>:0: note: did you forget to set an SDK using -sdk or SDKROOT?
<unknown>:0: note: use "xcrun -sdk macosx swift" to select the default OS X SDK installed with Xcode

Add support for git submodules.

In the title.

Support running under both iOS and OS X.

Currently only OS X is supported for the script; support iOS too.

Support for nested directories.

It may be advantageous to be able to store scripts in nested folders.

main.swift
    /utils
        util1.swift
        util2.swift

Currently, these will be ignored. This will likely tie into issue #2 as we think about free-floating packages that are not tied to an Xcode project.

Add proper commanding

The CLI interface is a hack, needs to have proper support for commands:

apous update
apous help
apous run [path/to/scripts]
apous edit
apous init

etc...