dnrops
/
carton
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add --destination option to the `carton dev` command (#18) 

- this add an optional flag to the `dev` command from `carton` to enable passing a `destination.json` file to the `swift build` call
- this requires that the toolchain referenced in the `destination.json` file is consistent with the one used by the `carton` process.
- it enables the importing of the `Foundation` module amongst others when running `carton dev`
This commit is contained in:
Alex Tran Qui 2020-07-02 12:38:05 +02:00 committed by GitHub
parent 29217e4958
commit 7fb12fd24d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 43 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -65,6 +65,40 @@ for WebAssembly and served when you start `carton dev` in the directory where `P
[OpenCombine](https://github.com/broadwaylamb/OpenCombine), and supports both macOS and Linux. (Many
thanks to everyone supporting and maintaining those projects!)
### Providing a destination file to `carton dev`
The `carton dev` command can be passed an optional `destination.json` file to the `swift build` command it calls. Currently, this is required to be able to use `Foundation` in your code.
The specification of the `destination.json` can be found [here](https://github.com/apple/swift-package-manager/blob/master/Sources/Workspace/Destination.swift):
Below is a template allowing you to link to the right Foundation:
```json
{
"version": 1,
"sdk": "${PATH_TO_TOOLCHAIN}/usr/share/wasi-sysroot",
"toolchain-bin-dir": "${PATH_TO_TOOLCHAIN}/usr/bin",
"target": "wasm32-unknown-wasi",
"extra-cc-flags": [
""
],
"extra-cpp-flags": [
""
],
"extra-swiftc-flags": [
"-I", "${PATH_TO_TOOLCHAIN}/usr/lib/swift/wasi/wasm32",
"-Xlinker", "-lCoreFoundation",
"-Xlinker", "-lBlocksRuntime",
"-Xlinker", "-licui18n",
"-Xlinker", "-luuid"
]
}
```
When using `swiftenv` on MacOS, `${PATH_TO_TOOLCHAIN}` will usually be of the following format: `/Users/me/.swiftenv/versions/wasm-DEVELOPMENT-SNAPSHOT-2020-06-12-a/`.
Note that this path should really be consistent with the toolchain used by `carton`. So when you do not use a `swiftenv` based toolchain, you need to take care of specifying the correct one.
In the future, we should make sure that this is taken care of by `carton` itself.
## Roadmap
Since a subset of Foundation and XCTest already work and are supplied in the latest snapshots of

11
Sources/carton/Commands/Dev.swift
View File

@ -50,6 +50,9 @@ struct Dev: ParsableCommand {
@Option(help: "Specify name of an executable product in development.")
var product: String?
@Option(help: "Specify name of a json destination file to be passed to `swift build`.")
var destination: String?
static var configuration = CommandConfiguration(
abstract: "Watch the current directory, host the app, rebuild on change."
)
@ -70,8 +73,12 @@ struct Dev: ParsableCommand {
terminal.preWatcherBuildNotice()
let builderArguments =
[swiftPath, "build", "--triple", "wasm32-unknown-wasi", "--product", product]
let builderArguments: [String]
if let destination = destination {
builderArguments = [swiftPath, "build", "--triple", "wasm32-unknown-wasi", "--product", product, "--destination", destination]
} else {
builderArguments = [swiftPath, "build", "--triple", "wasm32-unknown-wasi", "--product", product]
}
try ProcessRunner(builderArguments, terminal).waitUntilFinished()