Version 0.3.0

Author: vknabel

Archerfile

@@ -4,13 +4,12 @@ apiLevel: 2
 repository: https://github.com/vknabel/Archery
 loaders:
   - cat Metadata/*.yml
+  - cat Examples/BashAlias.yml
+  - cat Examples/TestingOnMultiplePlatforms.yml
   - swift Scripts/MapSwiftTargetsToScripts.swift --package-path .
 scripts:
   greet: echo Hello
-  clean:
-    arrow: vknabel/BashArrow
-    command: rm -rf .archery && swift package clean
-    printCommandBeforeExecution: true
+  clean: rm -rf .archery && swift package clean
   xcopen: swift package generate-xcodeproj --enable-code-coverage && open *.xcodeproj
   format:
     arrow: vknabel/BashArrow
@@ -23,27 +22,7 @@ scripts:
     arrow: vknabel/MintArrow
     help: Lints all project files
     package: Realm/Swiftlint
-  test:
-    help: Runs tests on your current host system, but also on supported linux versions
-    run: [host, swift5.0, swift5.1]
-    scripts:
-      host: swift test
-      swift5.0:
-        env:
-          SWIFT_VERSION: 5.0
-        command: |-
-          export CONTAINER=$(docker create --rm --workdir /archery swift:$SWIFT_VERSION swift test)
-          docker cp . $CONTAINER:/archery
-          docker start --attach $CONTAINER
-      swift5.1:
-        env:
-          SWIFT_VERSION: 5.1
-        command: |-
-          export CONTAINER=$(docker create --rm --workdir /archery swift:$SWIFT_VERSION swift test)
-          docker cp . $CONTAINER:/archery
-          docker start --attach $CONTAINER
   generate:
-    arrow: vknabel/ArcheryArrow
     run:
       - readme
       - version

CHANGELOG.md

@@ -2,14 +2,28 @@
 
 ## 0.3.0
 
-* Mint will not be bundled with Archery anymore. Instead always your global version will be used.
-* Initial implementation for Archerfile loaders.
+-   **[Breaking]** Mint will not be bundled with Archery anymore and needs to be installed manually when using legacy Arrows.
+-   **[Breaking]** Requires Swift 5.
+-   **[Addition]** Generate new metadata by loaders.
+-   **[Addition]** Passes custom environment variables to all scripts and arrows: `ARCHERY`, `ARCHERY_METADATA`, `ARCHERY_SCRIPT`, `ARCHERY_API_LEVEL`, `ARCHERY_LEGACY_MINT_PATH`.
+-   **[Addition]** Scripts can now be run in sequence with just an array literal `do-all: [first, second, third]`
+-   **[Improvement]** `vknabel/ArcheryArrow` implicitly uses the new scripting API and does not require compilation anymore.
+-   **[Improvement]** Scripts can now be run in sequence without using `arrow: vknabel/ArcheryArrow`
+-   **[Improvement]** Bash scripts do not require `arrow: vknabel/BashArrow` anymore.
+-   **[Improvement]** `vknabel/BashArrow` implicitly uses the new scripting API and does not require compilation anymore.
+- **[Deprecation]** The classical `arrow`-script type will be deprecated and will be removed in far future.
+
+### Upcoming Breaking Changes
+
+Previously all scripts were defined as arrow: a separate Swift Package accepting specific arguments, being installed using Mint. This mechanism is now deprecated and will be replaced by plain scripts and environment variables.
+
+Please note the arrow-shorthand syntax `script-name: your/Arrow` deprecated in version 0.2.1 is still available and has not been removed yet.
 
 ## 0.2.1
 
-* Bumped internal dependencies
-* Correctly passes interrupts
-* Shorthand arrow syntax will be migrated to `vknabel/BashArrow` commands
+-   Bumped internal dependencies
+-   Correctly passes interrupts
+-   Shorthand arrow syntax will be migrated to `vknabel/BashArrow` commands
 
 ### Upcoming Breaking Change
 
@@ -20,15 +34,15 @@ All strings containing exactly one `/`, no space and which do not start with a `
 
 ```yaml
 scripts:
-  # Deprecated shorthand
-  example: "vknabel/BeakArrow" # this would run the arrow
-  # New behavior
-  format: "swiftformat ." # this would run a `vknabel/BashArrow` command
+    # Deprecated shorthand
+    example: "vknabel/BeakArrow" # this would run the arrow
+    # New behavior
+    format: "swiftformat ." # this would run a `vknabel/BashArrow` command
 ```
 
 ## 0.2.0
 
-* Archerfile supports YAML
+-   Archerfile supports YAML
 
 ### Archerfile supports YAML
 
@@ -38,9 +52,9 @@ As the Archerfile should not be read directly, this update won’t break arrows.
 
 ## 0.1.1
 
-* Improved error messages
-* Improved README.md
+-   Improved error messages
+-   Improved README.md
 
 ## 0.1.0
 
-* Initial Release
+-   Initial Release

Examples/BashAlias.yml

@@ -0,0 +1,15 @@
+scripts:
+  alias:
+    help: |-
+      Generates bash aliases for all scripts.
+      eval $(archery alias)
+    silent: true
+    command: |-
+      echo '
+      const scripts = JSON.parse(process.env.ARCHERY_METADATA).scripts;
+      Object.keys(scripts)
+        .filter(name => name !== "alias")
+        .forEach(name => {
+          const command = `${process.env.ARCHERY} ${name}`;
+          console.log(`function ${name}() { ${command} "$@"; }`);
+        });' | node

Examples/TestingOnMultiplePlatforms.yml

@@ -0,0 +1,20 @@
+scripts:
+  test:
+    help: Runs tests on your current host system, but also on supported linux versions
+    run: [host, swift5.0, swift5.1]
+    scripts:
+      host: swift test
+      swift5.0:
+        env:
+          SWIFT_VERSION: 5.0
+        command: |-
+          export CONTAINER=$(docker create --rm --workdir /archery swift:$SWIFT_VERSION swift test)
+          docker cp . $CONTAINER:/archery
+          docker start --attach $CONTAINER
+      swift5.1:
+        env:
+          SWIFT_VERSION: 5.1
+        command: |-
+          export CONTAINER=$(docker create --rm --workdir /archery swift:$SWIFT_VERSION swift test)
+          docker cp . $CONTAINER:/archery
+          docker start --attach $CONTAINER

README.md

@@ -1,16 +1,19 @@
 # 🏹 Archery
 
-[![Join the chat at https://gitter.im/vknabel-Archery/Lobby](https://badges.gitter.im/vknabel-Archery/Lobby.svg)](https://gitter.im/vknabel-Archery/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
 *Archery* allows you to declare all your project's metadata and what you can do with it in one single place.
+All fueled with the power of scripting.
 
-Within Archery all your data is centralized as YAML in one file called `Archerfile`, which will be passed to arrows as JSON. The whole content of that file is treated as metadata. Within `scripts` you declare whatever you want to run.
+Within Archery all your data is either declared as YAML in one file called `Archerfile` or generated by scripts, which will be passed to arrows as JSON.
+The whole content of that file is treated as metadata. Within `scripts` you declare whatever you want to run, `loaders` is there to generate additional metadata.
 
 The following code shows how an Archerfile may look like. Besides the name and version of the project, it declares two scripts:
+
 ```yaml
 name: YourProject
 help: Thanks for downloading this project and trying it out.
 version: 1.0.0
+loaders:
+  - cat Metadata/*.yml
 scripts:
   xcproj: swift package generate-xcodeproj
   generate-version:
@@ -21,6 +24,7 @@ scripts:
     searchPaths: [Scripts]
 
 ```
+
 * `$ archery xcproj` will use [Mint](https://github.com/yonaskolb/Mint) to load [vknabel/BashArrow](https://github.com/vknabel/BashArrow), which executes a given command. Whenever you want to run simple scripts on the command line which do not require global installs, this is an universal way to go.
 * `$ archery generate-version` is based on [vknabel/StencilArrow](https://github.com/vknabel/StencilArrow). It will pass all contents of the Archerfile to render the contents of `Version.swift.stencil` using the [Stencil](https://github.com/kylef/Stencil) language. Whenever you need information of your Archerfile inside other files, this way should be the most convenient.
 
@@ -39,6 +43,7 @@ Available Commands:
 No matter which arrow you will choose for your scripts: it comes with all dependencies it needs. No need for any additional commands.
 
 ## Scripts
+
 The script tag at root level drives the available subcommands and is interpreted as Array of scripts.
 
 | Option        | Default   | Description               |
@@ -67,16 +72,19 @@ Now you can add all your metadata and scripts. Don't know where to start? Here a
 
 
 ### Using Mint
+
 ```bash
 $ mint run vknabel/Archery
 ```
 
 ### Using Marathon
+
 ```bash
 $ marathon run vknabel/archery
 ```
 
 ### Swift Package Manager
+
 ```bash
 $ git clone https://github.com/vknabel/Archery.git
 $ cd Archery
@@ -86,7 +94,21 @@ $ cp -f .build/release/archery /usr/local/bin/archery
 
 Archery can also be embedded within your own CLI using SwiftPM.
 
-## Available Arrows
+## Environment Variables
+
+Archery passes the following environment variables to each script including loaders.
+
+| Name                       | Description                         | Example use case                              |
+| -------------------------- | ----------------------------------- | --------------------------------------------- |
+| `ARCHERY`                  | Path to the archery executable.     | To run child processes `$ARCHERY script-name` |
+| `ARCHERY_METADATA`         | JSON contents of all metadata.      | Parse metadata in your scripts.               |
+| `ARCHERY_SCRIPT`           | JSON contents of the script config. | Parse config in your scripts.                 |
+| `ARCHERY_API_LEVEL`        | Number of the API level.            | To improve backwards compatibility.           |
+| `ARCHERY_LEGACY_MINT_PATH` | Path to the mint driver.            | In case your script relies on mint.           |
+
+
+## Available Legacy Arrows
+
 Currently the following arrows are known. Feel free to add your own arrows. If you want to write your own arrow head over to [vknabel/ArrowKit](https://github.com/vknabel/ArrowKit/blob/master/README.md) and feel free to add to add your own arrow here.
 
 ### Archery
@@ -135,9 +157,6 @@ Currently the following arrows are known. Feel free to add your own arrows. If y
 ## Development Status
 As Archery is still in early development I want every user to know as early as possible what may actually change or break in future. This project uses semantic versioning. Version 1.0.0 will be released when known bugs are fixed, all major features have been implemented and upcoming one can be implemented without breaking changes. Additional requirements are a good documentation and good error messages. Until 1.0 has been reached minor updates may break, but patches will stay patches and hence safe for updates.
 
-### Archerfile Loaders
-In bigger projects the `Archerfile` may get huge when used regularly. Later it shall be possible to extract some JSON values into external files and even other scripts. As the `Archerfile` should not be read directly, this update won’t break arrows.
-
 ## Contributors
 * Valentin Knabel, [@vknabel](https://github.com/vknabel), [email protected], [@vknabel](https://twitter.com/vknabel) on Twitter
 

Scripts/MapSwiftTargetsToScripts.swift

@@ -48,5 +48,9 @@ let package = try decoder.decode(PackageDump.self, from: output.fileHandleForRea
 
 print("scripts:")
 for product in package.products where product.isExecutable {
-    print("  \(product.name): 'swift run --package-path \(packagePath) \(product.name) $@'")
+    print("""
+      \(product.name):
+        command: 'swift run --package-path \(packagePath) \(product.name) $@'
+        help: 'Runs \(product.name) using the swift package manager'
+    """)
 }

Scripts/README.md.stencil

@@ -1,16 +1,19 @@
 # 🏹 Archery
 
-[![Join the chat at https://gitter.im/vknabel-Archery/Lobby](https://badges.gitter.im/vknabel-Archery/Lobby.svg)](https://gitter.im/vknabel-Archery/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
 *Archery* allows you to declare all your project's metadata and what you can do with it in one single place.
+All fueled with the power of scripting.
 
-Within Archery all your data is centralized as YAML in one file called `Archerfile`, which will be passed to arrows as JSON. The whole content of that file is treated as metadata. Within `scripts` you declare whatever you want to run.
+Within Archery all your data is either declared as YAML in one file called `Archerfile` or generated by scripts, which will be passed to arrows as JSON.
+The whole content of that file is treated as metadata. Within `scripts` you declare whatever you want to run, `loaders` is there to generate additional metadata.
 
 The following code shows how an Archerfile may look like. Besides the name and version of the project, it declares two scripts:
+
 ```yaml
 name: YourProject
 help: Thanks for downloading this project and trying it out.
 version: 1.0.0
+loaders:
+  - cat Metadata/*.yml
 scripts:
   xcproj: swift package generate-xcodeproj
   generate-version:
@@ -21,6 +24,7 @@ scripts:
     searchPaths: [Scripts]
 
 ```
+
 * `$ archery xcproj` will use [Mint](https://github.com/yonaskolb/Mint) to load [vknabel/BashArrow](https://github.com/vknabel/BashArrow), which executes a given command. Whenever you want to run simple scripts on the command line which do not require global installs, this is an universal way to go.
 * `$ archery generate-version` is based on [vknabel/StencilArrow](https://github.com/vknabel/StencilArrow). It will pass all contents of the Archerfile to render the contents of `Version.swift.stencil` using the [Stencil](https://github.com/kylef/Stencil) language. Whenever you need information of your Archerfile inside other files, this way should be the most convenient.
 
@@ -39,6 +43,7 @@ Available Commands:
 No matter which arrow you will choose for your scripts: it comes with all dependencies it needs. No need for any additional commands.
 
 ## Scripts
+
 The script tag at root level drives the available subcommands and is interpreted as Array of scripts.
 
 | Option        | Default   | Description               |
@@ -73,16 +78,19 @@ $ brew install archery
 #}
 
 ### Using Mint
+
 ```bash
 $ mint run vknabel/Archery
 ```
 
 ### Using Marathon
+
 ```bash
 $ marathon run vknabel/archery
 ```
 
 ### Swift Package Manager
+
 ```bash
 $ git clone {{repository}}.git
 $ cd Archery
@@ -92,7 +100,21 @@ $ cp -f .build/release/archery /usr/local/bin/archery
 
 Archery can also be embedded within your own CLI using SwiftPM.
 
-## Available Arrows
+## Environment Variables
+
+Archery passes the following environment variables to each script including loaders.
+
+| Name                       | Description                         | Example use case                              |
+| -------------------------- | ----------------------------------- | --------------------------------------------- |
+| `ARCHERY`                  | Path to the archery executable.     | To run child processes `$ARCHERY script-name` |
+| `ARCHERY_METADATA`         | JSON contents of all metadata.      | Parse metadata in your scripts.               |
+| `ARCHERY_SCRIPT`           | JSON contents of the script config. | Parse config in your scripts.                 |
+| `ARCHERY_API_LEVEL`        | Number of the API level.            | To improve backwards compatibility.           |
+| `ARCHERY_LEGACY_MINT_PATH` | Path to the mint driver.            | In case your script relies on mint.           |
+
+
+## Available Legacy Arrows
+
 Currently the following arrows are known. Feel free to add your own arrows. If you want to write your own arrow head over to [vknabel/ArrowKit](https://github.com/vknabel/ArrowKit/blob/master/README.md) and feel free to add to add your own arrow here.
 
 {% for arrow in publicArrows %}### {{arrow.name}}
@@ -106,9 +128,6 @@ Currently the following arrows are known. Feel free to add your own arrows. If y
 ## Development Status
 As Archery is still in early development I want every user to know as early as possible what may actually change or break in future. This project uses semantic versioning. Version 1.0.0 will be released when known bugs are fixed, all major features have been implemented and upcoming one can be implemented without breaking changes. Additional requirements are a good documentation and good error messages. Until 1.0 has been reached minor updates may break, but patches will stay patches and hence safe for updates.
 
-### Archerfile Loaders
-In bigger projects the `Archerfile` may get huge when used regularly. Later it shall be possible to extract some JSON values into external files and even other scripts. As the `Archerfile` should not be read directly, this update won’t break arrows.
-
 ## Contributors
 {% for user in contributors %}* {{user.name}}, [@{{user.github}}](https://github.com/{{user.github}}){% if user.email %}, {{user.email}}{% endif %}{% if user.twitter %}, [@{{user.twitter}}](https://twitter.com/{{user.twitter}}) on Twitter{% endif %}
 {% endfor %}

Sources/ArcheryKit/ExecutionContext.swift

@@ -35,7 +35,7 @@ struct ExecutionContext {
     func run(_ script: LabeledScript, using archerfile: Archerfile, with arguments: [String]) throws {
         let processes = try makeProcesses(script, using: archerfile, with: arguments, parentScripts: [:])
         for (label, process) in processes {
-            if !silent {
+            if !silent && !arguments.contains("--silent") && !(script.script.silent ?? false) {
                 print("🏹  Running \(label.joined(separator: " ▶︎ "))")
             }
 

Sources/ArcheryKit/Script.swift

@@ -3,6 +3,7 @@ public struct Script: Codable, OfferingMetadata {
     public var help: String?
     public var env: [String: String]?
     public var workingDirectory: String?
+    public var silent: Bool?
 
     public var metadata: Metadata
 
@@ -12,6 +13,7 @@ public struct Script: Codable, OfferingMetadata {
         let details = try? ExecutionDetailsSyntax(from: decoder)
         help = details?.help
         env = details?.env
+        silent = details?.silent
 
         metadata = try Metadata(from: decoder)
             .replacing(using: execution.metadata)
@@ -24,5 +26,6 @@ public struct Script: Codable, OfferingMetadata {
     private struct ExecutionDetailsSyntax: Codable {
         var help: String?
         var env: [String: String]?
+        var silent: Bool?
     }
 }