https://github.com/p-x9/runscriptplugin

🏃SwiftPackage Plugin for executing arbitrary ShellScript.
https://github.com/p-x9/runscriptplugin

shell-script shellscript swift swiftpackage

Last synced: about 2 months ago
JSON representation

🏃SwiftPackage Plugin for executing arbitrary ShellScript.

• Host: GitHub
• URL: https://github.com/p-x9/runscriptplugin
• Owner: p-x9
• License: mit
• Created: 2023-02-04T07:12:09.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-25T05:26:02.000Z (about 2 months ago)
• Last Synced: 2024-10-26T16:22:57.506Z (about 2 months ago)
• Topics: shell-script, shellscript, swift, swiftpackage
• Language: Swift
• Homepage:
• Size: 52.7 KB
• Stars: 32
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RunScriptPlugin

SwiftPackage Plugin for executing arbitrary ShellScript.

## Feature

- BuildToolPlugin: RunScriptPlugin

- CommandPlugin: RunScriptCommandPlugin

- XcodeBuildToolPlugin: RunScriptPlugin

- XcodeCommandPlugin: RunScriptCommandPlugin

## Usage

Place the file named `runscript.yml`(or `.runscript.yml`) in the root of the project.

Write the shell script you want to run in this file.

The format is as follows.

```yaml

prebuild: # prebuild Command

  - name: "Hello"

    script: "echo Hello" # Write scripts directly

  - name: "Show current path"

    script: "pwd"

  - name: "Write file"

    script: "echo Hello >> test.txt"

  - name: "SwiftLint"

    launchPath: "/bin/bash" # bash, zsh, etc. can be specified

    script: "swiftlint lint --fix"

  - name: "SwiftLint" # Another way to write ↑↑

    launchPath: "/usr/local/bin/swiftlint"

    arguments:

      - "lint"

      - "--fix"

  - name: "Update schema"

    file: "update_schema.sh" # Execute .sh file

build: # build Command

  - name: "Hello"

    script: "echo Hello"

  - name: "Make Swift Code"

    script: |

        echo "public enum Hello { case a,b,c,d }" > $RUN_SCRIPT_PLUGIN_WORK_DIR/tmp.swift"

command: # Command Plugin

  - name: "Hello from Command"

    script: "echo 'Hello from Command'"

all: # run in `prebuild`, `build`...

   - name: "Hello(all)"

     script: "echo Hello(all)"

```

> [!NOTE]

> Due to a limitation of Xcode, you may get a permission error when trying to write a file.

>

> If CommandPlugin is run from the shell, it is possible to work around this by disabling the sandbox using the `--disable-sandbox` option.

> ```sh

> swift package plugin --allow-writing-to-package-directory --disable-sandbox run-script

> ```

>

>　If you want to avoid the use of the BuildToolPlugin/CommandPlugin via Xcode, you can disable the use of the sandbox by configuring the following settings.

> ```sh

> defaults write com.apple.dt.Xcode IDEPackageSupportDisablePluginExecutionSandbox -bool YES

> ```

### Environment Valiables

The following environment variables are available in the script to refer to the Plugin context.

- RUN_SCRIPT_TARGET_PACKAGE_DIR  

    Path of the target package on which the plugin runs.

    The path obtained by `PackagePlugin.PluginContext.package.directory`

- RUN_SCRIPT_PLUGIN_WORK_DIR  

    The path of a writable directory into which the plugin or the build commands it constructs can write anything it wants.

    The path obtained by `PackagePlugin.PluginContext.pluginWorkDirectory`

## Example

- SwiftLint

You can run Lint in SPM without using the SwiftLint plugin.

```yaml

- name: "SwiftLint"

  script: "swiftlint lint"

```

- Build Log

```yaml

- name: "Build Log"

  script: "echo \"[$(date)] Build >> build.log\""

```

- Theos(Orion) install

You can install the Tweak from the Build button in SPM.

```yaml

- name: "Theos make package and install"

  script: "make do"

```

- SwiftFormat

```yaml

- name: "SwiftFormat"

  script: "swiftformat ."

```

- SwiftGen

```yaml

- name: "SwiftGen"

  script: "swiftgen config run"

```