[pull] master from raycast:master

.github/workflows/script-commands.yml

@@ -2,18 +2,26 @@ name: Set as Executable and Generate Documentation
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
+    paths-ignore:
+      - commands/README.md
+      - commands/extensions.json
 
 jobs:
   scriptCommands:
-    runs-on: macos-latest
+    runs-on: macos-15
 
     steps:
-      - uses: actions/checkout@v2
-
-      - uses: maxim-lobanov/setup-xcode@v1
+      - uses: actions/checkout@v4
         with:
-          xcode-version: latest-stable
+          fetch-depth: 0
+          token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+
+      - name: Setup Xcode
+        uses: raycast/github-actions/[email protected]
+
+      - name: Setup GIT
+        uses: raycast/github-actions/[email protected]
 
       - name: Build Toolkit
         run: |
@@ -27,20 +35,27 @@ jobs:
         run: |
           make gen-docs-and-commit
 
-      - name: Push changes
+      - name: Rebase
+        if: success()
+        run: git pull origin ${{ github.ref }} --autostash --rebase -X ours
+
+      - name: Push
         if: success()
         uses: ad-m/github-push-action@master
         with:
-          github_token: ${{ secrets.RAYCAST_BOT_ACCESS_TOKEN }}
           branch: ${{ github.ref }}
+          github_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
 
-      - name: Re-pull on failure
+      - name: Notify Failure
         if: failure()
-        run: git pull origin ${{ github.ref }} --autostash --rebase -X ours
-
-      - name: Re-push on failure
-        if: failure()
-        uses: ad-m/github-push-action@master
+        uses: edge/simple-slack-notify@master
         with:
-          branch: ${{ github.ref }}
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          color: "danger"
+          text: ":no_entry_sign: ${env.GITHUB_WORKFLOW} has failed"
+          fields: |
+            [
+              { "title": "Action logs:", "value": "${env.GITHUB_SERVER_URL}/${env.GITHUB_REPOSITORY}/actions/runs/${env.GITHUB_RUN_ID}"},
+              { "title": "Commit:", "value": "${env.GITHUB_SERVER_URL}/${env.GITHUB_REPOSITORY}/commit/${ env.GITHUB_SHA }"}
+            ]
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_STREAM_INFRA_CHANNEL_WEBHOOK_URL }}

.gitignore

@@ -4,3 +4,4 @@
 *.xcodeproj
 xcuserdata/
 .swiftpm
+.idea

CONTRIBUTING.md

@@ -6,10 +6,12 @@ Thank you for your interest in contributing to Raycast Script Commands! Here you
   - [Guidelines](#guidelines)
     - [Git and Pull Requests](#git-and-pull-requests)
     - [Folder structure](#folder-structure)
+    - [English style convention](#english-style-convention)
     - [File naming convention](#file-naming-convention)
     - [Metadata convention](#metadata-convention)
     - [Scripts that require additional modification](#scripts-that-require-additional-modification)
     - [Scripts that require installation of runtimes and dependencies](#scripts-that-require-installation-of-runtimes-and-dependencies)
+    - [Scripts that require installation of apps](#scripts-that-require-installation-of-apps)
     - [Bash profiles and environmental variables](#bash-profiles-and-environmental-variables)
     - [Auto generated files](#auto-generated-files)
   - [Examples](#examples)
@@ -48,9 +50,14 @@ Images should go into dedicated `images` folder:
       └─ spotify-prev-track.applescript
 ```
 
+### English style convention
+
+Use American English spelling and style for your command metadata. 
+To make sure you use the right version, refer to [Wikipedia](https://en.wikipedia.org/wiki/Comparison_of_American_and_British_English) or use [British to American English Converter](https://www.infoenglish.net/british-to-american-english/)
+
 ### File naming convention
 
-Use dash-case format for script files and directories, and use proper file extensions: Applescript should be `.applescript`, Swift should be `.swift`, Bash should be `.sh`, etc.
+Use lowercased, dash-case format for script files and directories, and use proper file extensions: Applescript should be `.applescript`, Swift should be `.swift`, Bash should be `.sh`, etc.
 Example: `spotify-next-track.applescript`
 
 ### Metadata convention
@@ -99,6 +106,19 @@ If you still need a dependency, follow these guidelines:
 	     exit 1;
    fi
    ```
+
+### Scripts that require installation of apps
+
+Some Scripts control apps and therefore require them to be installed. Make sure to hint the requirement and add guidance on how to install it at the top of the script:
+
+```
+#!/bin/bash
+
+# Note: Plash v2.2.0 required
+# Install via Mac App Store: https://apps.apple.com/app/id1494023538
+
+# @raycast.schemaVersion 1
+```
 
 ### Bash profiles and environmental variables
 

Makefile

@@ -36,4 +36,7 @@ lint:
 	swiftlint lint
 
 fix:
-	swiftlint autocorrect --format
+	swiftlint --fix
+
+open:
+	open -a /Applications/Xcode.app $(TOOLKIT_PATH)

Tools/Toolkit/Package.swift

@@ -10,11 +10,11 @@ let package = Package(
   dependencies: [
     .package(
       url: "https://github.com/apple/swift-tools-support-core.git",
-      .upToNextMinor(from: "0.1.11")
+      .upToNextMinor(from: "0.2.4")
     ),
     .package(
       url: "https://github.com/apple/swift-argument-parser.git",
-      .upToNextMinor(from: "0.3.0")
+      .upToNextMinor(from: "1.0.0")
     ),
   ],
   targets: [

Tools/Toolkit/Sources/Toolkit/SubCommands/GenerateDocumentation.swift

@@ -5,7 +5,6 @@
 
 import ArgumentParser
 import ToolkitLibrary
-import TSCBasic
 
 extension ToolkitCommand {
   struct GenerateDocumentation: ParsableCommand {
@@ -23,11 +22,14 @@ extension ToolkitCommand {
     var outputJSONFilename: String = "extensions.json"
 
     func run() throws {
-      let fileSystem = TSCBasic.localFileSystem
-
       do {
+        let dataManager = try DataManager(
+          extensionsPath: path,
+          extensionsFilename: outputJSONFilename
+        )
+
         let toolkit = Toolkit(
-          path: fileSystem.absolutePath(for: path)
+          dataManager: dataManager
         )
 
         try toolkit.generateDocumentation(

Tools/Toolkit/Sources/Toolkit/SubCommands/Report.swift

@@ -6,7 +6,6 @@
 import ArgumentParser
 import SwiftUI
 import ToolkitLibrary
-import TSCBasic
 
 extension ToolkitCommand {
   struct Report: ParsableCommand {
@@ -32,11 +31,13 @@ extension ToolkitCommand {
     var noColor: Bool = false
 
     func run() throws {
-      let fileSystem = TSCBasic.localFileSystem
-
       do {
+        let dataManager = try DataManager(
+          extensionsPath: path
+        )
+
         let toolkit = Toolkit(
-          path: fileSystem.absolutePath(for: path)
+          dataManager: dataManager
         )
 
         try toolkit.report(

Tools/Toolkit/Sources/Toolkit/SubCommands/SetExecutable.swift

@@ -5,7 +5,6 @@
 
 import ArgumentParser
 import ToolkitLibrary
-import TSCBasic
 
 extension ToolkitCommand {
   struct SetExecutable: ParsableCommand {
@@ -17,11 +16,13 @@ extension ToolkitCommand {
     var path: String = "./commands"
 
     func run() throws {
-      let fileSystem = TSCBasic.localFileSystem
-
       do {
+        let dataManager = try DataManager(
+          extensionsPath: path
+        )
+
         let toolkit = Toolkit(
-          path: fileSystem.absolutePath(for: path)
+          dataManager: dataManager
         )
 
         try toolkit.setScriptCommandsAsExecutable()

Tools/Toolkit/Sources/ToolkitLibrary/Core/Documentation/Documentation.swift

@@ -71,7 +71,7 @@ private extension Documentation {
     sortedGroups.forEach { group in
       contentString += .newLine + group.sectionTitle
 
-      contentString += renderMarkdown(for: group, leadingPath: "\(group.path)/")
+      contentString += renderMarkdown(for: group)
     }
 
     let markdown = """
@@ -106,7 +106,7 @@ private extension Documentation {
     return contentData
   }
 
-  func renderMarkdown(for group: Group, headline: Bool = false, leadingPath: String = .empty) -> String {
+  func renderMarkdown(for group: Group, headline: Bool = false) -> String {
     var contentString = String.empty
 
     if group.scriptCommands.isEmpty == false {
@@ -117,31 +117,33 @@ private extension Documentation {
 
       contentString += .newLine
       contentString += .newLine + "| Icon | Title | Description | Author | Args | Templ | Lang |"
-      contentString += .newLine + "| ---- | ----- | ----------- | ------ | ---- | ----- | ---- |"
+      contentString += .newLine + "| :--: | ----- | ----------- | :----: | :--: | :---: | :--: |"
 
-      for var scriptCommand in group.scriptCommands.sorted() {
-        scriptCommand.configure(leadingPath: leadingPath)
+      for scriptCommand in group.scriptCommands.sorted() {
         contentString += scriptCommand.markdownDescription
       }
     }
 
     if let subGroups = group.subGroups?.sorted() {
       for subGroup in subGroups {
-        contentString += renderMarkdown(for: subGroup, headline: true, leadingPath: "\(leadingPath)\(subGroup.path)/")
+        contentString += renderMarkdown(
+          for: subGroup,
+          headline: true
+        )
       }
     }
 
     return contentString
   }
-    
+
   func renderBadges() -> String {
     let logo = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFgAAABYCAIAAAD+96djAAAIC0lEQVR4nOybW2zb1hmADynqLsuWRFLOBVmTpqkVy5LlpkgfDGRdnSvcdSiKIUWHosO8lwDtw4Bge1pRYMAw9KXAgAxYMiTNGjRZt+5plxQIkCzpNjduZMmJnMRpt7WR7NgSJYqULFISNUQ8pikpKVLpkOwDP+QhUajj40//f3j+n0fEY1sfByYA4EZP4JuCKQJiioCYIiCmCIgpAmKKgJgiIKYIiCkCYoqAmCIgpgiIKQJiioCYIiDGi9jidIQ8bqNnYbSIkNv9h7HY+7HRXf39xs7ESBFbnc5To5Gg3d5vtf4uMhLu8xg4GSNF7BroJ202+e9eK3EmNvr0gGFxYRnw+Y362SmeL1Rrzwb8AMMAAHYc30+Sl3JMtlrVfzJGigAAJDguXRH2kQHowmJ5Phi8kmeWRVHnmegt4gmXa7vLlRYE5ZUUz+ertT0BPwZd4JNBejpfWFJdowO6itjssJ8bix3euGGGZdOV9d8zwXFtOXKQoi4yuayoX47oJ2Kzw/HuaHSz00ng+H6K+pjJ31PFf4Lj+Hp93O9T4mKCJC8zTE6v9UI/Ec8M9B/euNGy9plPBulrrXERLxbvVip7SVJ24SGIFwaDuuWIfiI+K68u8KVDNIUpLmi6LUfm+VJnjuizduq6RnxWLmcqwgQZkF0QOH6Aoq51rBeda+elnObrhbYiQm73bt/AQqmsvJLi+YVSaS9Fyjlia8bFbLH4ZaWiXJPgOLWvtdgpZrTMEQ1FbHU634tFX9wwmCxy/11dBQAMEMSugX6x0ahJjRFvn3wZgeOHaGpREAI22xanU/7D1+sei2W7GxZjDovlgMY5gml0LCDkcZ+KRmi7HQAgStKRuRsXcrlxv+/3o9GuxyzWalPJuasFFulMIVrVGttcrsBaHWHD8Z9sewzreUwvQZwYCYfcmtTsWon4y/LKVGJOlCQAwE2OfyWeaKAY1mu1nh2LaVGnalh9XmSYI3M3Uhz3cny2UKuhGlauU2NeL6oBZVCK2Oyw7yNJ9SsXcrnJq58itCDjJYhT0cgQ0r4WMhHyDvrX4Z37qRYXSDJCZjpfkBpwPK+VOBmN7HC7UA2ORsQTLtefnoptc7lsOH4sPPzShkEkw7ZxbnHx6PxNxcWg3f7BU2OocgSNCJ/V6iUIOCKG/WroyYOtcYGKD5fuvXX7DlDiopkjSNZONCI+YdnXEklubS3AMeyd4Z0auTidTr95+446R87ERnvvgyNbI6YL7A/iCcWFDcdf3rQR1eBtnE6nfzp/S1LFRe998O5FbHU6v9+6FiQ57sfJuUq93suEHpE/Li39YmE9R3rvg3cpIuRxnx0b/eXQk69u2qR+fbpwP0d41PdLGWUZkjl59wE50nUfvJuia4vDcSY2GrTbMQx7NuBPV4QUzyv/m64I11h2kqYzgvDnpXstb3Q6Xxzs/obyzMBAosh90VqnouqDdxMRbovFga+9EcPeDj0gLqY0yBGHxXI8Et7d+pmfTqePzt9ScsSK457WwHlEuomIbLU6w7IHaMou68CwPQF/oVpLcJxyzZeVyr8LbLnVRY8R8bBejtIHFyTp9RupK/l8FyN32Y/ICMIVhpmkabsFb6q4nyN8vR4vFpVryh0R0bsIpZfT2QdnxOq76fQ/mG4s9NSYWRbFT1l2P0XaLRbQlDHu992tVOb50sPegkSEHBedffAkx6nbXF+XnvYRV1n2cHy2qNpHvR0aalsvEPL35RW5rgcA9BHEe7HobnTPSnvdUM3zpVfis8Xquou3dmzXyMVH2ewb11PK/bKvub9G5QLBzvI6x7+WSCpxATDszR3bX0KRAp2cz2bVe0r5lolkZGQ9yyGP+2Q0MthsUgIApEbj57cWzmQy6msom23c7+v6R8wUWHkVOEiR7wzvXK3Xp5JzM2yx57kDxM3bHW7XB2NjXiu8jV9mmFdnk6gGb+MQRS2LAioLiDtUt0vllhxBhBXDjkfCzwUC6hf/urKC0AL6nmW8WFSvnb1jxbDfjAxPkOSxkeHvBDR8FoW+eXud4w9fi7OInmIfCw8/1+yD2nD8t5GR7wVpJMN2okkXe75UmkrOIcmRs5lFZe9QlSROsxpfqyddAADaZjvyrS191vUS6JM8e25xUX2NlyB+9vg2eZ8uc345+1E2q77m237/iehIVZJ+lJz7Z76g0Ww1FAEAeLq//0Qk7LVa5X9KjcbR+Zsfttbm4z7f8UjYIe/Tm88H37iROr/S4uK7QbpUq1/I5bSbqrZPwzOCcIlhng8G5W0PhmF7SbKtTv2iUrlfy1KUrXmNBcMO0VRGaOlx3CqV/tN8jKwdmp+PyIrVzjo13+pC6eUQa74myMBCqXSnXNZ0bmr0OCiyLIrThcLB1v5FpqOvNXO/lqXWY4ciPy+X1WcrNEWnEzNLgnAxl5sgSbl9JH/mXK02W2yJi4+Z/GSQll3wtdr7mYymh0PU6Hd0KCtWLzPMC8GgkiN7/O05ck8U5RypNRo/TCTR7h2/Gl3PUOWq1c4cKXSsFzMs+7eVlX9pcyDkYeh98nbpQT2+zj74/1a77zV1hwFnsZdF8VIuNxmkHWs9vn1koC1H9MeYQ+kP7IMzYjVpnAvDvq8xw7bUqaIkfb6q366hEyO/pqD0wSUAXr+e6roTjwRta41HIeRxewhCo0ODj043T8fQ8hXPQfTE+K87fkMwRUBMERBTBMQUATFFQEwREFMExBQBMUVATBEQUwTEFAExRUBMERBTBOT/AQAA//98wKt7wQJ9rAAAAABJRU5ErkJggg=="
-    
+
     let style      = "for-the-badge"
     let labelColor = "202123"
     let dataURL    = "https:%2F%2Fraw.githubusercontent.com%2Fraycast%2Fscript-commands%2Fmaster%2Fcommands%2Fextensions.json"
     let jsonPath   = "$.totalScriptCommands"
-    
+
     let badges = """
     <div align="center">
       <a href="https://github.com/raycast/script-commands">
@@ -158,7 +160,7 @@ private extension Documentation {
       </a>
     </div>
     """
-    
+
     return badges
   }
 }

Tools/Toolkit/Sources/ToolkitLibrary/Core/GitShell.swift

@@ -0,0 +1,60 @@
+//
+//  MIT License
+//  Copyright (c) 2020-2021 Raycast. All rights reserved.
+//
+
+import TSCBasic
+import TSCUtility
+
+struct GitError: Error {
+  let result: ProcessResult
+}
+
+struct GitShell {
+  init() {}
+
+  func run(_ args: String..., environment: [String: String] = Git.environment, path: AbsolutePath) throws -> String {
+    do {
+      return try execute(
+        ["-C", path.dirname] + args,
+        environment: environment
+      )
+    } catch {
+      throw error
+    }
+  }
+
+  private func execute(_ args: [String], environment: [String: String] = Git.environment) throws -> String {
+    let process = Process(arguments: [Git.tool] + args, environment: environment)
+    let result: ProcessResult
+
+    do {
+      try process.launch()
+      result = try process.waitUntilExit()
+
+      guard result.exitStatus == .terminated(code: 0) else {
+        throw GitError(
+          result: result
+        )
+      }
+
+      let content = try result.utf8Output().spm_chomp()
+
+      return content
+    } catch let error as GitError {
+      throw error
+    } catch {
+      let result = ProcessResult(
+        arguments: process.arguments,
+        environment: process.environment,
+        exitStatus: .terminated(code: -1),
+        output: .failure(error),
+        stderrOutput: .failure(error)
+      )
+
+      throw GitError(
+        result: result
+      )
+    }
+  }
+}