Allow running stylua as an optional step (#58)

* feat(run): `args: false` will install+cache but not run

* Extend smoketest to show stylua can be run

* Tweak readme slightly

* Commit compiled output

---------

Co-authored-by: JohnnyMorganz <johnnymorganz@outlook.com>

Author: ColinKennedy

.github/workflows/test.yml

@@ -35,7 +35,7 @@ jobs:
         with:
           version: ^0.17
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: --check ./test
+          args: --check ./test/sample.lua
   smoketest_latest_version_provided:
     runs-on: ubuntu-latest
     steps:
@@ -44,4 +44,27 @@ jobs:
         with:
           version: latest
           token: ${{ secrets.GITHUB_TOKEN }}
-          args: --check ./test
+          args: --check ./test/sample.lua
+  # only install / cache the StyLua install, don't run it
+  smoketest_args_false:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Copy Test File
+        run: |
+          cp ./test/needs_spaces.lua{,.copy}
+
+      - uses: ./
+        with:
+          version: latest
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: false
+
+      - name: Confirm test file was not changed
+        run: |
+          cmp ./test/needs_spaces.lua{,.copy}
+
+      - name: Can run stylua independently
+        run: |
+          stylua --version

README.md

@@ -18,6 +18,22 @@ Installs the StyLua binary (from GitHub releases), and caches it. Any StyLua com
     args: --check .
 ```
 
+If you would just like to install `stylua`, but not run it (e.g., since it is used as part of a wider CI script), then
+you can set `args: false`:
+
+```yaml
+- uses: actions/checkout@v4
+- uses: JohnnyMorganz/stylua-action@v4
+  with:
+    token: ${{ secrets.GITHUB_TOKEN }}
+    version: latest # NOTE: we recommend pinning to a specific version in case of formatting changes
+    # This disables running `stylua`
+    args: false
+  # Run stylua independently
+- run: |
+    stylua --version
+```
+
 ### Parameters
 
 #### `token` (Required)
@@ -26,7 +42,7 @@ GitHub token. Required since the binary is downloaded from GitHub releases (to s
 
 #### `args` (Required)
 
-The arguments to pass to the StyLua binary
+The arguments to pass to the StyLua binary. If you don't want to run the binary, set `args: false`.
 
 #### `version` (Required)
 

dist/index.js

@@ -56,7 +56,10 @@ async function run(): Promise<void> {
     const args = core.getInput('args')
     core.debug(`Running stylua with arguments: ${args}`)
 
-    await exec(`stylua ${args}`)
+    if (args !== 'false') {
+      await exec(`stylua ${args}`)
+    }
+
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
   } catch (error: any) {
     core.setFailed(error.message)

dist/index.js.map

@@ -0,0 +1 @@
+local x=1